// PCANBasic.pas // // ~~~~~~~~~~~~ // // PCAN-Basic API // // ~~~~~~~~~~~~ // // ------------------------------------------------------------------ // Author : Keneth Wagner // Last change: 2022-07-06 // // Language: Object Pascal // ------------------------------------------------------------------ // // Copyright (C) 1999-2022 PEAK-System Technik GmbH, Darmstadt // more Info at http://www.peak-system.com // unit PCANBasic; interface Const // Other constants // MAX_LENGTH_HARDWARE_NAME = 33; // Maximum length of the name of a device: 32 characters + terminator MAX_LENGTH_VERSION_STRING = 256; // Maximum length of a version string: 255 characters + terminator type TPCANHandle = Word; PTPCANHandle = ^Word; TPCANBitrateFD = PAnsiChar; TPCANTimestampFD = UInt64; PUInt64 = ^UInt64; {$Z4} /// /// Represents a PCAN status/error code /// TPCANStatus = ( /// /// No error /// PCAN_ERROR_OK = $00000, /// /// Transmit buffer in CAN controller is full /// PCAN_ERROR_XMTFULL = $00001, /// /// CAN controller was read too late /// PCAN_ERROR_OVERRUN = $00002, /// /// Bus error: an error counter reached the 'light' limit /// PCAN_ERROR_BUSLIGHT = $00004, /// /// Bus error: an error counter reached the 'heavy' limit /// PCAN_ERROR_BUSHEAVY = $00008, /// /// Bus error: an error counter reached the 'warning' limit /// PCAN_ERROR_BUSWARNING = LongWord(PCAN_ERROR_BUSHEAVY), /// /// Bus error: the CAN controller is error passive /// PCAN_ERROR_BUSPASSIVE = $40000, /// /// Bus error: the CAN controller is in bus-off state /// PCAN_ERROR_BUSOFF = $00010, /// /// Mask for all bus errors /// PCAN_ERROR_ANYBUSERR = LongWord(PCAN_ERROR_BUSWARNING) Or LongWord(PCAN_ERROR_BUSLIGHT) Or LongWord(PCAN_ERROR_BUSHEAVY) Or LongWord(PCAN_ERROR_BUSOFF) Or LongWord(PCAN_ERROR_BUSPASSIVE), /// /// Receive queue is empty /// PCAN_ERROR_QRCVEMPTY = $00020, /// /// Receive queue was read too late /// PCAN_ERROR_QOVERRUN = $00040, /// /// Transmit queue is full /// PCAN_ERROR_QXMTFULL = $00080, /// /// Test of the CAN controller hardware registers failed (no hardware found) /// PCAN_ERROR_REGTEST = $00100, /// /// Driver not loaded /// PCAN_ERROR_NODRIVER = $00200, /// /// Hardware already in use by a Net /// PCAN_ERROR_HWINUSE = $00400, /// /// A Client is already connected to the Net /// PCAN_ERROR_NETINUSE = $00800, /// /// Hardware handle is invalid /// PCAN_ERROR_ILLHW = $01400, /// /// Net handle is invalid /// PCAN_ERROR_ILLNET = $01800, /// /// Client handle is invalid /// PCAN_ERROR_ILLCLIENT = $01C00, /// /// Mask for all handle errors /// PCAN_ERROR_ILLHANDLE = LongWord(PCAN_ERROR_ILLHW) Or LongWord(PCAN_ERROR_ILLNET) Or LongWord(PCAN_ERROR_ILLCLIENT), /// /// Resource (FIFO, Client, timeout) cannot be created /// PCAN_ERROR_RESOURCE = $02000, /// /// Invalid parameter /// PCAN_ERROR_ILLPARAMTYPE = $04000, /// /// Invalid parameter value /// PCAN_ERROR_ILLPARAMVAL = $08000, /// /// Unknown error /// PCAN_ERROR_UNKNOWN = $10000, /// /// Invalid data, function, or action /// PCAN_ERROR_ILLDATA = $20000, /// /// Driver object state is wrong for the attempted operation /// PCAN_ERROR_ILLMODE = $80000, /// /// An operation was successfully carried out, however, irregularities were registered /// PCAN_ERROR_CAUTION = $2000000, /// /// Channel is not initialized /// Value was changed from 0x40000 to 0x4000000 /// PCAN_ERROR_INITIALIZE = $4000000, /// /// Invalid operation /// Value was changed from 0x80000 to 0x8000000 /// PCAN_ERROR_ILLOPERATION = $8000000 ); {$Z1} /// /// Represents a PCAN device /// TPCANDevice = ( /// /// Undefined, unknown or not selected PCAN device value /// PCAN_NONE = 0, /// /// PCAN Non-PnP 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, /// /// PCAN Virtual hardware. NOT USED WITHIN PCAN-Basic API /// PCAN_VIRTUAL = 7, /// /// PCAN Gateway devices /// PCAN_LAN = 8 ); /// /// Represents a PCAN parameter to be read or set /// TPCANParameter = ( /// /// Device identifier parameter /// PCAN_DEVICE_ID = 1, /// /// DEPRECATED. Use PCAN_DEVICE_ID instead /// PCAN_DEVICE_NUMBER = PCAN_DEVICE_ID, /// /// 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, /// /// Physical identification of a USB based PCAN-Channel by blinking its associated LED /// PCAN_CHANNEL_IDENTIFYING = 21, /// /// Capabilities of a PCAN device (FEATURE_***) /// PCAN_CHANNEL_FEATURES = 22, /// /// Using of an existing bit rate (PCAN-View connected to a channel) /// PCAN_BITRATE_ADAPTING = 23, /// /// Configured bit rate as Btr0Btr1 value /// PCAN_BITRATE_INFO = 24, /// /// Configured bit rate as TPCANBitrateFD string /// PCAN_BITRATE_INFO_FD = 25, /// /// Configured nominal CAN Bus speed as Bits per seconds /// PCAN_BUSSPEED_NOMINAL = 26, /// /// Configured CAN data speed as Bits per seconds /// PCAN_BUSSPEED_DATA = 27, /// /// Remote address of a LAN channel as string in IPv4 format /// PCAN_IP_ADDRESS = 28, /// /// Status of the Virtual PCAN-Gateway Service /// PCAN_LAN_SERVICE_STATUS = 29, /// /// Status messages reception status within a PCAN-Channel /// PCAN_ALLOW_STATUS_FRAMES = 30, /// /// RTR messages reception status within a PCAN-Channel /// PCAN_ALLOW_RTR_FRAMES = 31, /// /// Error messages reception status within a PCAN-Channel /// PCAN_ALLOW_ERROR_FRAMES = 32, /// /// Delay, in microseconds, between sending frames /// PCAN_INTERFRAME_DELAY = 33, /// /// Filter over code and mask patterns for 11-Bit messages /// PCAN_ACCEPTANCE_FILTER_11BIT = 34, /// /// Filter over code and mask patterns for 29-Bit messages /// PCAN_ACCEPTANCE_FILTER_29BIT = 35, /// /// Output mode of 32 digital I/O pin of a PCAN-USB Chip. 1: Output-Active 0 : Output Inactive /// PCAN_IO_DIGITAL_CONFIGURATION = 36, /// /// Value assigned to a 32 digital I/O pins of a PCAN-USB Chip /// PCAN_IO_DIGITAL_VALUE = 37, /// /// Value assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = High /// PCAN_IO_DIGITAL_SET = 38, /// /// Clear multiple digital I/O pins to 0 /// PCAN_IO_DIGITAL_CLEAR = 39, /// /// Get value of a single analog input pin /// PCAN_IO_ANALOG_VALUE = 40, /// /// Get the version of the firmware used by the device associated with a PCAN-Channel /// PCAN_FIRMWARE_VERSION = 41, /// /// Get the amount of PCAN channels attached to a system /// PCAN_ATTACHED_CHANNELS_COUNT = 42, /// /// Get information about PCAN channels attached to a system /// PCAN_ATTACHED_CHANNELS = 43, /// /// Echo messages reception status within a PCAN-Channel /// PCAN_ALLOW_ECHO_FRAMES = 44, /// /// Get the part number associated to a device /// PCAN_DEVICE_PART_NUMBER = 45 ); /// /// Represents the type of a PCAN message /// TPCANMessageType = ( /// /// The PCAN message is a CAN Standard Frame (11-bit identifier) /// PCAN_MESSAGE_STANDARD = $00, /// /// The PCAN message is a CAN Remote-Transfer-Request Frame /// PCAN_MESSAGE_RTR = $01, /// /// The PCAN message is a CAN Extended Frame (29-bit identifier) /// PCAN_MESSAGE_EXTENDED = $02, /// /// The PCAN message represents a FD frame in terms of CiA Specs /// PCAN_MESSAGE_FD = $04, /// /// The PCAN message represents a FD bit rate switch (CAN data at a higher bit rate) /// PCAN_MESSAGE_BRS = $08, /// /// The PCAN message represents a FD error state indicator(CAN FD transmitter was error active) /// PCAN_MESSAGE_ESI = $10, /// /// The PCAN message represents an echo CAN Frame /// PCAN_MESSAGE_ECHO = $20, /// /// The PCAN message represents an error frame /// PCAN_MESSAGE_ERRFRAME = $40, /// /// The PCAN message represents a PCAN status message /// PCAN_MESSAGE_STATUS = $80 ); /// /// Represents a PCAN filter mode /// TPCANMode = ( /// /// Mode is Standard (11-bit identifier) /// PCAN_MODE_STANDARD = Byte(PCAN_MESSAGE_STANDARD), /// /// Mode is Extended (29-bit identifier) /// PCAN_MODE_EXTENDED = Byte(PCAN_MESSAGE_EXTENDED) ); {$Z2} /// /// Represents a PCAN Baud rate register value /// TPCANBaudrate = ( /// /// 1 MBit/s /// PCAN_BAUD_1M = $0014, /// /// 800 kBit/s /// PCAN_BAUD_800K = $0016, /// /// 500 kBit/s /// PCAN_BAUD_500K = $001C, /// /// 250 kBit/s /// PCAN_BAUD_250K = $011C, /// /// 125 kBit/s /// PCAN_BAUD_125K = $031C, /// /// 100 kBit/s /// PCAN_BAUD_100K = $432F, /// /// 95,238 kBit/s /// PCAN_BAUD_95K = $C34E, /// /// 83,333 kBit/s /// PCAN_BAUD_83K = $852B, /// /// 50 kBit/s /// PCAN_BAUD_50K = $472F, /// /// 47,619 kBit/s /// PCAN_BAUD_47K = $1414, /// /// 33,333 kBit/s /// PCAN_BAUD_33K = $8B2F, /// /// 20 kBit/s /// PCAN_BAUD_20K = $532F, /// /// 10 kBit/s /// PCAN_BAUD_10K = $672F, /// /// 5 kBit/s /// PCAN_BAUD_5K = $7F7F ); {$Z1} /// /// Represents the type of PCAN (Non-PnP) hardware to be initialized /// TPCANType = ( /// /// PCAN-ISA 82C200 /// PCAN_TYPE_ISA = $01, /// /// PCAN-ISA SJA1000 /// PCAN_TYPE_ISA_SJA = $09, /// /// PHYTEC ISA /// PCAN_TYPE_ISA_PHYTEC = $04, /// /// PCAN-Dongle 82C200 /// PCAN_TYPE_DNG = $02, /// /// PCAN-Dongle EPP 82C200 /// PCAN_TYPE_DNG_EPP = $03, /// /// PCAN-Dongle SJA1000 /// PCAN_TYPE_DNG_SJA = $05, /// /// PCAN-Dongle EPP SJA1000 /// PCAN_TYPE_DNG_SJA_EPP = $06 ); /// /// Represents a PCAN message /// TPCANMsg = record /// /// 11/29-bit message identifier /// ID: Longword; /// /// Type of the message /// MSGTYPE: TPCANMessageType; /// /// Data Length Code of the message (0..8) /// LEN: Byte; /// /// Data of the message (DATA[0]..DATA[7]) /// DATA: array[0..7] of Byte; end; PTPCANMsg = ^TPCANMsg; /// /// Represents a timestamp of a received PCAN message. /// Total Microseconds = micros + 1000 * millis + 0x100000000 * 1000 * millis_overflow /// TPCANTimestamp = record /// /// Base-value: milliseconds: 0.. 2^32-1 /// millis: Longword; /// /// Roll-arounds of millis /// millis_overflow: Word; /// /// Microseconds: 0..999 /// micros: Word; end; PTPCANTimestamp = ^TPCANTimestamp; /// /// Represents a PCAN message from a FD capable hardware /// TPCANMsgFD = record /// /// 11/29-bit message identifier /// ID: Longword; /// /// Type of the message /// MSGTYPE: TPCANMessageType; /// /// Data Length Code of the message (0..15) /// DLC: Byte; /// /// Data of the message (DATA[0]..DATA[63]) /// DATA: array[0..63] of Byte; end; PTPCANMsgFD = ^TPCANMsgFD; /// /// Describes an available PCAN channel /// TPCANChannelInformation = record /// /// PCAN channel handle /// channel_handle: TPCANHandle; /// /// Kind of PCAN device /// device_type: TPCANDevice; /// /// CAN-Controller number /// controller_number: Byte; /// /// Device capabilities flag (see FEATURE_*) /// device_features: Longword; /// /// Device name /// device_name: array [0..MAX_LENGTH_HARDWARE_NAME-1] of AnsiChar; /// /// Device number /// device_id: Longword; /// /// Availability status of a PCAN-Channel /// channel_condition: Longword; end; PTPCANChannelInformation = ^TPCANChannelInformation; /// /// PCAN-Basic API class implementation /// TPCANBasic = class public class var /// /// Undefined/default value for a PCAN bus /// const PCAN_NONEBUS: TPCANHandle = $00; /// /// PCAN-ISA interface, channel 1 /// const PCAN_ISABUS1: TPCANHandle = $21; /// /// PCAN-ISA interface, channel 2 /// const PCAN_ISABUS2: TPCANHandle = $22; /// /// PCAN-ISA interface, channel 3 /// const PCAN_ISABUS3: TPCANHandle = $23; /// /// PCAN-ISA interface, channel 4 /// const PCAN_ISABUS4: TPCANHandle = $24; /// /// PCAN-ISA interface, channel 5 /// const PCAN_ISABUS5: TPCANHandle = $25; /// /// PCAN-ISA interface, channel 6 /// const PCAN_ISABUS6: TPCANHandle = $26; /// /// PCAN-ISA interface, channel 7 /// const PCAN_ISABUS7: TPCANHandle = $27; /// /// PCAN-ISA interface, channel 8 /// const PCAN_ISABUS8: TPCANHandle = $28; /// /// PPCAN-Dongle/LPT interface, channel 1 /// const PCAN_DNGBUS1: TPCANHandle = $31; /// /// PCAN-PCI interface, channel 1 /// const PCAN_PCIBUS1: TPCANHandle = $41; /// /// PCAN-PCI interface, channel 2 /// const PCAN_PCIBUS2: TPCANHandle = $42; /// /// PCAN-PCI interface, channel 3 /// const PCAN_PCIBUS3: TPCANHandle = $43; /// /// PCAN-PCI interface, channel 4 /// const PCAN_PCIBUS4: TPCANHandle = $44; /// /// PCAN-PCI interface, channel 5 /// const PCAN_PCIBUS5: TPCANHandle = $45; /// /// PCAN-PCI interface, channel 6 /// const PCAN_PCIBUS6: TPCANHandle = $46; /// /// PCAN-PCI interface, channel 7 /// const PCAN_PCIBUS7: TPCANHandle = $47; /// /// PCAN-PCI interface, channel 8 /// const PCAN_PCIBUS8: TPCANHandle = $48; /// /// PCAN-PCI interface, channel 9 /// const PCAN_PCIBUS9: TPCANHandle = $409; /// /// PCAN-PCI interface, channel 10 /// const PCAN_PCIBUS10: TPCANHandle = $40A; /// /// PCAN-PCI interface, channel 11 /// const PCAN_PCIBUS11: TPCANHandle = $40B; /// /// PCAN-PCI interface, channel 12 /// const PCAN_PCIBUS12: TPCANHandle = $40C; /// /// PCAN-PCI interface, channel 13 /// const PCAN_PCIBUS13: TPCANHandle = $40D; /// /// PCAN-PCI interface, channel 14 /// const PCAN_PCIBUS14: TPCANHandle = $40E; /// /// PCAN-PCI interface, channel 15 /// const PCAN_PCIBUS15: TPCANHandle = $40F; /// /// PCAN-PCI interface, channel 16 /// const PCAN_PCIBUS16: TPCANHandle = $410; /// /// PCAN-USB interface, channel 1 /// const PCAN_USBBUS1: TPCANHandle = $51; /// /// PCAN-USB interface, channel 2 /// const PCAN_USBBUS2: TPCANHandle = $52; /// /// PCAN-USB interface, channel 3 /// const PCAN_USBBUS3: TPCANHandle = $53; /// /// PCAN-USB interface, channel 4 /// const PCAN_USBBUS4: TPCANHandle = $54; /// /// PCAN-USB interface, channel 5 /// const PCAN_USBBUS5: TPCANHandle = $55; /// /// PCAN-USB interface, channel 6 /// const PCAN_USBBUS6: TPCANHandle = $56; /// /// PCAN-USB interface, channel 7 /// const PCAN_USBBUS7: TPCANHandle = $57; /// /// PCAN-USB interface, channel 8 /// const PCAN_USBBUS8: TPCANHandle = $58; /// /// PCAN-USB interface, channel 9 /// const PCAN_USBBUS9: TPCANHandle = $509; /// /// PCAN-USB interface, channel 10 /// const PCAN_USBBUS10: TPCANHandle = $50A; /// /// PCAN-USB interface, channel 11 /// const PCAN_USBBUS11: TPCANHandle = $50B; /// /// PCAN-USB interface, channel 12 /// const PCAN_USBBUS12: TPCANHandle = $50C; /// /// PCAN-USB interface, channel 13 /// const PCAN_USBBUS13: TPCANHandle = $50D; /// /// PCAN-USB interface, channel 14 /// const PCAN_USBBUS14: TPCANHandle = $50E; /// /// PCAN-USB interface, channel 15 /// const PCAN_USBBUS15: TPCANHandle = $50F; /// /// PCAN-USB interface, channel 16 /// const PCAN_USBBUS16: TPCANHandle = $510; /// /// PCAN-PC Card interface, channel 1 /// const PCAN_PCCBUS1: TPCANHandle = $61; /// /// PCAN-PC Card interface, channel 2 /// const PCAN_PCCBUS2: TPCANHandle = $62; /// /// PCAN-LAN interface, channel 1 /// const PCAN_LANBUS1: TPCANHandle = $801; /// /// PCAN-LAN interface, channel 2 /// const PCAN_LANBUS2: TPCANHandle = $802; /// /// PCAN-LAN interface, channel 3 /// const PCAN_LANBUS3: TPCANHandle = $803; /// /// PCAN-LAN interface, channel 4 /// const PCAN_LANBUS4: TPCANHandle = $804; /// /// PCAN-LAN interface, channel 5 /// const PCAN_LANBUS5: TPCANHandle = $805; /// /// PCAN-LAN interface, channel 6 /// const PCAN_LANBUS6: TPCANHandle = $806; /// /// PCAN-LAN interface, channel 7 /// const PCAN_LANBUS7: TPCANHandle = $807; /// /// PCAN-LAN interface, channel 8 /// const PCAN_LANBUS8: TPCANHandle = $808; /// /// PCAN-LAN interface, channel 9 /// const PCAN_LANBUS9: TPCANHandle = $809; /// /// PCAN-LAN interface, channel 10 /// const PCAN_LANBUS10: TPCANHandle = $80A; /// /// PCAN-LAN interface, channel 11 /// const PCAN_LANBUS11: TPCANHandle = $80B; /// /// PCAN-LAN interface, channel 12 /// const PCAN_LANBUS12: TPCANHandle = $80C; /// /// PCAN-LAN interface, channel 13 /// const PCAN_LANBUS13: TPCANHandle = $80D; /// /// PCAN-LAN interface, channel 14 /// const PCAN_LANBUS14: TPCANHandle = $80E; /// /// PCAN-LAN interface, channel 15 /// const PCAN_LANBUS15: TPCANHandle = $80F; /// /// PCAN-LAN interface, channel 16 /// const PCAN_LANBUS16: TPCANHandle = $810; /// /// Clock frequency in Herz (80000000, 60000000, 40000000, 30000000, 24000000, 20000000) /// const PCAN_BR_CLOCK: String = 'f_clock'; /// /// Clock frequency in Megaherz (80, 60, 40, 30, 24, 20) /// const PCAN_BR_CLOCK_MHZ: String = 'f_clock_mhz'; /// /// Clock prescaler for nominal time quantum /// const PCAN_BR_NOM_BRP: String = 'nom_brp'; /// /// TSEG1 segment for nominal bit rate in time quanta /// const PCAN_BR_NOM_TSEG1: String = 'nom_tseg1'; /// /// TSEG2 segment for nominal bit rate in time quanta /// const PCAN_BR_NOM_TSEG2: String = 'nom_tseg2'; /// /// Synchronization Jump Width for nominal bit rate in time quanta /// const PCAN_BR_NOM_SJW: String = 'nom_sjw'; /// /// Sample point for nominal bit rate /// const PCAN_BR_NOM_SAMPLE: String = 'nom_sam'; /// /// Clock prescaler for highspeed data time quantum /// const PCAN_BR_DATA_BRP: String = 'data_brp'; /// /// TSEG1 segment for fast data bit rate in time quanta /// const PCAN_BR_DATA_TSEG1: String = 'data_tseg1'; /// /// TSEG2 segment for fast data bit rate in time quanta /// const PCAN_BR_DATA_TSEG2: String = 'data_tseg2'; /// /// Synchronization Jump Width for highspeed data bit rate in time quanta /// const PCAN_BR_DATA_SJW: String = 'data_sjw'; /// /// Secondary sample point delay for highspeed data bit rate in cyles /// const PCAN_BR_DATA_SAMPLE: String = 'data_ssp_offset'; /// /// The PCAN parameter is not set (inactive) /// const PCAN_PARAMETER_OFF: Integer = 0; /// /// The PCAN parameter is set (active) /// const PCAN_PARAMETER_ON: Integer = 1; /// /// The PCAN filter is closed. No messages will be received /// const PCAN_FILTER_CLOSE: Integer = 0; /// /// The PCAN filter is fully opened. All messages will be received /// const PCAN_FILTER_OPEN: Integer = 1; /// /// The PCAN filter is custom configured. Only registered /// messages will be received /// const PCAN_FILTER_CUSTOM: Integer = 2; /// /// The PCAN-Channel handle is illegal, or its associated hardware is not available /// const PCAN_CHANNEL_UNAVAILABLE: Integer = 0; /// /// The PCAN-Channel handle is available to be connected (PnP Hardware: it means furthermore that the hardware is plugged-in) /// const PCAN_CHANNEL_AVAILABLE: Integer = 1; /// /// The PCAN-Channel handle is valid, and is already being used /// const PCAN_CHANNEL_OCCUPIED: Integer = 2; /// /// The PCAN-Channel handle is already being used by a PCAN-View application, but is available to connect /// const PCAN_CHANNEL_PCANVIEW: Integer = 3; /// /// Logs system exceptions / errors /// const LOG_FUNCTION_DEFAULT: Integer = $00; /// /// Logs the entries to the PCAN-Basic API functions /// const LOG_FUNCTION_ENTRY: Integer = $01; /// /// Logs the parameters passed to the PCAN-Basic API functions /// const LOG_FUNCTION_PARAMETERS: Integer = $02; /// /// Logs the exits from the PCAN-Basic API functions /// const LOG_FUNCTION_LEAVE: Integer = $04; /// /// Logs the CAN messages passed to the CAN_Write function /// const LOG_FUNCTION_WRITE: Integer = $08; /// /// Logs the CAN messages received within the CAN_Read function /// const LOG_FUNCTION_READ: Integer = $10; /// /// Logs all possible information within the PCAN-Basic API functions /// const LOG_FUNCTION_ALL: Integer = $FFFF; /// /// A single file is written until it size reaches PAN_TRACE_SIZE /// const TRACE_FILE_SINGLE: Integer = $00; /// /// Traced data is distributed in several files with size PAN_TRACE_SIZE /// const TRACE_FILE_SEGMENTED: Integer = $01; /// /// Includes the date into the name of the trace file /// const TRACE_FILE_DATE: Integer = $02; /// /// Includes the start time into the name of the trace file /// const TRACE_FILE_TIME: Integer = $04; /// /// Causes the overwriting of available traces (same name) /// const TRACE_FILE_OVERWRITE: Integer = $80; /// /// Device supports flexible data-rate (CAN-FD) /// const FEATURE_FD_CAPABLE: Integer = $01; /// /// Device supports a delay between sending frames (FPGA based USB devices) /// const FEATURE_DELAY_CAPABLE: Integer = $2; /// /// Device supports I/O functionality for electronic circuits (USB-Chip devices) /// const FEATURE_IO_CAPABLE: Integer = $4; /// /// The service is not running /// const SERVICE_STATUS_STOPPED: Integer = $01; /// /// The service is running /// const SERVICE_STATUS_RUNNING: Integer = $04; /// /// Lookup channel by Device type (see PCAN devices e.g. PCAN_USB) /// const LOOKUP_DEVICE_TYPE: String = 'devicetype'; /// /// Lookup channel by device id /// const LOOKUP_DEVICE_ID: String = 'deviceid'; /// /// Lookup channel by CAN controller 0-based index /// const LOOKUP_CONTROLLER_NUMBER: String = 'controllernumber'; /// /// Lookup channel by IP address (LAN channels only) /// const LOOKUP_IP_ADDRESS: String = 'ipaddress'; /// /// Maximum length of the name of a device: 32 characters + terminator /// const MAX_LENGTH_HARDWARE_NAME: Integer = 33; /// /// Maximum length of a version string: 255 characters + terminator /// const MAX_LENGTH_VERSION_STRING: Integer = 256; /// /// Initializes a PCAN Channel /// /// The handle of a PCAN Channel /// The speed for the communication (BTR0BTR1 code) /// Non-PnP: The type of hardware and operation mode /// Non-PnP: The I/O address for the parallel port /// Non-PnP: Interrupt number of the parallel port /// A TPCANStatus error code class function Initialize( Channel: TPCANHandle; Btr0Btr1: TPCANBaudrate; HwType: TPCANType; IOPort: LongWord; Interrupt: Word ): TPCANStatus; overload; /// /// Initializes a PCAN Channel /// /// The handle of a PCAN Channel /// The speed for the communication (BTR0BTR1 code) /// A TPCANStatus error code class function Initialize( Channel: TPCANHandle; Btr0Btr1: TPCANBaudrate ): TPCANStatus; overload; /// /// Initializes a FD capable PCAN Channel /// /// The handle of a PCAN Channel /// The speed for the communication (FD bit rate string) /// See PCAN_BR_* values /// Bit rate string must follow the following construction rules: /// * parameter and values must be separated by '=' /// * Couples of Parameter/value must be separated by ',' /// * Following Parameter must be filled out: f_clock, data_brp, data_sjw, data_tseg1, data_tseg2, /// nom_brp, nom_sjw, nom_tseg1, nom_tseg2. /// * Following Parameters are optional (not used yet): data_ssp_offset, nom_sam /// f_clock=80000000,nom_brp=10,nom_tseg1=5,nom_tseg2=2,nom_sjw=1,data_brp=4,data_tseg1=7,data_tseg2=2,data_sjw=1 /// A TPCANStatus error code class function InitializeFD( Channel: TPCANHandle; BitrateFD: TPCANBitrateFD ): TPCANStatus; /// /// 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 class function Uninitialize( Channel: TPCANHandle ): TPCANStatus; /// /// 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 class function Reset( Channel: TPCANHandle ): TPCANStatus; /// /// Gets the current status of a PCAN Channel /// /// The handle of a PCAN Channel /// A TPCANStatus error code class function GetStatus( Channel: TPCANHandle ): TPCANStatus; /// /// 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 class function Read( Channel: TPCANHandle; var MessageBuffer: TPCANMsg; var TimestampBuffer: TPCANTimestamp ):TPCANStatus; overload; /// /// 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 class function Read( Channel: TPCANHandle; var MessageBuffer: TPCANMsg ): TPCANStatus; overload; /// /// Reads a CAN message from the receive queue of a FD capable PCAN Channel /// /// The handle of a FD capable PCAN Channel /// A TPCANMsgFD structure buffer to store the CAN message /// A TPCANTimestampFD buffer to get the /// reception time of the message /// A TPCANStatus error code class function ReadFD( Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD; var TimestampBuffer: TPCANTimestampFD ):TPCANStatus; overload; /// /// Reads a CAN message from the receive queue of a FD capable PCAN Channel /// /// The handle of a FD capable PCAN Channel /// A TPCANMsgFD structure buffer to store the CAN message /// A TPCANStatus error code class function ReadFD( Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD ):TPCANStatus; overload; /// /// Transmits a CAN message /// /// The handle of a PCAN Channel /// A TPCANMsg buffer with the message to be sent /// A TPCANStatus error code class function Write( Channel: TPCANHandle; var MessageBuffer: TPCANMsg ): TPCANStatus; /// /// Transmits a CAN message over a FD capable PCAN Channel /// /// The handle of a FD capable PCAN Channel /// A TPCANMsgFD buffer with the message to be sent /// A TPCANStatus error code class function WriteFD( Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD ): TPCANStatus; /// /// 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 class function FilterMessages( Channel: TPCANHandle; FromID: LongWord; ToID: LongWord; Mode: TPCANMode ): TPCANStatus; /// /// 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 class function GetValue( Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PLongWord; BufferLength: LongWord ): TPCANStatus; overload; /// /// 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 class function GetValue( Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PUInt64; BufferLength: LongWord ): TPCANStatus; overload; /// /// 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 class function GetValue( Channel: TPCANHandle; Parameter: TPCANParameter; StringBuffer: PAnsiChar; BufferLength: LongWord ): TPCANStatus; overload; class function GetValue( Channel: TPCANHandle; Parameter: TPCANParameter; ChannelsBuffer: PTPCANChannelInformation; BufferLength: LongWord ): TPCANStatus; overload; /// /// Configures or sets 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 class function SetValue( Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PLongWord; BufferLength: LongWord ): TPCANStatus; overload; /// /// Configures or sets 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 class function SetValue( Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PUInt64; BufferLength: LongWord ): TPCANStatus; overload; /// /// Configures or sets 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 class function SetValue( Channel: TPCANHandle; Parameter: TPCANParameter; StringBuffer: PAnsiChar; BufferLength: LongWord ): TPCANStatus; overload; /// /// 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 class function GetErrorText( Error: TPCANStatus; Language: Word; StringBuffer: PAnsiChar ): TPCANStatus; /// /// Finds a PCAN-Basic channel that matches with the given parameters /// /// A comma separated string contained pairs of /// parameter-name/value to be matched within a PCAN-Basic channel /// Buffer for returning the PCAN-basic channel, /// when found /// A TPCANStatus error code class function LookUpChannel( Parameters: PAnsiChar; FoundChannel: PTPCANHandle ): TPCANStatus; end; implementation uses SysUtils; const DLL_Name = 'PCANBASIC.DLL'; function CAN_Initialize(Channel: TPCANHandle; Btr0Btr1: TPCANBaudrate; HwType: TPCANType; IOPort: LongWord; Interrupt: Word): TPCANStatus; stdcall; external DLL_Name; function CAN_InitializeFD(Channel: TPCANHandle; BitrateFD: TPCANBitrateFD): TPCANStatus; stdcall; external DLL_Name; function CAN_Uninitialize(Channel: TPCANHandle): TPCANStatus; stdcall; external DLL_Name; function CAN_Reset(Channel: TPCANHandle): TPCANStatus; stdcall; external DLL_Name; function CAN_GetStatus(Channel: TPCANHandle): TPCANStatus; stdcall; external DLL_Name; function CAN_Read(Channel: TPCANHandle; var MessageBuffer: TPCANMsg; TimestampBuffer: PTPCANTimestamp):TPCANStatus; overload; stdcall; external DLL_Name; function CAN_ReadFD(Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD; TimestampBuffer: PUInt64):TPCANStatus; overload; stdcall; external DLL_Name; function CAN_Write(Channel: TPCANHandle; var MessageBuffer: TPCANMsg): TPCANStatus; stdcall; external DLL_Name; function CAN_WriteFD(Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD): TPCANStatus; stdcall; external DLL_Name; function CAN_FilterMessages(Channel: TPCANHandle; FromID: LongWord; ToID: LongWord; Mode: TPCANMode): TPCANStatus; stdcall; external DLL_Name; function CAN_GetValue(Channel: TPCANHandle; Parameter: TPCANParameter; Buffer: Pointer; BufferLength: LongWord): TPCANStatus; stdcall; external DLL_Name; function CAN_SetValue(Channel: TPCANHandle; Parameter: TPCANParameter; Buffer: Pointer; BufferLength: LongWord): TPCANStatus; stdcall; external DLL_Name; function CAN_GetErrorText(Error: TPCANStatus; Language: Word; StringBuffer: PAnsiChar): TPCANStatus; stdcall; external DLL_Name; function CAN_LookUpChannel(Parameters: PAnsiChar; FoundChannel: PTPCANHandle): TPCANStatus; stdcall; external DLL_Name; class function TPCANBasic.Initialize(Channel: TPCANHandle; Btr0Btr1: TPCANBaudrate; HwType: TPCANType; IOPort: LongWord; Interrupt: Word): TPCANStatus; begin Result:= CAN_Initialize(Channel,Btr0Btr1,HwType,IOPort,Interrupt); end; class function TPCANBasic.Initialize(Channel: TPCANHandle; Btr0Btr1: TPCANBaudrate): TPCANStatus; begin Result:= CAN_Initialize(Channel,Btr0Btr1,PCAN_TYPE_ISA, 0,0); end; class function TPCANBasic.InitializeFD(Channel: TPCANHandle; BitrateFD: TPCANBitrateFD): TPCANStatus; begin Result:= CAN_InitializeFD(Channel,BitrateFD); end; class function TPCANBasic.Uninitialize(Channel: TPCANHandle): TPCANStatus; begin Result:= CAN_Uninitialize(Channel); end; class function TPCANBasic.Reset(Channel: TPCANHandle): TPCANStatus; begin Result:= CAN_Reset(Channel); end; class function TPCANBasic.GetStatus(Channel: TPCANHandle): TPCANStatus; begin Result:= CAN_GetStatus(Channel); end; class function TPCANBasic.Read(Channel: TPCANHandle; var MessageBuffer: TPCANMsg; var TimestampBuffer: TPCANTimestamp):TPCANStatus; begin Result:= CAN_Read(Channel, MessageBuffer, @TimestampBuffer); end; class function TPCANBasic.Read(Channel: TPCANHandle; var MessageBuffer: TPCANMsg):TPCANStatus; begin Result:= CAN_Read(Channel, MessageBuffer, nil); end; class function TPCANBasic.ReadFD(Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD; var TimestampBuffer: TPCANTimestampFD):TPCANStatus; begin Result:= CAN_ReadFD(Channel, MessageBuffer, @TimestampBuffer); end; class function TPCANBasic.ReadFD(Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD):TPCANStatus; begin Result:= CAN_ReadFD(Channel, MessageBuffer, nil); end; class function TPCANBasic.Write(Channel: TPCANHandle; var MessageBuffer: TPCANMsg): TPCANStatus; begin Result:= CAN_Write(Channel, MessageBuffer); end; class function TPCANBasic.WriteFD(Channel: TPCANHandle; var MessageBuffer: TPCANMsgFD): TPCANStatus; begin Result:= CAN_WriteFD(Channel, MessageBuffer); end; class function TPCANBasic.FilterMessages(Channel: TPCANHandle; FromID: LongWord; ToID: LongWord; Mode: TPCANMode): TPCANStatus; begin Result:= CAN_FilterMessages(Channel, FromID,ToID,Mode); end; class function TPCANBasic.GetValue(Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PLongWord; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_GetValue(Channel, Parameter, NumericBuffer, BufferLength); end; class function TPCANBasic.GetValue(Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PUInt64; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_GetValue(Channel, Parameter, NumericBuffer, BufferLength); end; class function TPCANBasic.GetValue(Channel: TPCANHandle; Parameter: TPCANParameter; StringBuffer: PAnsiChar; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_GetValue(Channel, Parameter, StringBuffer, BufferLength); end; class function TPCANBasic.GetValue(Channel: TPCANHandle; Parameter: TPCANParameter; ChannelsBuffer: PTPCANChannelInformation; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_GetValue(Channel, Parameter, ChannelsBuffer, BufferLength); end; class function TPCANBasic.SetValue(Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PLongWord; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_SetValue(Channel, Parameter, NumericBuffer, BufferLength); end; class function TPCANBasic.SetValue(Channel: TPCANHandle; Parameter: TPCANParameter; NumericBuffer: PUInt64; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_SetValue(Channel, Parameter, NumericBuffer, BufferLength); end; class function TPCANBasic.SetValue(Channel: TPCANHandle; Parameter: TPCANParameter; StringBuffer: PAnsiChar; BufferLength: LongWord): TPCANStatus; begin Result:= CAN_SetValue(Channel, Parameter, StringBuffer, BufferLength); end; class function TPCANBasic.GetErrorText(Error: TPCANStatus; Language: Word; StringBuffer: PAnsiChar): TPCANStatus; begin Result:= CAN_GetErrorText(Error, Language, StringBuffer); end; class function TPCANBasic.LookUpChannel(Parameters: PAnsiChar; FoundChannel: PTPCANHandle): TPCANStatus; begin Result:= CAN_LookUpChannel(Parameters, FoundChannel); end; end.