// PCANBasicCLR.h // // ~~~~~~~~~~~~ // // PCAN-Basic API // // ~~~~~~~~~~~~ // // ------------------------------------------------------------------ // Author : Keneth Wagner // Last change: 13.03.2013 Wagner // // Language: C++/CLR // ------------------------------------------------------------------ // // Copyright (C) 1999-2013 PEAK-System Technik GmbH, Darmstadt // more Info at http://www.peak-system.com // using namespace System; using namespace System::Text; using namespace System::Runtime::InteropServices; //////////////////////////////////////////////////////////// // Type definitions //////////////////////////////////////////////////////////// #define TPCANHandle System::Byte // Represents a PCAN hardware channel handle namespace Peak { namespace Can { namespace Basic { #pragma region Enumerations /// /// Represents a PCAN status/error code /// [Flags] public enum class TPCANStatus : UInt32 { /// /// No error /// PCAN_ERROR_OK = 0x00000, /// /// Transmit buffer in CAN controller is full /// PCAN_ERROR_XMTFULL = 0x00001, /// /// CAN controller was read too late /// PCAN_ERROR_OVERRUN = 0x00002, /// /// Bus error: an error counter reached the 'light' limit /// PCAN_ERROR_BUSLIGHT = 0x00004, /// /// Bus error: an error counter reached the 'heavy' limit /// PCAN_ERROR_BUSHEAVY = 0x00008, /// /// Bus error: the CAN controller is in bus-off state /// PCAN_ERROR_BUSOFF = 0x00010, /// /// Mask for all bus errors /// PCAN_ERROR_ANYBUSERR = (PCAN_ERROR_BUSLIGHT | PCAN_ERROR_BUSHEAVY | PCAN_ERROR_BUSOFF), /// /// Receive queue is empty /// PCAN_ERROR_QRCVEMPTY = 0x00020, /// /// Receive queue was read too late /// PCAN_ERROR_QOVERRUN = 0x00040, /// /// Transmit queue is full /// PCAN_ERROR_QXMTFULL = 0x00080, /// /// Test of the CAN controller hardware registers failed (no hardware found) /// PCAN_ERROR_REGTEST = 0x00100, /// /// Driver not loaded /// PCAN_ERROR_NODRIVER = 0x00200, /// /// Hardware already in use by a Net /// PCAN_ERROR_HWINUSE = 0x00400, /// /// A Client is already connected to the Net /// PCAN_ERROR_NETINUSE = 0x00800, /// /// Hardware handle is invalid /// PCAN_ERROR_ILLHW = 0x01400, /// /// Net handle is invalid /// PCAN_ERROR_ILLNET = 0x01800, /// /// Client handle is invalid /// PCAN_ERROR_ILLCLIENT = 0x01C00, /// /// Mask for all handle errors /// PCAN_ERROR_ILLHANDLE = (PCAN_ERROR_ILLHW | PCAN_ERROR_ILLNET | PCAN_ERROR_ILLCLIENT), /// /// Resource (FIFO, Client, timeout) cannot be created /// PCAN_ERROR_RESOURCE = 0x02000, /// /// Invalid parameter /// PCAN_ERROR_ILLPARAMTYPE = 0x04000, /// /// Invalid parameter value /// PCAN_ERROR_ILLPARAMVAL = 0x08000, /// /// Unknow error /// PCAN_ERROR_UNKNOWN = 0x10000, /// /// Invalid data, function, or action. /// PCAN_ERROR_ILLDATA = 0x20000, /// /// Channel is not initialized /// PCAN_ERROR_INITIALIZE = 0x40000, /// /// Invalid operation /// PCAN_ERROR_ILLOPERATION = 0x80000, }; /// /// Represents a PCAN device /// public enum class TPCANDevice : Byte { /// /// Undefined, unknown or not selected PCAN device value /// PCAN_NONE = 0, /// /// PCAN Non-Plug&Play devices. NOT USED WITHIN PCAN-Basic API /// PCAN_PEAKCAN = 1, /// /// PCAN-ISA, PCAN-PC/104, and PCAN-PC/104-Plus /// PCAN_ISA = 2, /// /// PCAN-Dongle /// PCAN_DNG = 3, /// /// PCAN-PCI, PCAN-cPCI, PCAN-miniPCI, and PCAN-PCI Express /// PCAN_PCI = 4, /// /// PCAN-USB and PCAN-USB Pro /// PCAN_USB = 5, /// /// PCAN-PC Card /// PCAN_PCC = 6 }; /// /// Represents a PCAN parameter to be read or set /// public enum class TPCANParameter : Byte { /// /// PCAN-USB device number parameter /// PCAN_DEVICE_NUMBER = 1, /// /// PCAN-PC Card 5-Volt power parameter /// PCAN_5VOLTS_POWER = 2, /// /// PCAN receive event handler parameter /// PCAN_RECEIVE_EVENT = 3, /// /// PCAN message filter parameter /// PCAN_MESSAGE_FILTER = 4, /// /// PCAN-Basic API version parameter /// PCAN_API_VERSION = 5, /// /// PCAN device channel version parameter /// PCAN_CHANNEL_VERSION = 6, /// /// PCAN Reset-On-Busoff parameter /// PCAN_BUSOFF_AUTORESET = 7, /// /// PCAN Listen-Only parameter /// PCAN_LISTEN_ONLY = 8, /// /// Directory path for log files /// PCAN_LOG_LOCATION = 9, /// /// Debug-Log activation status /// PCAN_LOG_STATUS = 10, /// /// Configuration of the debugged information (LOG_FUNCTION_***) /// PCAN_LOG_CONFIGURE = 11, /// /// Custom insertion of text into the log file /// PCAN_LOG_TEXT = 12, /// /// Availability status of a PCAN-Channel /// PCAN_CHANNEL_CONDITION = 13, /// /// PCAN hardware name parameter /// PCAN_HARDWARE_NAME = 14, /// /// Message reception status of a PCAN-Channel /// PCAN_RECEIVE_STATUS = 15, /// /// CAN-Controller number of a PCAN-Channel /// PCAN_CONTROLLER_NUMBER = 16, /// /// Directory path for PCAN trace files /// PCAN_TRACE_LOCATION = 17, /// /// CAN tracing activation status /// PCAN_TRACE_STATUS = 18, /// /// Configuration of the maximum file size of a CAN trace /// PCAN_TRACE_SIZE = 19, /// /// Configuration of the trace file storing mode (TRACE_FILE_***) /// PCAN_TRACE_CONFIGURE = 20, /// /// Phisical identification of a USB based PCAN-Channel by blinking its associated LED /// PCAN_CHANNEL_IDENTIFYING = 21, }; /// /// Represents the type of a PCAN message /// [Flags] public enum class TPCANMessageType : Byte { /// /// The PCAN message is a CAN Standard Frame (11-bit identifier) /// PCAN_MESSAGE_STANDARD = 0x00, /// /// The PCAN message is a CAN Remote-Transfer-Request Frame /// PCAN_MESSAGE_RTR = 0x01, /// /// The PCAN message is a CAN Extended Frame (29-bit identifier) /// PCAN_MESSAGE_EXTENDED = 0x02, /// /// The PCAN message represents a PCAN status message /// PCAN_MESSAGE_STATUS = 0x80, }; /// /// Represents a PCAN filter mode /// public enum class TPCANMode : Byte { /// /// Mode is Standard (11-bit identifier) /// PCAN_MODE_STANDARD = TPCANMessageType::PCAN_MESSAGE_STANDARD, /// /// Mode is Extended (29-bit identifier) /// PCAN_MODE_EXTENDED = TPCANMessageType::PCAN_MESSAGE_EXTENDED, }; /// /// Represents a PCAN Baud rate register value /// public enum class TPCANBaudrate : UInt16 { /// /// 1 MBit/s /// PCAN_BAUD_1M = 0x0014, /// /// 800 kBit/s /// PCAN_BAUD_800K = 0x0016, /// /// 500 kBit/s /// PCAN_BAUD_500K = 0x001C, /// /// 250 kBit/s /// PCAN_BAUD_250K = 0x011C, /// /// 125 kBit/s /// PCAN_BAUD_125K = 0x031C, /// /// 100 kBit/s /// PCAN_BAUD_100K = 0x432F, /// /// 95,238 kBit/s /// PCAN_BAUD_95K = 0xC34E, /// /// 83,333 kBit/s /// PCAN_BAUD_83K = 0x852B, /// /// 50 kBit/s /// PCAN_BAUD_50K = 0x472F, /// /// 47,619 kBit/s /// PCAN_BAUD_47K = 0x1414, /// /// 33,333 kBit/s /// PCAN_BAUD_33K = 0x8B2F, /// /// 20 kBit/s /// PCAN_BAUD_20K = 0x532F, /// /// 10 kBit/s /// PCAN_BAUD_10K = 0x672F, /// /// 5 kBit/s /// PCAN_BAUD_5K = 0x7F7F, }; /// /// Represents the type of PCAN (non plug&play) hardware to be initialized /// public enum class TPCANType : Byte { /// /// PCAN-ISA 82C200 /// PCAN_TYPE_ISA = 0x01, /// /// PCAN-ISA SJA1000 /// PCAN_TYPE_ISA_SJA = 0x09, /// /// PHYTEC ISA /// PCAN_TYPE_ISA_PHYTEC = 0x04, /// /// PCAN-Dongle 82C200 /// PCAN_TYPE_DNG = 0x02, /// /// PCAN-Dongle EPP 82C200 /// PCAN_TYPE_DNG_EPP = 0x03, /// /// PCAN-Dongle SJA1000 /// PCAN_TYPE_DNG_SJA = 0x05, /// /// PCAN-Dongle EPP SJA1000 /// PCAN_TYPE_DNG_SJA_EPP = 0x06, }; #pragma endregion #pragma region Strutures /// /// Represents a PCAN message /// public value struct TPCANMsg { /// /// 11/29-bit message identifier /// UInt32 ID; /// /// Type of the message /// [MarshalAs(UnmanagedType::U1)] TPCANMessageType MSGTYPE; /// /// Data Length Code of the message (0..8) /// Byte LEN; /// /// Data of the message (DATA[0]..DATA[7]) /// [MarshalAs(UnmanagedType::ByValArray, SizeConst = 8)] array^ DATA; }; /// /// Represents a timestamp of a received PCAN message. /// Total Microseconds = micros + 1000 * millis + 0xFFFFFFFF * 1000 * millis_overflow /// public value struct TPCANTimestamp { /// /// Base-value: milliseconds: 0.. 2^32-1 /// UInt32 millis; /// /// Roll-arounds of millis /// UInt16 millis_overflow; /// /// Microseconds: 0..999 /// UInt16 micros; }; #pragma endregion #pragma region PCANBasic class /// /// PCAN-Basic API class implementation /// public ref class PCANBasic abstract sealed { public: #pragma region PCAN-BUS Handles Definition /// /// Undefined/default value for a PCAN bus /// static const TPCANHandle PCAN_NONEBUS = 0x00; /// /// PCAN-ISA interface, channel 1 /// static const TPCANHandle PCAN_ISABUS1 = 0x21; /// /// PCAN-ISA interface, channel 2 /// static const TPCANHandle PCAN_ISABUS2 = 0x22; /// /// PCAN-ISA interface, channel 3 /// static const TPCANHandle PCAN_ISABUS3 = 0x23; /// /// PCAN-ISA interface, channel 4 /// static const TPCANHandle PCAN_ISABUS4 = 0x24; /// /// PCAN-ISA interface, channel 5 /// static const TPCANHandle PCAN_ISABUS5 = 0x25; /// /// PCAN-ISA interface, channel 6 /// static const TPCANHandle PCAN_ISABUS6 = 0x26; /// /// PCAN-ISA interface, channel 7 /// static const TPCANHandle PCAN_ISABUS7 = 0x27; /// /// PCAN-ISA interface, channel 8 /// static const TPCANHandle PCAN_ISABUS8 = 0x28; /// /// PPCAN-Dongle/LPT interface, channel 1 /// static const TPCANHandle PCAN_DNGBUS1 = 0x31; /// /// PCAN-PCI interface, channel 1 /// static const TPCANHandle PCAN_PCIBUS1 = 0x41; /// /// PCAN-PCI interface, channel 2 /// static const TPCANHandle PCAN_PCIBUS2 = 0x42; /// /// PCAN-PCI interface, channel 3 /// static const TPCANHandle PCAN_PCIBUS3 = 0x43; /// /// PCAN-PCI interface, channel 4 /// static const TPCANHandle PCAN_PCIBUS4 = 0x44; /// /// PCAN-PCI interface, channel 5 /// static const TPCANHandle PCAN_PCIBUS5 = 0x45; /// /// PCAN-PCI interface, channel 6 /// static const TPCANHandle PCAN_PCIBUS6 = 0x46; /// /// PCAN-PCI interface, channel 7 /// static const TPCANHandle PCAN_PCIBUS7 = 0x47; /// /// PCAN-PCI interface, channel 8 /// static const TPCANHandle PCAN_PCIBUS8 = 0x48; /// /// PCAN-USB interface, channel 1 /// static const TPCANHandle PCAN_USBBUS1 = 0x51; /// /// PCAN-USB interface, channel 2 /// static const TPCANHandle PCAN_USBBUS2 = 0x52; /// /// PCAN-USB interface, channel 3 /// static const TPCANHandle PCAN_USBBUS3 = 0x53; /// /// PCAN-USB interface, channel 4 /// static const TPCANHandle PCAN_USBBUS4 = 0x54; /// /// PCAN-USB interface, channel 5 /// static const TPCANHandle PCAN_USBBUS5 = 0x55; /// /// PCAN-USB interface, channel 6 /// static const TPCANHandle PCAN_USBBUS6 = 0x56; /// /// PCAN-USB interface, channel 7 /// static const TPCANHandle PCAN_USBBUS7 = 0x57; /// /// PCAN-USB interface, channel 8 /// static const TPCANHandle PCAN_USBBUS8 = 0x58; /// /// PCAN-PC Card interface, channel 1 /// static const TPCANHandle PCAN_PCCBUS1 = 0x61; /// /// PCAN-PC Card interface, channel 2 /// static const TPCANHandle PCAN_PCCBUS2 = 0x62; #pragma endregion #pragma region Parameter values definition /// /// The PCAN parameter is not set (inactive) /// static const int PCAN_PARAMETER_OFF = 0; /// /// The PCAN parameter is set (active) /// static const int PCAN_PARAMETER_ON = 1; /// /// The PCAN filter is closed. No messages will be received /// static const int PCAN_FILTER_CLOSE = 0; /// /// The PCAN filter is fully opened. All messages will be received /// static const int PCAN_FILTER_OPEN = 1; /// /// The PCAN filter is custom configured. Only registered /// messages will be received /// static const int PCAN_FILTER_CUSTOM = 2; /// /// The PCAN-Channel handle is illegal, or its associated hadware is not available /// static const int PCAN_CHANNEL_UNAVAILABLE = 0; /// /// The PCAN-Channel handle is available to be connected (Plug&Play Hardware: it means futhermore that the hardware is plugged-in) /// static const int PCAN_CHANNEL_AVAILABLE = 1; /// /// The PCAN-Channel handle is valid, and is already being used /// static const int PCAN_CHANNEL_OCCUPIED = 2; /// /// Logs system exceptions / errors /// static const int LOG_FUNCTION_DEFAULT = 0x00; /// /// Logs the entries to the PCAN-Basic API functions /// static const int LOG_FUNCTION_ENTRY = 0x01; /// /// Logs the parameters passed to the PCAN-Basic API functions /// static const int LOG_FUNCTION_PARAMETERS = 0x02; /// /// Logs the exits from the PCAN-Basic API functions /// static const int LOG_FUNCTION_LEAVE = 0x04; /// /// Logs the CAN messages passed to the CAN_Write function /// static const int LOG_FUNCTION_WRITE = 0x08; /// /// Logs the CAN messages received within the CAN_Read function /// static const int LOG_FUNCTION_READ = 0x10; /// /// Logs all possible information within the PCAN-Basic API functions /// static const int LOG_FUNCTION_ALL = 0xFFFF; /// /// A single file is written until it size reaches PAN_TRACE_SIZE /// static const int TRACE_FILE_SINGLE = 0x00; /// /// Traced data is distributed in several files with size PAN_TRACE_SIZE /// static const int TRACE_FILE_SEGMENTED = 0x01; /// /// Includes the date into the name of the trace file /// static const int TRACE_FILE_DATE = 0x02; /// /// Includes the start time into the name of the trace file /// static const int TRACE_FILE_TIME = 0x04; /// /// Causes the overwriting of available traces (same name) /// static const int TRACE_FILE_OVERWRITE = 0x80; #pragma endregion #pragma region PCANBasic API Implementation /// /// Initializes a PCAN Channel /// /// The handle of a PCAN Channel /// The speed for the communication (BTR0BTR1 code) /// NON PLUG&PLAY: The type of hardware and operation mode /// NON PLUG&PLAY: The I/O address for the parallel port /// NON PLUG&PLAY: Interrupt number of the parallel por /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_Initialize")] static TPCANStatus Initialize( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, [MarshalAs(UnmanagedType::U2)] TPCANBaudrate Btr0Btr1, [MarshalAs(UnmanagedType::U1)] TPCANType HwType, UInt32 IOPort, UInt16 Interrupt); /// /// Initializes a PCAN Channel /// /// The handle of a PCAN Channel /// The speed for the communication (BTR0BTR1 code) /// A TPCANStatus error code static TPCANStatus Initialize( TPCANHandle Channel, TPCANBaudrate Btr0Btr1) { return Initialize(Channel, Btr0Btr1, (TPCANType)0, 0, 0); } /// /// Uninitializes one or all PCAN Channels initialized by CAN_Initialize /// /// Giving the TPCANHandle value "PCAN_NONEBUS", /// uninitialize all initialized channels /// The handle of a PCAN Channel /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_Uninitialize")] static TPCANStatus Uninitialize( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel); /// /// Resets the receive and transmit queues of the PCAN Channel /// /// A reset of the CAN controller is not performed /// The handle of a PCAN Channel /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_Reset")] static TPCANStatus Reset( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel); /// /// Gets the current status of a PCAN Channel /// /// The handle of a PCAN Channel /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_GetStatus")] static TPCANStatus GetStatus( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel); /// /// Reads a CAN message from the receive queue of a PCAN Channel /// /// The handle of a PCAN Channel /// A TPCANMsg structure buffer to store the CAN message /// A TPCANTimestamp structure buffer to get /// the reception time of the message /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_Read")] static TPCANStatus Read( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, TPCANMsg %MessageBuffer, TPCANTimestamp %TimestampBuffer); /// /// Reads a CAN message from the receive queue of a PCAN Channel /// /// The handle of a PCAN Channel /// A TPCANMsg structure buffer to store the CAN message /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_Read")] static TPCANStatus Read( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, TPCANMsg %MessageBuffer); /// /// Transmits a CAN message /// /// The handle of a PCAN Channel /// A TPCANMsg buffer with the message to be sent /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_Write")] static TPCANStatus Write( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, TPCANMsg %MessageBuffer); /// /// Configures the reception filter /// /// The message filter will be expanded with every call to /// this function. If it is desired to reset the filter, please use /// the 'SetValue' function /// The handle of a PCAN Channel /// The lowest CAN ID to be received /// The highest CAN ID to be received /// Message type, Standard (11-bit identifier) or /// Extended (29-bit identifier) /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_FilterMessages")] static TPCANStatus FilterMessages( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, UInt32 FromID, UInt32 ToID, [MarshalAs(UnmanagedType::U1)] TPCANMode Mode); /// /// Retrieves a PCAN Channel value /// /// Parameters can be present or not according with the kind /// of Hardware (PCAN Channel) being used. If a parameter is not available, /// a PCAN_ERROR_ILLPARAMTYPE error will be returned /// The handle of a PCAN Channel /// The TPCANParameter parameter to get /// Buffer for the parameter value /// Size in bytes of the buffer /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_GetValue")] static TPCANStatus GetValue( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, [MarshalAs(UnmanagedType::U1)] TPCANParameter Parameter, StringBuilder^ StringBuffer, UInt32 BufferLength); /// /// Retrieves a PCAN Channel value /// /// Parameters can be present or not according with the kind /// of Hardware (PCAN Channel) being used. If a parameter is not available, /// a PCAN_ERROR_ILLPARAMTYPE error will be returned /// The handle of a PCAN Channel /// The TPCANParameter parameter to get /// Buffer for the parameter value /// Size in bytes of the buffer /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_GetValue")] static TPCANStatus GetValue( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, [MarshalAs(UnmanagedType::U1)] TPCANParameter Parameter, UInt32 %NumericBuffer, UInt32 BufferLength); /// /// Configures a PCAN Channel value /// /// Parameters can be present or not according with the kind /// of Hardware (PCAN Channel) being used. If a parameter is not available, /// a PCAN_ERROR_ILLPARAMTYPE error will be returned /// The handle of a PCAN Channel /// The TPCANParameter parameter to set /// Buffer with the value to be set /// Size in bytes of the buffer /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_SetValue")] static TPCANStatus SetValue( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, [MarshalAs(UnmanagedType::U1)] TPCANParameter Parameter, UInt32% NumericBuffer, UInt32 BufferLength); /// /// Configures a PCAN Channel value /// /// Parameters can be present or not according with the kind /// of Hardware (PCAN Channel) being used. If a parameter is not available, /// a PCAN_ERROR_ILLPARAMTYPE error will be returned /// The handle of a PCAN Channel /// /// Buffer with the value to be set /// Size in bytes of the buffer /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_SetValue")] static TPCANStatus SetValue( [MarshalAs(UnmanagedType::U1)] TPCANHandle Channel, [MarshalAs(UnmanagedType::U1)] TPCANParameter Parameter, [MarshalAs(UnmanagedType::LPStr,SizeParamIndex=3)] String^ StringBuffer, UInt32 BufferLength); /// /// Returns a descriptive text of a given TPCANStatus error /// code, in any desired language /// /// The current languages available for translation are: /// Neutral (0x00), German (0x07), English (0x09), Spanish (0x0A), /// Italian (0x10) and French (0x0C) /// A TPCANStatus error code /// Indicates a 'Primary language ID' /// Buffer for the text (must be at least 256 in length) /// A TPCANStatus error code [DllImport("PCANBasic.dll", EntryPoint = "CAN_GetErrorText")] static TPCANStatus GetErrorText( [MarshalAs(UnmanagedType::U4)] TPCANStatus Error, UInt16 Language, StringBuilder^ StringBuffer); #pragma endregion }; #pragma endregion } } }