//-----------------------------------------------------------------------
// <copyright file="IPassThruDevice.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 SharedObjects.Api
{
    /// <summary>
    /// Handle one J2534 device.
    /// It is possible to handle more than one device if needed.
    /// </summary>
    public interface IPassThruDevice
    {
        /// <summary>
        /// Gets current Device ID.
        /// </summary>
        int DeviceID { get; }

        /// <summary>
        /// Gets Last known error encountered.
        /// </summary>
        string lastError { get; }

        /// <summary>
        /// Gets the name of the interface.
        /// </summary>
        string name { get; }

        /// <summary>
        /// Gets Current interface implementation used.
        /// </summary>
        IPassThru passThruInterface { get; }

        /// <summary>
        /// Check if the interface is declared to have a disconnect bug.
        /// </summary>
        /// <returns>'true' if a known disconnect bug exists.</returns>
        bool disconnectBug();

        /// <summary>
        /// Close the device.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruClose();

        /// <summary>
        /// Execute PassThruOpen on the device.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruOpen();

        /// <summary>
        /// Establish a connection on the device.
        /// </summary>
        /// <param name="ProtocolID">Protocol to use.</param>
        /// <param name="Flags">Connection flags.</param>
        /// <param name="Baudrate">Baudrate to connect with.</param>
        /// <param name="channelID">Channel ID assigned (out value)</param>
        /// <returns>Result status, 0=success.</returns>
        unsafe PassThruConstants.resultCode Gl_PassThruConnect(int ProtocolID, uint Flags, uint Baudrate, out int channelID);

        /// <summary>
        /// Read version of API.
        /// </summary>
        /// <param name="ApiVersion">API Version (out value)</param>
        /// <param name="DllVersion">DLL Version (out value)</param>
        /// <param name="FirmwareVersion">Firmware Version (out value)</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruReadVersion(out string ApiVersion, out string DllVersion, out string FirmwareVersion);

        /// <summary>
        /// Set programming voltage on the interface.
        /// </summary>
        /// <param name="Pin">Pin to configure.</param>
        /// <param name="Voltage">Voltage to set.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruSetProgrammingVoltage(int Pin, int Voltage);
    }
}