//-----------------------------------------------------------------------
// <copyright file="SerialAtAgvPassThru.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace DeviceApi.Serial
{
    using System.IO.Ports;
    using global::SharedObjects.Api;
    using global::SharedObjects.Protocol;

    /// <summary>
    /// Class for when using Serial interface with AT commands.
    /// <para>
    /// Notice that much of this class will not be called and that the communication
    /// with the device is done with the protocol handler.
    /// </para>
    /// </summary>
    public class SerialAtAgvPassThru : SerialAtPassThru, IPassThru
    {
        /// <summary>
        /// Name of the interface.
        /// </summary>
        public const string INTERFACE_NAME = "Serial Port device AGV4000 and Compatible.";

        /// <summary>
        /// Code name of the interface.
        /// </summary>
        public const string INTERFACE_CODE = "AGV";

        /// <summary>
        /// Initializes a new instance of the <see cref="SerialAtAgvPassThru" /> class.
        /// </summary>
        public SerialAtAgvPassThru()
        {
            this.serialPortParameters = new SerialPortParameters(9600, 8, Parity.None, StopBits.One);
            this.protocols = new Protocols[]
            {
                Protocols.getProtocolById(Protocols.SERIAL_AT_AGV),
            };
        }

        /// <summary>
        /// Gets the name of the interface.
        /// </summary>
        public override string name
        {
            get
            {
                return INTERFACE_NAME;
            }
        }

        /// <summary>
        /// Gets the name of the interface.
        /// </summary>
        public override string code
        {
            get
            {
                return INTERFACE_CODE;
            }
        }
    }
}