vcan API USER GUIDE v1.0 Date : 18th December 2016

Transcription

1 vcan API USER GUIDE v1.0 Date : 18 th December 2016

2 Chapter 1. Overview The vcan CAN Bus Analyzer API (Application Programming Interface) is designed to allow the vcan CAN BUS analyzer devices to be easily integrated into any Windows program written in a high level language. Examples are provided with the API written in C & Visual Basic. On Windows, the core components of the API are the vcan_api.dll & vcan_usb.dll dynamic link libraries. The vcan API.dll contains all the API functions necessary to communicate with the vcan CAN Bus device via the vcan_usb.dll. The vcan_usb.dll contains the interface between the vcan_api.dll & the vcan CAN Bus driver. Both DLLs must be present in the project directory. The SDK contains both 32 & 64 bit versions of the vcan_api DLLs. The vcan_api DLLs & the USB driver are designed to operate with Microsoft Windows XP, Vista, 7, 8,8.1 & 10. Application vcan_api.dll vcan_usb.dll vcan windows USB driver The vcan CAN Bus devices are all software compatible from the perspective of the API. The descriptions of the API functions in the next section describe the various features of the vcan CAN BUS Analyzer devices.

3 Chapter 2. vcan CAN BUS Analyzer API The various APIs provided by vcan_api.dll are described in this section vcan_connectdevice(): This API will help the device to get connected with the PC through USB and internally initialize the reader USB endpoint and writer USB end point. vcan_disconnectdevice() This API will close the USB port, stop the reader end point and writer endpoint and hence stop all communication with the device. vcan_gethardwareversion() This API is used to read the hardware version number of the connected vcan device. String (indicating the HW version)

4 vcan_getfirmwareversion() This API is used to read the firmware version number of the connected vcan device. String (indicating the FW version) vcan_setbaudrate_250kbps() This API can be used to set the CAN baud rate to 250Kbps in the vcan device vcan_setbaudrate_500kbps() This API can be used to set the CAN baud rate to 500Kbps in the vcan device vcan_setbaudrate_1000kbps() This API can be used to set the CAN baud rate to 1000Kbps in the vcan device

5 vcan_set_operatingmode_normal() This API can be used to set the device operating mode to NORMAL mode in the vcan device vcan_set_operatingmode_listen_only() This API can be used to set the device operating mode to LISTENONLY (SILENT) mode in the vcan device vcan_set_operatingmode_loopback() This API can be used to set the device operating mode to LOOPBACK mode in the vcan device vcan_transmit_msg_11bit_data_frame() This API can be used to transmit a CAN data frame of 11bit type from the vcan device out into the CAN bus byte messagenumber, uint MessageId, byte DLC, byte[] ActualData [NOTE : messagenumber is the index to the data table used inside the device memory. This can be from 1 to 50]

6 vcan_transmit_msg_29bit_data_frame() This API can be used to transmit a CAN data frame of 29bit type from the vcan device out into the CAN bus byte messagenumber, uint MessageId, byte DLC, byte[] ActualData [NOTE : messagenumber is the index to the data table used inside the device memory. This can be from 1 to 50] vcan_transmit_msg_11bit_remote_frame() This API can be used to transmit a CAN remote frame of 11bit type from the vcan device out into the CAN bus byte messagenumber, uint MessageId, byte DLC, byte[] ActualData [NOTE : messagenumber is the index to the data table used inside the device memory. This can be from 1 to 50] vcan_transmit_msg_29bit_remote_frame() This API can be used to transmit a CAN remote frame of 29bit type from the vcan device out into the CAN bus byte messagenumber, uint MessageId, byte DLC, byte[] ActualData [NOTE : messagenumber is the index to the data table used inside the device memory. This can be from 1 to 50]

7 vcan_receive_msg() This API can be used to collect the CAN message received by the device from the CAN bus. Byte [] - Byte array of 20 bytes Byte0 = 0(11bit type) or 4(29bit type) Byte1,2,3,4 = message ID (byte1 is MSB, byte4 is LSB) Byte5 = 0( Data Frame Type), 2(Remote Frame type) Byte6 = DLC Byte7 = D1 (CAN data first byte) Byte8 = D2 Byte9 = D3 Byte10 = D4 Byte11 = D5 Byte12 = D6 Byte13 = D7 Byte14 = D8 (CAN data last byte) Byte15,16,17,18 = Time Stamp (byte15 is LSB, byte18 is MSB) Byte19 = Direction (0xcc is TX message, 0xaa is RX message & 0xee is ERROR message) vcansetfilternone() This API can be used to set the CAN filters to NONE in the vcan device vcansetfilterall_11bit() This API can be used to set the CAN filters to all 11bit type in the vcan device

8 vcansetfilterall_29bit() This API can be used to set the CAN filters to all 29bit type in the vcan device SetCustomFilter_11bit() This API can be used to set the CAN filters to custom 11bit type in the vcan device uint MaskId, uint Filter1, uint Filter2, uint Filter3 SetCustomFilter_29bit() This API can be used to set the CAN filters to custom 29bit type in the vcan device uint MaskId, uint Filter1, uint Filter2, uint Filter3

9 Chapter 3. vcan API DEMO GUI: This section illustrates how the above APIs are used to build a sample Demo GUI. Fig 3.0 Demo SETUP Generated with the help of vcan API.Dll And vcan USB.Dll Fig3.1 Device is not connected and Demo GUI is showing Error message.

10 Fig 3.2. This is the callback of Connect button to connect the device. Fig 3.3. This is the callback of Disconnect button to disconnect the device.

11 Fig 3.4 Demo GUI is working fine with the help of API DLL files. Fig 3.5 Loop back callback image. Fig3.6 Listen only callback image.

12 Fig.3.7 Normal operating callback Mode Image. Fig bit Transmit data frame message callback Image Fig and 29 bit Transmit test data frame callback Image Copyright