IMCInter Module Communication
v5.5.11

Vehicle State

VehicleState ID 500
Payload
≥ 31 bytes, variable
Packet
≥ 53 bytes
Source
vehicle
Category
Vehicle Supervision

This message summarizes the overall state of the vehicle. It can contains information regarding:

  • The overall operation mode.
  • Any error conditions.
  • Current maneuver execution.
  • Active control loops.

#Fields

Offset FieldTypeUnitRangeDescription
0 #op_modeOperation Mode uint8_t Enumerated –

The overall operation mode.

0VS_SERVICEService

Ready to service requests.

1VS_CALIBRATIONCalibration

Ongoing vehicle calibration.

2VS_ERRORError

Errors are set.

3VS_MANEUVERManeuver

A maneuver is executing.

4VS_EXTERNALExternal Control

External control is active.

5VS_BOOTBoot

Booting system.

1 #error_countErrors -- Count uint8_t – –

Error count for monitored entitites.

2 #error_entsErrors -- Entities plaintext – –

The monitored entities with error conditions. This is a comma separated list of entity names.

var #maneuver_typeManeuver -- Type uint16_t – –

Type of maneuver being executed, when in MANEUVER mode. The value is the IMC serialization ID of the corresponding maneuver.

var #maneuver_stimeManeuver -- Start Time fp64_t s –

Start time of maneuver being executed (Epoch time), when in MANEUVER mode.

var #maneuver_etaManeuver -- ETA uint16_t s –

Estimated time for maneuver completion. The value will be 65535 if the time is unknown or undefined.

var #control_loopsControl Loops uint32_t Bitfield –

Enabled control loops.

20 flags from CLoopsMask
0x00000000CL_NONENone
0x00000001CL_PATHPath Control
0x00000002CL_TELEOPERATIONTeleoperation Control
0x00000004CL_ALTITUDEAltitude Control
0x00000008CL_DEPTHDepth Control
0x00000010CL_ROLLRoll Control
0x00000020CL_PITCHPitch Control
0x00000040CL_YAWYaw Control
0x00000080CL_SPEEDSpeed Control
0x00000100CL_YAW_RATEYaw Rate Control
0x00000200CL_VERTICAL_RATEVertical Rate Control
0x00000400CL_TORQUETorque Control
0x00000800CL_FORCEForce Control
0x00001000CL_VELOCITYVelocity Control
0x00002000CL_THROTTLEThrottle Control
0x00004000CL_HOVERINGHovering Control
0x00008000CL_PADDLINGPaddling Control
0x40000000CL_EXTERNALUnspecified External Control
0x80000000CL_NO_OVERRIDENon-overridable control
0xFFFFFFFFCL_ALLAll
var #flagsFlags uint8_t Bitfield –
0x01VFLG_MANEUVER_DONEManeuver Done
var #last_errorLast Error -- Description plaintext – –

Description of last error.

var #last_error_timeLast Error -- Time fp64_t s –

Time of last error (Epoch time).