interfaces_referense.json

{
  "chains": [
    {
      "_comment_short_names": [
        "Advanced, optional",
        "To generate long, names as in frame.signal"
      ],
      "short_names": false,
      "_comment_time_stamps": [
        "Advanced, optional",
        "Use timestamps provided by transceiver, currently only supported for type",
        "Flexray"
      ],
      "time_stamp": "hardware"
    },
    {
      "_comment": [
        "Vanilla can interface"
      ],
      "type": "can",
      "namespace": "PhysicalCanInterface",
      "device_name": "can0",
      "dbc_file|database": "can_files/can_one.dbc"
    },
    {
      "_comment": [
        "Extended can interface",
        "Use 29-bit CAN identifiers"
      ],
      "type": "can",
      "namespace": "PhysicalCanInterface",
      "device_name": "can0",
      "extended": true,
      "dbc_file|database": "can_files/can_one.dbc"
    },
    {
      "_comment": [
        "Vanilla CAN-FD interface"
      ],
      "type": "canfd",
      "namespace": "PhysicalCanFDInterface",
      "device_name": "can1",
      "dbc_file|database": "can_files/canfd_one.dbc"
    },
    {
      "_comment": [
        "Vanilla VCAN interface supported by Linux"
      ],
      "type": "virtual",
      "namespace": "VCanInterface",
      "device_name": "vcan1",
      "dbc_file|database": "can_files/can_one.dbc"
    },
    {
      "_comment": [
        "Vanilla CAN-FD interface",
        "Useful for communicating between apps, use unique client_id in each client to prevent signal bouncing",
        "as in getting echo of owned signal"
      ],
      "device_name": "virtual",
      "namespace": "VirtualInterface",
      "type": "virtual"
    },
    {
      "_comment": [
        "can interface without recover",
        "to prevent CAN interface from restarting after ERROR_PASSIVE mode"
      ],
      "type": "can",
      "namespace": "PhysicalCanInterface",
      "device_name": "can0",
      "auto_recover": false,
      "dbc_file|database": "can_files/can_one.dbc"
    },
    {
      "_comment": [
        "UDP interface can be paired with a .ldf, .fibex for .dbc file"
      ],
      "namespace": "UDPCanInterface",
      "type": "udp",
      "dbc_file|database": "can_files/can_three.dbc",
      "device_name": "udp2",
      "server_port": 2001,
      "target_host": "127.0.0.1",
      "target_port": 2000
    },
    {
      "_comment": [
        "LIN node configured with DHCP IP"
      ],
      "namespace": "LinSlave",
      "type": "lin",
      "config": {
        "device_identifier": 1,
        "server_port": 2014,
        "target_port": 2013
      },
      "node_mode": "slave",
      "ldf_file|database": "ldf_files/lin_one.ldf",
      "schedule_autostart": false
    },
    {
      "_comment": [
        "LIN node configured with STATIC IP"
      ],
      "__comment_node_id": [
        "Advanced, optional",
        "Node_id needs to exist in Node_attributes list, used to specify NAD for LIN node"
      ],
      "namespace": "LinSlave",
      "type": "lin",
      "config": {
        "device_identifier": 1,
        "target_host": "192.168.1.20",
        "server_port": 2014,
        "target_port": 2013
      },
      "node_mode": "slave",
      "node_id": "node_id",
      "ldf_file|database": "ldf_files/lin_one.ldf",
      "schedule_autostart": false
    },
    {
      "namespace": "LinMaster",
      "type": "lin",
      "config": {
        "device_identifier": 2,
        "server_port": 2015,
        "target_port": 2016
      },
      "node_mode": "master",
      "ldf_file|database": "ldf_files/lin_one.ldf",
      "schedule_file": "ldf_files/lin_one.ldf",
      "schedule_table_name": "linoneSchedule",
      "schedule_autostart": true
    },
    {
      "_comment": [
        "Defaults to MX30 Flexray device."
      ],
      "type": "flexray",
      "device_name": "flexray0",
      "namespace": "FlexrayBackbone",
      "config": {
        "target_host": "127.0.0.1",
        "target_port": 51111
      },
      "fibex_file|database": "fibex_files/flexray.xml"
    },
    {
      "_comment": [
        "Technica CM CAN COMBO support, target_host refers to node running this Teknika binary:",
        "https://github.com/beamylabs/beamylabs-start/tree/master/scripts/technica",
        "target_config (for teknika binary): interface to listen on, multicast frames to catch"
      ],
      "type": "flexray",
      "device_name": "flexray0",
      "namespace": "MyFlexrayNamespace",
      "config": {
        "target_host": "127.0.0.1",
        "target_port": 51111,
        "hardware": "Technica_CM_CAN_COMBO",
        "target_config": {
          "interface": "eth0",
          "multicast": "01:00:5e:00:00:00"
        }
      },
      "fibex_file|database": "fibex_files/flexray.xml"
    }
  ],
  "gateway": {
    "_comment": [
      "Used for Telnet interface, optional section, defaults as shown below"
    ],
    "tcp_socket_port": 4040
  },
  "auto_config_boot_server": {
    "_comment": [
      "Configuration ports for LIN transceivers, optional section, defaults as shown below"
    ],
    "target_port": 4000,
    "server_port": 4001
  },
  "grpc_server": {
    "_comment": [
      "gPRC port used, optional section, defaults as shown below"
    ],
    "port": 50051
  },
  "reflectors": [
    {
      "_comment": [
          "Optional section. Default off"
      ],
      "reflect": [
        {
          "_comment": [
            "Send all data from source namespace to dest, exclude specific frames",
            "Both networks need to be of type can|canfd|udp"
          ],
          "source": "PhysicalCanInterface",
          "dest": "VCanInterface",
          "exclude": []
        },
        {
          "_comment": [
            "Send all data from source namespace to dest, exclude specific frames.",
            "Both networks need to be of type can|canfd|udp"
          ],
          "source": "VCanInterface",
          "dest": "PhysicalCanInterface",
          "exclude": [
            "FrameA",
            "FrameB"
          ]
        }
      ]
    }
  ]
}