RemotiveBroker configuration

Type: object

JSON configuration file for RemotiveBroker. A configuration file must be named interfaces.json. Configures all interfaces that the broker will operate on.

root node_name
Type: string

Name of the RemotiveBroker node. Required only if the configuration is used in the distributed broker mode.

root chains
Type: array

List of configured interfaces available to RemotiveBroker.

 No Additional Items

Each item of this array must be:

root chains chains items

root chains chains items oneOf Virtual

Virtual

Type: object

Virtual signaling interface. This device doesn't use a database, any published signals will be sent to subscribers of the given signal.

root chains chains items oneOf Virtual namespace
Type: string

Name assigned to device, used in signal operations.

root chains chains items oneOf Virtual type
Type: enum (of string) Default: "virtual"

Specifies a virtual interface.

Must be one of:

  • "virtual"
root chains chains items oneOf CAN

CAN

Type: object

CAN interface.

root chains chains items oneOf CAN database
Type: string

Path to signal database file. Supporting .dbc and .arxml. When using an arxml database one should specify canphysicalchannel_name.

root chains chains items oneOf CAN can_physical_channel_name
Type: string

This property is required when using an arxml database. Path to the physical channel that should be used. Referenced by SHORT-NAME element, e.g. /Topology/Name/ID

root chains chains items oneOf CAN device_name
Type: string

Name of device in OS.

root chains chains items oneOf CAN namespace
Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

root chains chains items oneOf CAN short_names
Type: boolean Default: true

Have signals addressable in the RemotiveBroker by their name in the database.
If false, signal names with be generated base on their respective name space.

root chains chains items oneOf CAN type
Type: enum (of string) Default: "can"

Specifies a CAN interface.

Must be one of:

  • "can"

root chains chains items oneOf CAN baud_rate
Type: integer

baud rate to apply to CAN when starting interface.
root chains chains items oneOf CAN-FD

CAN-FD

Type: object

CAN-FD interface.

root chains chains items oneOf CAN-FD database
Type: string

Path to signal database file. Supporting .dbc and .arxml. When using an arxml database one should specify canphysicalchannel_name.

Same definition as database

root chains chains items oneOf CAN-FD can_physical_channel_name
Type: string

This property is required when using an arxml database. Path to the physical channel that should be used. Referenced by SHORT-NAME element, e.g. /Topology/Name/ID

Same definition as can_physical_channel_name

root chains chains items oneOf CAN-FD device_name
Type: string

Name of device in OS.

root chains chains items oneOf CAN-FD namespace
Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

root chains chains items oneOf CAN-FD short_names
Type: boolean Default: true

Have signals addressable in the RemotiveBroker by their name in the database.
If false, signal names with be generated base on their respective name space.

Same definition as short_names

root chains chains items oneOf CAN-FD type
Type: enum (of string) Default: "canfd"

Specifies a CAN-FD interface.

Must be one of:

  • "canfd"

root chains chains items oneOf CAN-FD baud_rate
Type: integer

baud rate to apply to CAN when starting interface.

root chains chains items oneOf CAN-FD dbaud_rate
Type: integer

baud rate to apply to CAN-FD when starting interface.
root chains chains items oneOf UDP

UDP

Type: object

Internal RemotiveLabs protocol for UPD communication over network. Can be used to communicate between RemotiveBrokers.

root chains chains items oneOf UDP database
Type: string

Path to signal database.

Same definition as database

root chains chains items oneOf UDP fixed_payload_size
Type: integer

If set, will use this frame size (bytes) for all packets.

Value must be greater or equal to 0

root chains chains items oneOf UDP namespace
Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

root chains chains items oneOf UDP server_port
Type: integer

UDP port for RemotiveBroker to listen to and receive packets on.

Value must be greater or equal to 0 and lesser or equal to 65535

root chains chains items oneOf UDP short_names
Type: boolean Default: true

Have signals addressable in the RemotiveBroker by their name in the database.
If false, signal names with be generated base on their respective name space.

Same definition as short_names

root chains chains items oneOf UDP target_host
Type: string

Network address accepted by the OS. Eg. Ipv4: "127.0.0.1".

root chains chains items oneOf UDP target_port
Type: integer

UDP port for RemotiveBroker to send packets to.

Same definition as server_port

