Route
This page documents the route configuration.
The route configuration defines how CAN-bus traffic is routed between the primary and the secondary interfaces.
Configuration file fields
This section is autogenerated from the Rule Schema file.
Routing mode phy.can.route.mode
The routing mode defines how traffic is routed between the primary and the secondary interface.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Mux: |
Mux phy.can.route.mux
Mux mode uses two CAN-bus tunnels to transport data to/from the secondary interfaces.
Output tunnel phy.can.route.mux.output
The output tunnel transports data from the secondary buses.
Filter phy.can.route.mux.output.filter
Filters can be used to disable the transfer of unused data (thereby reducing the load on the primary bus).
RX message phy.can.route.mux.output.filter.rx_msg
Type |
Default |
Options |
|---|---|---|
integer |
1 |
Disable: |
TX acknowledge phy.can.route.mux.output.filter.tx_ack
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Disable: |
Error frame phy.can.route.mux.output.filter.err
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Disable: |
Message phy.can.route.mux.output.message
ID of the message used to transport data.
ID Format phy.can.route.mux.output.message.id_format
Message identifier format.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Standard (11-bit): |
Frame format phy.can.route.mux.output.message.frame_format
Message frame format.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Standard: |
Bit-Rate Switch phy.can.route.mux.output.message.brs
Message data bit-rate-switch (FD only).
Type |
Default |
|---|---|
integer |
0 |
Message ID (hex) phy.can.route.mux.output.message.id
Message identifier. Example: 1FF.
Type |
|---|
string |
Input tunnel phy.can.route.mux.input
The input tunnel transports data to the secondary buses. Add one message ID for each node transporting data to the secondary buses.
Type |
Min items |
Max items |
|---|---|---|
array |
0 |
8 |
Item phy.can.route.mux.input.item
ID Format phy.can.route.mux.input.item.id_format
Message identifier format.
Type |
Default |
Options |
|---|---|---|
integer |
0 |
Standard (11-bit): |
Message ID (hex) phy.can.route.mux.input.item.id
Message identifier. Example: 1FF.
Type |
|---|
string |
Configuration explained
Mode
The mode fields sets the routing mode used.
Note
Currently only mux mode is supported.
Mux-mode
Note
When using a software tool supporting mux-mode, detailed knowledge of the mux-mode is not needed. Find tools supporting mux-mode on csselectronics.com.
In mux-mode, a user (CAN-bus node) connected to the primary bus can communicate with the secondary buses as if directly connected to each bus.
Mux-mode requires one output message ID and one or more[1] input message ID(s) to be able to route traffic between the primary and the secondary buses. The configuration defines the ID and format of the output and one or more input messages.
The following information can be routed from the secondary interfaces (through the output ID):
Messages received
Transmission acknowledgements[2]
Error frames
Note
It is recommended to disable unused output messages types to reduce load on the primary bus.
The input message(s) is used for issuing transmission-requests.
For details on mux-mode, see Mux-mode.