The platform describes which ECUs and services that exist and how they communicate, see docs
No Additional PropertiesPlatform files to include (.platform.yaml or .arxml)
No Additional ItemsDefines the channels that are available in the platform. This is a map of channel names to channel definitions.
Each additional property must conform to the following schema
Type: object"ethernet"
Signal database for this channel
Defines which SOME/IP service instances are available. This is a map of service instance names to service instance definitions.
No Additional PropertiesMulticast socket for SOME/IP-SD communication
Each additional property must conform to the following schema
Type: objectAll available network endpoints
Each additional property must conform to the following schema
Type: objectNetwork endpoint IP address
Available sockets endpoints
Each additional property must conform to the following schema
Type: objectPort number
Ethernet PDU connections to other endpoints
No Additional ItemsSOME/IP service instances provided at this endpoint
No Additional ItemsSOME/IP service instances consumed from this endpoint
No Additional Items"can"
CANFD Bit Rate Switching
Signal database for this channel
"lin"
Signal database for this channel
Signal database for this channel
Defines the ECUs that are available in the platform. This is a map of ecu names to ECU definitions.
Each additional property must conform to the following schema
Type: objectECU extract signal database. Overrides signal database from channel
Use this to combine ECUs with different names into a single ECU
Describes which channels the ECU is connected to and details about those connections. This is a map of channel names to channel definitions.
Each additional property must conform to the following schema
"can"
"ethernet"
IP address for the ECU
List of network endpoints that the ECU provides
MAC address for the ECU
"lin"
In order to run a topology you need create an instance that describes what parts of the platform you want to run in your virtual environment, see docs
No Additional PropertiesOptional name of the topology instance
Instance files to include (.instance.yaml)
No Additional ItemsCustom containers that are part of the topology and have access to RemotiveBroker and can therefore interact with ECUs in the topology. A common usecase is to run testcase.
Each additional property must conform to the following schema
Type: objectPath to dockerfile
Path to context for building dockerfile
Target stage in multi-stage Dockerfile (only used with dockerfile)
Optional build arguments for docker container
No Additional ItemsDocker profiles
No Additional ItemsDocker image to use
Working directory inside container
Command to execute in container
Force a specific platform, eg linux/amd64
Whether to include the control network in the container configuration, defaults to true
List of port mappings
No Additional ItemsExtra hosts to add to the container, in the format 'host:ip'
No Additional ItemsEnvironment variables
No Additional ItemsList of containers that this container depends on
No Additional ItemsVolume mappings using short syntax, see https://docs.docker.com/reference/compose-file/services/#short-syntax-5
No Additional ItemsAdd container capabilities
No Additional ItemsDevices to be mapped to the container
No Additional ItemsWhich channels to instantiate and how. This is a map of channel names to channel instantiations.
Each additional property must conform to the following schema
Type: object"ethernet"
Use macvlan to connect physical ethernet device
Specific value:"macvlan"
Physical device name on the host
Use remotivebus to connect physical ethernet device
Specific value:"remotivebus"
Name inside of the docker container. Will be suffixed with a "0"
Must match regular expression:^[a-z0-9-]{1,14}$
The name of the bridge device on the host, will default to the cluster name.
Must match regular expression:^[a-z0-9-]{1,15}$
Optional list of physical ethernet devices to connect the vlan to
Must contain a minimum of 1 items
^[a-z0-9-]{1,15}$
Use ipvlan to connect physical ethernet device
Specific value:"ipvlan"
Physical device name on the host
Docker bridge network is the default
Specific value:"bridge"
Optional name of the linux network bridge
Use an existing docker network
Specific value:"external"
Name of an already existing docker network
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.
"selection"
Tap type: 'socket' taps at the socket level. More tap types may be added in the future.
Tap mode: 'all' taps all sockets, 'selection' taps only listed sockets, 'none' disables tap
List of socket names. Only used when mode is 'selection'.
No Additional ItemsExperimental LIN support
Specific value:"lin"
Use RemotiveBus driver for CAN traffic
Specific value:"remotivebus"
Socketcan to map to physical device on host
No Additional PropertiesRun socketcan connected to a hardware interface
Specific value:"can"
Name inside of the docker container. Will be suffixed with a "0"
Must match regular expression:^[a-z0-9-]{1,13}$
Optional name of host interface to connect to. Will default to {device}.
Must match regular expression:^[a-z0-9-]{1,14}$
Virtual CAN for container<->container and container<->host communication
No Additional PropertiesRun virtual can
Specific value:"vcan"
Name inside of the docker container. Will be suffixed with a "0"
Must match regular expression:^[a-z0-9-]{1,13}$
Optional name of host interface to connect to. Will default to 'v{device}'.
Must match regular expression:^[a-z0-9-]{1,14}$
Optional RemotiveBus plugin section
The name of the RemotiveBus plugin driver
Each additional property must conform to the following schema
Type: string, number or booleanUse socketcan with RemotiveLabs dockercan driver
Specific value:"dockercan"
Physical hardware device name on the host
Must match regular expression:^[a-z0-9-]{1,14}$
Optional name of the device inside the docker container
Must match regular expression:^[a-z0-9-]{1,13}$
Emulate CAN using UDP
Specific value:"udp"
Optional port number to use
Optional subnet to use
Optional multicast address to use
"can"
Which ECUs to instantiate and how. This is a map of ECU names to ECU instantiations.
Each additional property must conform to the following schema
Type: objectDescribes which channels should be instantiated for the ECU and details about those connections. By default all channels are instantiated. This is a map of channel names to channel definitions.
Each additional property must conform to the following schema
Optionally restrict what channels the instantiated ECU should be connected to
"can"
"ethernet"
Optionally limit what SOME/IP services should be instantiated
No Additional PropertiesOptionally limit what provided SOME/IP services should be instantiated
No Additional ItemsOptionally limit what SOME/IP services should be consumed
No Additional ItemsOptionally specify what socket endpoints to instantiate
No Additional Items"lin"
Use null to indicate that the channel should be instantiated without any specific configuration.
External ECU not managed by topology
Optional mock used to automatically send and receive messages
No Additional PropertiesChannels that should be included in the mock. By default all channels are included. This is a map of channel names to null. This allows the mock defintion to be very similar to a model defintion.
Each additional property must conform to the following schema
Type: nullModels that implement ECU behavior. This is a map of model names to model definitions.
Each additional property must conform to the following schema
Behavioral model using a container. This is the preferred way to define a model.
No Additional Properties"container"
[Deprecated] Python behavioral model, use container instead.
No Additional Properties"python"
Main python module to run
Files to be included in the container, must include your python code as module
Global settings for the instance
No Additional PropertiesPath to recordings
Global setting of what docker registry to fetch images from. Will be used unless images already have registry path provided.
Optional path to the LICENSE_FILE
Time in seconds to wait for broker to start
Optional dockerimage to use, will override version. Use this if you have a custom build of RemotiveBroker or want to specify a custom docker registry or mirror.
Optional RemotiveBroker version, but recommended to specify to ensure consistent behavior.
Port number forwarded from host to API
Optional dockerimage to use, will override version. Use this if you have a custom build or want to specify a custom docker registry or mirror.
Optional RemotiveWebapp version
Port number forwarded from host to UI
Docker profile to use for the UI
Settings for experimental LIN support
No Additional PropertiesChannels configuration for the TopologyBroker to override defaults. This is a map of channel names to channel definitions.
Each additional property must conform to the following schema
Type: objectOptional signal database to use for the TopologyBroker. Make sure it includes all frames.