root chains chains items oneOf UDP type
Type: enum (of string) Default: "udp"

Sets the device type to UDP

Must be one of:

  • "udp"
root chains chains items oneOf LIN

LIN

Type: object

LIN master or slave node interface. Connects to a RemotiveLabs LIN ethernet device.

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root chains chains items oneOf LIN if
Type: object

root chains chains items oneOf LIN if node_mode
Type: const
Specific value: "master"
root chains chains items oneOf LIN then
Type: object

The following properties are required:

  • schedule_file
  • schedule_table_name
  • schedule_autostart

root chains chains items oneOf LIN config
Type: object

LIN network configuration for communicating with RemotiveLabs LIN service.

root chains chains items oneOf LIN config device_identifier
Type: integer

LIN node ID.

Value must be greater or equal to 0 and lesser or equal to 16

root chains chains items oneOf LIN config server_port
Type: integer

Port for receiving LIN connection to RemotiveBroker.

Same definition as server_port

root chains chains items oneOf LIN config target_host
Type: string

Network address accepted by the OS. Eg. Ipv4: "127.0.0.1".

Same definition as target_host

root chains chains items oneOf LIN database
Type: string

Path to LIN signal database .ldf file.

Same definition as database

root chains chains items oneOf LIN namespace
Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

root chains chains items oneOf LIN node_mode
Type: enum (of string)

Type of LIN node.

Must be one of:

  • "master"
  • "slave"

root chains chains items oneOf LIN schedule_autostart
Type: boolean

Should LIN schedules start at boot? Or paus until user command.

root chains chains items oneOf LIN schedule_file
Type: string

Path to .ldf file used for schedules.

root chains chains items oneOf LIN schedule_table_name
Type: string

Path to .ldf file used for tables. TODO

root chains chains items oneOf LIN type
Type: enum (of string) Default: "lin"

Sets the device type to LIN

Must be one of:

  • "lin"
root chains chains items oneOf Flexray

Flexray

Type: object

Flexray interface.

root chains chains items oneOf Flexray config

root chains chains items oneOf Flexray config oneOf Software adapter

Software adapter

Type: object

RemotiveLabs software adapter.

root chains chains items oneOf Flexray config oneOf Software adapter target_host
Type: string

Network address accepted by the OS. Eg. Ipv4: "127.0.0.1".

Same definition as target_host
root chains chains items oneOf Flexray config oneOf Technica

Technica

Type: object

Technica CAN combo hardware.

root chains chains items oneOf Flexray config oneOf Technica hardware
Type: enum (of string) Default: "Technica_CM_CAN_COMBO"

What type of hardware.

Must be one of:

  • "Technica_CM_CAN_COMBO"

root chains chains items oneOf Flexray config oneOf Technica target_host
Type: string

Network address accepted by the OS. Eg. Ipv4: "127.0.0.1".

Same definition as target_host

root chains chains items oneOf Flexray database
Type: string

Path to Flexray signal database .xml file.

Same definition as database

root chains chains items oneOf Flexray fibex_file
Type: string

This property is deprecated, use database instead.

Same definition as database

root chains chains items oneOf Flexray namespace
Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

root chains chains items oneOf Flexray type
Type: enum (of string) Default: "flexray"

Sets the device type to Flexray

Must be one of:

  • "flexray"

root grpc_server
Type: object

Configuration for build in gRPC server. Documentation for available service is available on https://docs.remotivelabs.com.

root grpc_server port
Type: integer

Server port for gRPC server.

Value must be greater or equal to 0 and lesser or equal to 65535

root reflectors
Type: array of object

A list of reflector configurations.

 No Additional Items

Each item of this array must be:

root reflectors reflectors items
Type: object

root reflectors reflectors items reflect
Type: array of object

Configure reflectors to always bounce traffic.

 No Additional Items

Each item of this array must be:

root reflectors reflectors items reflect reflect items
Type: object

Bounce mechanism, with a source and a destination.

root reflectors reflectors items reflect reflect items source
Type: string

Name of source namespace.

root reflectors reflectors items reflect reflect items dest
Type: string

Name of destination namespace.

root reflectors reflectors items reflect reflect items exclude
Type: array of string
No Additional Items

Each item of this array must be:

root reflectors reflectors items reflect reflect items exclude exclude items
Type: string

Name of frame to exclude