Reference
Enumerations and bitfields
Value sets shared by several fields. Fields that define their own values list them in place, on the message page.
Bitfields
Enumerations
#Boolean Boolean Value
Constants prefixed BOOL_. Used by 4 fields.
| Value | Constant | Name |
|---|---|---|
0 | BOOL_FALSE | False |
1 | BOOL_TRUE | True |
Fields using Boolean
#ControlledMode Controlled Mode
Constants prefixed CTLMD_. Not used by any field.
| Value | Constant | Name |
|---|---|---|
0 | CTLMD_RELINQUISH_HANDOFF_CTL | Relinquish / Handoff Control |
1 | CTLMD_REQUEST_CTL | Request Control |
2 | CTLMD_OVERRIDE_CTL | Override Control |
#SpeedUnits Speed Units
Constants prefixed SUNITS_. Used by 29 fields.
| Value | Constant | Name |
|---|---|---|
0 | SUNITS_METERS_PS | Meters per second |
1 | SUNITS_RPM | RPM |
2 | SUNITS_PERCENTAGE | Percentage |
Fields using SpeedUnits
DesiredSpeed.speed_unitsDesiredPath.speed_unitsGoto.speed_unitsPopUp.speed_unitsLoiter.speed_unitsRows.speed_unitsFollowPath.speed_unitsYoYo.speed_unitsStationKeeping.speed_unitsElevator.speed_unitsFollowTrajectory.speed_unitsVehicleFormation.speed_unitsFollowSystem.speed_unitsCommsRelay.speed_unitsCoverArea.speed_unitsCompassCalibration.speed_unitsLaunch.speed_unitsDrop.speed_unitsRowsCoverage.speed_unitsSample.speed_unitsTakeoff.speed_unitsLand.speed_unitsAutonomousSection.speed_unitsFollowPoint.speed_unitsAlignment.speed_unitsMagnetometer.speed_unitsStationKeepingExtended.speed_unitsPaddling.speed_unitsSetPose.speed_units
#SystemType System Type
Constants prefixed SYSTEMTYPE_. Used by 1 field.
| Value | Constant | Name |
|---|---|---|
0 | SYSTEMTYPE_CCU | CCU |
1 | SYSTEMTYPE_HUMANSENSOR | Human-portable Sensor |
2 | SYSTEMTYPE_UUV | UUV |
3 | SYSTEMTYPE_USV | USV |
4 | SYSTEMTYPE_UAV | UAV |
5 | SYSTEMTYPE_UGV | UGV |
6 | SYSTEMTYPE_STATICSENSOR | Static sensor |
7 | SYSTEMTYPE_MOBILESENSOR | Mobile sensor |
8 | SYSTEMTYPE_WSN | Wireless Sensor Network |
Fields using SystemType
#ZUnits Z Units
Constants prefixed Z_. Used by 36 fields.
| Value | Constant | Name |
|---|---|---|
0 | Z_NONE | None |
1 | Z_DEPTH | Depth |
2 | Z_ALTITUDE | Altitude |
3 | Z_HEIGHT | Height |
Fields using ZUnits
DesiredZ.z_unitsDesiredPath.start_z_unitsDesiredPath.end_z_unitsPathControlState.start_z_unitsPathControlState.end_z_unitsGoto.z_unitsPopUp.z_unitsLoiter.z_unitsRows.z_unitsFollowPath.z_unitsYoYo.z_unitsStationKeeping.z_unitsElevator.start_z_unitsElevator.end_z_unitsFollowTrajectory.z_unitsVehicleFormation.z_unitsFollowSystem.z_unitsCoverArea.z_unitsCompassCalibration.z_unitsLaunch.z_unitsDrop.z_unitsScheduledGoto.z_unitsScheduledGoto.travel_z_unitsRowsCoverage.z_unitsSample.z_unitsTakeoff.z_unitsLand.z_unitsFollowPoint.z_unitsMagnetometer.z_unitsStationKeepingExtended.z_unitsPaddling.z_unitsTarget.z_unitsUsblFix.z_unitsUsblFixExtended.z_unitsUsblModem.z_unitsSetPose.z_units
#RSSIUnits RSSI Units
Constants prefixed RSSIUNITS_. Used by 1 field.
| Value | Constant | Name |
|---|---|---|
0 | RSSIUNITS_dB | Decibel |
1 | RSSIUNITS_PERCENTAGE | Percentage |
Fields using RSSIUnits
#UAVType UAV Type
Constants prefixed UAVTYPE_. Not used by any field.
| Value | Constant | Name |
|---|---|---|
0 | UAVTYPE_FIXEDWING | Fixed-Wing |
1 | UAVTYPE_COPTER | Copter |
2 | UAVTYPE_VTOL | Vtol |
Bitfields
#CLoopsMask Control Loops Mask
Constants prefixed CL_. Used by 2 fields.
| Value | Constant | Name |
|---|---|---|
0x00000000 | CL_NONE | None |
0x00000001 | CL_PATH | Path Control |
0x00000002 | CL_TELEOPERATION | Teleoperation Control |
0x00000004 | CL_ALTITUDE | Altitude Control |
0x00000008 | CL_DEPTH | Depth Control |
0x00000010 | CL_ROLL | Roll Control |
0x00000020 | CL_PITCH | Pitch Control |
0x00000040 | CL_YAW | Yaw Control |
0x00000080 | CL_SPEED | Speed Control |
0x00000100 | CL_YAW_RATE | Yaw Rate Control |
0x00000200 | CL_VERTICAL_RATE | Vertical Rate Control |
0x00000400 | CL_TORQUE | Torque Control |
0x00000800 | CL_FORCE | Force Control |
0x00001000 | CL_VELOCITY | Velocity Control |
0x00002000 | CL_THROTTLE | Throttle Control |
0x00004000 | CL_HOVERING | Hovering Control |
0x00008000 | CL_PADDLING | Paddling Control |
0x40000000 | CL_EXTERNAL | Unspecified External Control |
0x80000000 | CL_NO_OVERRIDE | Non-overridable control |
0xFFFFFFFF | CL_ALL | All |
Fields using CLoopsMask
#OpLimitsMask Operational Limits Mask
Constants prefixed OPL_. Used by 1 field.
| Value | Constant | Name |
|---|---|---|
0x01 | OPL_MAX_DEPTH | Maximum Depth |
0x02 | OPL_MIN_ALT | Minimum Altitude |
0x04 | OPL_MAX_ALT | Maximum Altitude |
0x08 | OPL_MIN_SPEED | Minimum Speed |
0x10 | OPL_MAX_SPEED | Maximum Speed |
0x20 | OPL_MAX_VRATE | Maximum Vertical Rate |
0x40 | OPL_AREA | Operation Area |