Protocol Documentation

Identifier as string

Profile.

Data ID for CRC calculation.

Name of signal for CRC field.

Name of signal for counter field.

Information about the frame itself.

Information about signals included in frame.

List of information about frames.

Byte offset in frame for group.

Byte length of group.

E2E property for group.

Description for signal.

Maximum allowed value.

Minimum allowed value.

Unit of the signal value.

Size of signal value when packed in frame.

Is binary data?

Multiplication faction used for encoding and decoding value in frame.

Offset used for encoding and decoding value in frame.

List of named senders of signals.

List of named receivers of signal.

Cadence for sending signal in milliseconds.

Initial value to use before publishing.

Frame multiplexing information.

E2e information about frame.

Groups inside frame.

Associated identification number for frame.

Key-value dictionary of named values.

Signal start bit in frame

Name of name space, which in turn is typically redirected in interfaces.json to an electrical interface.

Corresponding name space.

Type of network as text. Eg "can", "lin" etc.

Description text about network.

Name of signal.

Which name space signal belongs in.

Server-side timeout (in milliseconds) for downloading a chunk. The timeout is for each chunk, not the entire file. If the timeout is exceeded, the server will cancel the download and return an error.

Amount of chunks.

Index of this chunk. Start with 0.

Chunk data.

Estimated total size in bytes.

Network information.

Server configuration file `interfaces.json`.

IP address of server.

Version of RemotiveBroker.

Contains configuration file deprecation warnings, validation errors and similar

Directory for shared RemotiveLabs configuration including authentication

Identifier for configuration file `interfaces.json`

Identifier for topology instance that was used to generate the configuration for this RemotiveBroker

Identifier for when the topology instance was generated

File checksum.

File (path and filename) on server.

File content.

Error with reason.

What file this chunk is for.

Amount of chunks.

Index of this chunk. Start with 0.

Chunk data.

Cancel upload request.

Server side timeout (ms) for uploading all chunks which represents full file.

Information about file to upload.

Amount of chunks that will be sent for this file.

Upload completed.

Upload canceled.

Error with reason.

Content of license.

Check if user accepted user agreement.

Status of license.

Verbatim json from the license data if BASE64-decodable.

Extracted from json for convenience.

Info to use when requesting a new license.

Identifier for machine running server.

LIN namespace to switch schedule for

Name of the schedule table to activate

Example name: "secoc_key", "secoc_fv"

Example input: [<namespace>, <keyId>] or [<namespace>, <profile>]

New configuration from successfully reload operation.

Response from failed reload operation.

Name of the namespace from which we wish to subscribe to frames distributions.

Signals with values.

Specify frequency of publication. Specify 0 to only publish once.

Identifier of signal to publish.

Value with integer type (int64).

Floating point data type (double).

Exclusive for LIN bus, present as true when a header is presented on the bus.

No data supplied.

(Supports publishing signals with named values or raw signals. / - If the signal has named values, the provided value must exactly match a defined name (case-sensitive). / - For raw signals, the provided value can be any string.)

Unsigned 64-bit integer value.

Binary data of value, relevant for Frames.

time stamp in micro seconds, set when first seen.

List of signal identifiers.

List of signals with values.

Identifier of subscriber, typically your app identifier. Published signals with same identifier will not trigger callback.

List of signals in subscription.

Only trigger callback when value changes when set to true.

Will trigger an initial empty response once the subscription is ready

Identifier of subscriber, typically your app identifier. Published signals with same identifier will not trigger callback.

Custom Lua mapping code

Only trigger callback when value changes when set to true.

clientId will be used by the Restbus when as source of the outgoing signals

startOption affects all frames in the namespace

The cycle time of the frame in milliseconds. Setting cycle time 0 will make the broker use the default cycle time of the frame Cycle time must be greater than 0, otherwise the frame is ignored by the Restbus

The loop to be emitted in the sequence.

The initial values to be emitted before the loop is iterated.

File information.

Name space associated.

File and name space information.

Current mode.

List of all information.

Error reason.

End of file; playback finished

Active with mode.

Current offset in micro seconds.

Start time in monotonic micro seconds.

End time in monotonic micro seconds.

Time deviation in micro seconds, measured by server.

Signal and wall clock offset. Signals might have a seperate timestamp.

Allows disabling of data flow from recording to application layers. Default is set to false.

Let data to be replayed to the bus specified in intefaces.json. Defalt set to false.

Channel name.

The namespace to use for channel.

File information.

Type of file.

Creation time in seconds since epoch.

Modification time in seconds since epoch.

Size of file in bytes.

Path to list files from, empty for root.

Type of file.

List of files.

At which offset (in micro seconds) repeat should start.

At which offset (in micro seconds) repeat should go back to starting offset.

File information.

File information.

Optional channel to namespace mappings to override default behavior.

Will close any opened session for the same path and open a new one.

File information.

Optional offset in micro seconds.

File information.

Optional offset in micro seconds.

File information.

Current playback mode.

Current offset in micro seconds.

Current repeat information (optional).

File information.

At which offset (in micro seconds) repeat should start. Omit to start at the beginning of the file.

At which offset (in micro seconds) repeat should go back to starting offset. Omit to repeat until the end of the file.

File information.

Offset in micro seconds.

Identifier of subscriber, typically your app identifier. Published signals with same identifier will not trigger callback.

Uplink for intended target This is optional for SubscribeMultiFrame, not setting this will effectively result in sniff_mode, where no control frames are sent. / Uplink for intended target

Downlink where response is expected

Max milliseconds waiting flow control or single frame before throwing maxRespTimeoutError. Defaults to 1000. Equivavlent to (N_As + N_Bs according to ISO-15765-2) for sender. Equivavlent to (N_Ar + N_Cr according to ISO-15765-2) for receiver.

Enables testing of maxResponseTimeout by delaying millieseconds before responding to: received flow control with consecutive frame for sender (N_Cs according to ISO-15765-2). received first frame with flow control for receiver (N_Br according to ISO-15765-2). Defaults to 0.

LinkTimers currently not supported *

Used for padding outgoing requests, this is optional. Set to true to remove padding.

LinkTimers currently not supported *

Specify if the payload should be retured raw or decoded. Setting this to true will provide the raw repsonce without stipped headers and counters. Defaults to false.

Used for padding outgoing requests, this is optional. Set to true to remove padding.