Core Messages

Entity State

State reported by an entity in the vehicle. The source entity is identified in the message header.

  • Abbreviation: EntityState
  • Identification Number: 1
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
State state Enumerated uint8_t State of entity. Same as field type
Flags flags Bitfield uint8_t Complementary entity state flags. Same as field type
Complementary description description - plaintext Complementary human-readable description of entity state. Same as field type

Query Entity State

Request entities to report their state. Entities should respond by issuing an appropriate EntityState message.

  • Abbreviation: QueryEntityState
  • Identification Number: 2
  • Fixed Payload Size: 0

This message has no fields.

Entity Information

This message describes an entity.

  • Abbreviation: EntityInfo
  • Identification Number: 3
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Entity Identifier id - uint8_t Entity identifier. Same as field type
Label label - plaintext Entity label or empty if the entity id is not valid. Same as field type
Component name component - plaintext Name of the plugin/component/subsystem associated with this entity. Same as field type
Activation Time act_time s uint16_t Amount of time needed to properly activate the entity. Same as field type
Deactivation Time deact_time s uint16_t Amount of time needed to properly deactivate the entity. Same as field type

Query Entity Information

Request information about an entity identifier. The receiving system shall reply with an EntityInfo message with the details of that entity.

  • Abbreviation: QueryEntityInfo
  • Identification Number: 4
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Entity Identifier id - uint8_t Entity identifier. Same as field type

Entity List

This message describes the names and identification numbers of all entities in the system.

  • Abbreviation: EntityList
  • Identification Number: 5
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
operation op Enumerated uint8_t Operation to perform. Same as field type
list list TupleList plaintext Example: “Battery=11;CTD=3” Same as field type

Entity Control

Control the activity of entities.

  • Abbreviation: EntityControl
  • Identification Number: 6
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Operation op Enumerated uint8_t Activate or deactivate an entity. Same as field type

CPU Usage

Report of software CPU usage.

  • Abbreviation: CpuUsage
  • Identification Number: 7
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Usage percentage value % uint8_t The CPU usage, in percentage, of the sending software. Same as field type

Transport Bindings

Message generated when tasks bind to messages.

  • Abbreviation: TransportBindings
  • Identification Number: 8
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Consumer name consumer - plaintext The name of the consumer (e.g. task name). Same as field type
Message Identifier message_id - uint16_t The id of the message to be listened to. Same as field type

Restart System

Request the destination system to restart itself.

  • Abbreviation: RestartSystem
  • Identification Number: 9
  • Fixed Payload Size: 0

This message has no fields.

Parameter

This message gives information about a configuration parameter.

  • Abbreviation: Parameter
  • Identification Number: 10
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Section Name section - plaintext The name of the configuration section. Same as field type
Parameter Name param - plaintext The name of the parameter. Same as field type
Value value - plaintext The current value of the parameter. Same as field type

Parameters Control

This message is used to control the configuration in IMC-compatible systems.

  • Abbreviation: ParameterControl
  • Identification Number: 11
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Operation op Enumerated uint8_t The operation to be done to the configuration is encoded here. Same as field type
Parameters params - message-list The list of parameters to be retrieved / to be set / answered. Parameters are encoded as a list of Parameter messages. Same as field type

Device Calibration Control

This message controls the calibration procedure of a given device. The destination device is selected using the destination entity identification number.

  • Abbreviation: DevCalibrationControl
  • Identification Number: 12
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Operation op Enumerated uint8_t Operation to perform. Same as field type

Device Calibration State

State of the calibration procedure.

  • Abbreviation: DevCalibrationState
  • Identification Number: 13
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
Total Steps total_steps - uint8_t Total number of steps of the calibration procedure. Same as field type
Current Step Number step_number - uint8_t Number of the current step being performed. Same as field type
Description step - plaintext Human-readable description of the current step. Same as field type
Flags flags Bitfield uint8_t Additional flags. Same as field type

Entity Activation State

State of entity activation/deactivation.

  • Abbreviation: EntityActivationState
  • Identification Number: 14
  • Fixed Payload Size: 0
Name Abbreviation Unit Type Description Range
State state Enumerated uint8_t Current state. Same as field type
Error error - plaintext Human-readable error message. Same as field type

Query Entity Activation State

Query the activation/deactivation state of an entity. The recipient shall reply with an EntityActivationState message.

  • Abbreviation: QueryEntityActivationState
  • Identification Number: 15
  • Fixed Payload Size: 0

This message has no fields.