RemotiveBroker configuration

Type: object

JSON configuration file for RemotiveBroker. The configuration file must be named interfaces.json and all paths in the configuration are relative paths to this file.
Configures all interfaces that the broker will operate on.

Type: array

List of configured interfaces available to RemotiveBroker.

No Additional Items

Each item of this array must be:


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.

Type: string

Name assigned to device, used in signal operations.

Type: enum (of string) Default: "virtual"

Specifies a virtual interface.

Must be one of:

  • "virtual"

Scripted

Type: object

Scripted signals

Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

Type: enum (of string) Default: "scripted"

Specifies a scripted interface.

Must be one of:

  • "scripted"

Type: string

Path to a scripted database

Type: boolean Default: true

Configure the interface to be public or private, default is public. Private namespaces are not exposed by the broker. This is useful for example when working with for example scripted VSS signals and you don't want the designer to see the internal vehicle signals.

CAN

Type: object

CAN interface.

Type: string

Path to signal database file. Supporting .dbc and .arxml. When using an arxml database, canphysicalchannel_name must be specified.

Same definition as database

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

Type: string

Name of device in OS.

Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

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.

Type: enum (of string) Default: "can"

Specifies a CAN interface.

Must be one of:

  • "can"

Type: integer

baud rate to apply to CAN when starting interface.

Type: boolean Default: true

Configure the interface to be public or private, default is public. Private namespaces are not exposed by the broker. This is useful for example when working with for example scripted VSS signals and you don't want the designer to see the internal vehicle signals.

Same definition as public

Type: boolean Default: true

Monitor CAN interfaces for state changes to error passive and reset upon detection. Note: Using virtual CAN devices will not support the built-in automatic recovery for CAN devices that enter passive mode. If automatic recovery mode is enabled for a virtual device, the server will issue a warning each time it attempts to retrieve the device's state.

Type: boolean Default: false

Indicate that frames use an extended frame format (EFF) with a 29-bit identifier, as opposed to the standard frame format (SFF) which uses an 11-bit identifier.

CAN-FD

Type: object

CAN-FD interface.

Type: string

Path to signal database file. Supporting .dbc and .arxml. When using an arxml database, canphysicalchannel_name must be specified.

Same definition as database

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

Type: string

Name of device in OS.

Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

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

Type: enum (of string) Default: "canfd"

Specifies a CAN-FD interface.

Must be one of:

  • "canfd"

Type: integer

baud rate to apply to CAN when starting interface.

Type: integer

baud rate to apply to CAN-FD when starting interface.

Type: boolean Default: true

Configure the interface to be public or private, default is public. Private namespaces are not exposed by the broker. This is useful for example when working with for example scripted VSS signals and you don't want the designer to see the internal vehicle signals.

Same definition as public

Type: boolean Default: true

Monitor CAN interfaces for state changes to error passive and reset upon detection. Note: Using virtual CAN devices will not support the built-in automatic recovery for CAN devices that enter passive mode. If automatic recovery mode is enabled for a virtual device, the server will issue a warning each time it attempts to retrieve the device's state.

Same definition as auto_recover

Type: boolean Default: false

Indicate that frames use an extended frame format (EFF) with a 29-bit identifier, as opposed to the standard frame format (SFF) which uses an 11-bit identifier.

Same definition as extended

UDP

Type: object

CAN-via-UDP protocol. Can be used to communicate between RemotiveBrokers.

Type: string

Path to signal database file. Supporting .dbc and .arxml. When using an arxml database, canphysicalchannel_name must be specified.

Same definition as database

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

Type: integer

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

Value must be greater or equal to 0

Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

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

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

Type: string

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

Type: integer

UDP port for RemotiveBroker to send packets to.

Same definition as server_port

Type: enum (of string) Default: "udp"

Specifies a CAN-via-UDP interface.

Must be one of:

  • "udp"

Type: boolean Default: true

Configure the interface to be public or private, default is public. Private namespaces are not exposed by the broker. This is useful for example when working with for example scripted VSS signals and you don't want the designer to see the internal vehicle signals.

Same definition as public

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.

Type: object

Type: const
Specific value: "master"
Type: object

The following properties are required:

  • schedule_file
  • schedule_table_name
  • schedule_autostart

Type: object

LIN network configuration for communicating with RemotiveLabs LIN service.

Type: integer

LIN node ID.

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

Type: integer

Port for receiving LIN connection to RemotiveBroker.

Same definition as server_port

Type: string

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

Same definition as target_host

Type: string

Path to LIN signal database .ldf file.

Same definition as database

Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

Type: enum (of string)

Type of LIN node.

Must be one of:

  • "master"
  • "slave"

Type: boolean

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

Type: string

Path to .ldf file used for schedules.

Type: string

Path to .ldf file used for tables. TODO

Type: enum (of string) Default: "lin"

Specifies a LIN interface.

Must be one of:

  • "lin"

Type: boolean Default: true

Configure the interface to be public or private, default is public. Private namespaces are not exposed by the broker. This is useful for example when working with for example scripted VSS signals and you don't want the designer to see the internal vehicle signals.

Same definition as public

FlexRay

Type: object

FlexRay interface.


Software adapter

Type: object

RemotiveLabs software adapter.

Type: string

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

Same definition as target_host

Technica

Type: object

Technica CAN combo hardware.

Type: enum (of string) Default: "Technica_CM_CAN_COMBO"

What type of hardware.

Must be one of:

  • "Technica_CM_CAN_COMBO"

Type: object

Type: string

Network interface to use.
For example eth0.

Type: string

MAC address to use for multicast.
For example 01:00:5e:00:00:00.

Type: string

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

Same definition as target_host

Type: string

Path to FlexRay signal database .xml (FIBEX) file.

Same definition as database

Type: string

This property is deprecated, use database instead.

Same definition as database

Type: string

Name assigned to device, used in signal operations.

Same definition as namespace

Type: enum (of string) Default: "flexray"

Specifies a FlexRay interface.

Must be one of:

  • "flexray"

Type: boolean Default: true

Configure the interface to be public or private, default is public. Private namespaces are not exposed by the broker. This is useful for example when working with for example scripted VSS signals and you don't want the designer to see the internal vehicle signals.

Same definition as public

Type: string

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

Type: object

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

Type: integer

Server port for gRPC server.

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

Type: array of object

A list of reflector configurations.

No Additional Items

Each item of this array must be:

Type: object

Type: array of object

Configure reflectors to always bounce traffic.

No Additional Items

Each item of this array must be:

Type: object

Bounce mechanism, with a source and a destination.

Type: string

Name of source namespace.

Type: string

Name of destination namespace.

Type: array of string

List of frames to exclude in reflector.

No Additional Items

Each item of this array must be:

Type: string

Name of frame to exclude