Transmit
This page documents the transmit configuration.
Table of Contents
Configuration file fields
This section is autogenerated from the Rule Schema file.
Transmit messages can.transmit
List of CAN bus messages transmitted by the device. Requires a CAN-bus physical mode supporting transmissions.
Type |
Max items |
|---|---|
array |
64 |
Item can.transmit.item
Name can.transmit.item.name
Optional transmit message name.
Type |
Max length |
|---|---|
string |
16 |
State can.transmit.item.state
Disabled transmit messages are ignored.
Type |
Default |
Options |
|---|---|---|
integer |
1 |
Disable: |
ID Format can.transmit.item.id_format
ID format of the transmit message.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Standard (11-bit): |
Frame format can.transmit.item.frame_format
Frame format of the transmit message.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Standard: |
Bit-Rate Switch can.transmit.item.brs
Determines if an FD message is transmitted using a switched bit-rate.
Type |
Default |
|---|---|
integer |
0 |
Include in log can.transmit.item.log
Determines if the transmitted message is included in the log file.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Disable: |
Period (10 ms steps) can.transmit.item.period
Time period of the message transmission. 0: single shot, >0: periodic. Unit is ms.
Type |
Minimum |
Maximum |
Multiple of |
|---|---|---|---|
integer |
0 |
4294967290 |
10 |
Delay (10 ms steps) can.transmit.item.delay
Offset message within the period or delay a single shot message. If multiple messages are transmitted by the device, it is recommended to offset each separately to reduce peak load on bus. If period > 0, delay < period. If single-shot, delay can be up to max value. Unit is ms.
Type |
Minimum |
Maximum |
Multiple of |
|---|---|---|---|
integer |
0 |
4294967290 |
10 |
Message ID (hex) can.transmit.item.id
ID of message to transmit in hex. Example: 1FF.
Type |
|---|
string |
Messages Data (hex) can.transmit.item.data
Data bytes of message to transmit. RTR frames only use the number of bytes do determine the DLC. Example: 01020304 or 0102030405060708.
Type |
Max length |
|---|---|
string |
128 |
Configuration explained
This section contains additional information and examples.
Period and delay
If multiple transmit messages are defined, it is recommended to spread them in time by using delay. It may not be possible to transmit all messages if they are to be transmitted simultaneously.