Skip to Content
Documentation03 · Data collectionProtocol pluginsProtocolsCAN / CAN FD master
On this page

CAN / CAN FD master

CAN and CAN FD frame transceiver, filtering and variable mapping driver

Open the plugin

Enter “Development Configuration → Collection Configuration”, create a device and select “CanMaster” in “Collection Plugin”.

Supported channels and data types

Channel typePre-configuration check
Plugin built-in connectionConnection parameters are configured in the device dynamic properties and do not use public TCP, UDP or serial channel parameters.

Optional data types: Boolean, Byte, Int16, UInt16, Int32, UInt32, Int64, UInt64, Float, Double, String, Decimal

This list describes types allowed by the plugin editor. Address width, arrays, string length and read/write restrictions still follow this page; it does not mean that every address supports every type.

Plugin properties

CAN Master opens the bus directly through CanKit; the channel is only used for the common device lifecycle and does not use ordinary TCP, UDP, or serial fields. Configure common timeout, data format, and string-reversal settings through the collection configuration; this page lists CAN-specific fields.

Connection configuration

SettingDescription
Endpoint addressDefault: virtual://alpha/0; fill in: text input. Sets the endpoint address used when establishing connections.

Protocol parameters

SettingDescription
Baud rateDefault: 500000; fill in: digital input. Set the baud rate used for protocol communication.
Data phase baud rateDefault: 2000000; fill in: digital input. Set the data phase baud rate used for protocol communication.
Protocol modeDefault: 1; fill in: drop-down selection. Set the protocol mode used for protocol communication.
Enable BRSDefault: No; fill in: switch. Controls whether the “Enable BRS” function is enabled.
Internal termination resistorDefault: Yes; fill in: switch. Controls whether the “internal termination resistor” function is enabled.
Hardware filter CANID listFill in: Integer list dialog box. Set the hardware filter CANID list used for protocol communication.

Protocol mode options are Can20 (classic CAN) and CanFd (CAN FD). Classic CAN carries at most 8 data bytes; CAN FD carries at most 64. Data-phase bitrate and BRS apply only to CanFd. Enable the internal termination resistor only when the adapter hardware provides it and no external resistor already terminates the bus.

Address rules

  • CAN address format: 0xCANID[.start byte][;R=0x response ID][;L=data length][;E=1(extended frame)]
  • Example: 0x123, 0x123.2, 0x123;R=0x456;L=4;E=1
  • Standard-frame CAN IDs are 0x000–0x7FF; set E=1 for an extended frame, whose ID may be up to 0x1FFFFFFF.
  • The .start byte offset is zero-based. L is the read/write length: 1–8 in classic CAN and 1–64 in CAN FD; bytes beyond the frame are truncated.
  • R= selects the response ID for request/response mode; without it the request ID is matched. An empty FilterCanIds list disables hardware filtering; a non-empty list accepts only those IDs.

Standard and extended frames are matched by both CAN ID and frame format. 0x123 and 0x123;E=1 have the same numeric ID but separate received data and read results. Check the request and response frame formats at both ends. Remote-request and error frames are not variable data.

Device debug

Enter “Development Configuration → Collection Configuration”, select the current device then open “Protocol Debug” at the top of the workspace.

CanMaster: Operations

Debugging notes

Send a test frame by CAN ID, Hexadecimal Data and Extended Frame options on the dedicated page; first verify the filter and response with a frame that does not affect the device.

The Extended Frame selection applies to both reading the latest received frame and sending. If the same numeric ID carries both formats, read each selection separately and compare its payload and format with the bus traffic.

Functions

FunctionPurpose
Read frameReads the latest received data for the CAN ID and Extended Frame selection. This does not send a control frame.
Send frameUse Send frame with an approved test point and confirm site safety before execution.
Debug resultView the returned value, success state, or error message.

Verify the configuration

Send standard data frame 0x123 with payload 2A from a bus test source; expect 42 and compare with a bus analyzer.

Writes and control operations require an approved test point and the site safety procedure.

Troubleshooting

  • If frames exist but reads are empty, check standard/extended format, filter and bitrate. This example uses neither CAN FD/BRS nor remote-request frames.