2
Commands to be executed by the MAV. They can be executed on user request,
or as part of a mission script. If the action is used in a mission, the parameter mapping
to the waypoint/mission message is as follows:
Param 1, Param 2, Param 3, Param 4, X: Param 5, Y:Param 6, Z:Param 7.
Navigate to waypoint.
Hold time (ignored by fixed wing, time to stay at waypoint for rotary wing)
Acceptance radius (if the sphere with this radius is hit, the waypoint counts as reached)
0 to pass through the WP, if > 0 radius to pass by WP. Allows trajectory control.
Desired yaw angle
Latitude
Longitude
Altitude
Loiter around this waypoint an unlimited amount of time
Empty
Empty
Radius around waypoint, in meters. If positive loiter clockwise, else counter-clockwise
Desired yaw angle.
Latitude
Longitude
Altitude
Loiter around this waypoint for X turns
Turns
Empty
Radius around waypoint, in meters. If positive loiter clockwise, else counter-clockwise
Desired yaw angle.
Latitude
Longitude
Altitude
Loiter around this waypoint for X seconds
Seconds (decimal)
Empty
Radius around waypoint, in meters. If positive loiter clockwise, else counter-clockwise
Desired yaw angle.
Latitude
Longitude
Altitude
Return to launch location
Empty
Empty
Empty
Empty
Empty
Empty
Empty
Land at location
Empty
Empty
Empty
Desired yaw angle.
Latitude
Longitude
Altitude
Takeoff from ground / hand
Minimum pitch (if airspeed sensor present), desired pitch without sensor
Empty
Empty
Yaw angle (if magnetometer present), ignored without magnetometer
Latitude
Longitude
Altitude
NOP - This command is only used to mark the upper limit of the NAV/ACTION commands in the enumeration
Empty
Empty
Empty
Empty
Empty
Empty
Empty
Delay mission state machine.
Delay in seconds (decimal)
Empty
Empty
Empty
Empty
Empty
Empty
Ascend/descend at rate. Delay mission state machine until desired altitude reached.
Descent / Ascend rate (m/s)
Empty
Empty
Empty
Empty
Empty
Finish Altitude
Delay mission state machine until within desired distance of next NAV point.
Distance (meters)
Empty
Empty
Empty
Empty
Empty
Empty
NOP - This command is only used to mark the upper limit of the CONDITION commands in the enumeration
Empty
Empty
Empty
Empty
Empty
Empty
Empty
Set system mode.
Mode, as defined by ENUM MAV_MODE
Empty
Empty
Empty
Empty
Empty
Empty
Jump to the desired command in the mission list. Repeat this action only the specified number of times
Sequence number
Repeat count
Empty
Empty
Empty
Empty
Empty
Change speed and/or throttle set points.
Speed type (0=Airspeed, 1=Ground Speed)
Speed (m/s, -1 indicates no change)
Throttle ( Percent, -1 indicates no change)
Empty
Empty
Empty
Empty
Changes the home location either to the current location or a specified location.
Use current (1=use current location, 0=use specified location)
Empty
Empty
Empty
Latitude
Longitude
Altitude
Set a system parameter. Caution! Use of this command requires knowledge of the numeric enumeration value of the parameter.
Parameter number
Parameter value
Empty
Empty
Empty
Empty
Empty
Set a relay to a condition.
Relay number
Setting (1=on, 0=off, others possible depending on system hardware)
Empty
Empty
Empty
Empty
Empty
Cycle a relay on and off for a desired number of cyles with a desired period.
Relay number
Cycle count
Cycle time (seconds, decimal)
Empty
Empty
Empty
Empty
Set a servo to a desired PWM value.
Servo number
PWM (microseconds, 1000 to 2000 typical)
Empty
Empty
Empty
Empty
Empty
Cycle a between its nominal setting and a desired PWM for a desired number of cyles with a desired period.
Servo number
PWM (microseconds, 1000 to 2000 typical)
Cycle count
Cycle time (seconds)
Empty
Empty
Empty
Data stream IDs. A data stream is not a fixed set of messages, but rather a
recommendation to the autopilot software. Individual autopilots may or may not obey
the recommended messages.
Enable all data streams
Enable IMU_RAW, GPS_RAW, GPS_STATUS packets.
Enable GPS_STATUS, CONTROL_STATUS, AUX_STATUS
Enable RC_CHANNELS_SCALED, RC_CHANNELS_RAW, SERVO_OUTPUT_RAW
Enable ATTITUDE_CONTROLLER_OUTPUT, POSITION_CONTROLLER_OUTPUT, NAV_CONTROLLER_OUTPUT.
Enable LOCAL_POSITION, GLOBAL_POSITION/GLOBAL_POSITION_INT messages.
Dependent on the autopilot
Dependent on the autopilot
Dependent on the autopilot
The heartbeat message shows that a system is present and responding. The type of the MAV and Autopilot hardware allow the receiving system to treat further messages from this system appropriate (e.g. by laying out the user interface based on the autopilot).
Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)
Type of the Autopilot: 0: Generic, 1: PIXHAWK, 2: SLUGS, 3: Ardupilot (up to 15 types), defined in MAV_AUTOPILOT_TYPE ENUM
MAVLink version
The boot message indicates that a system is starting. The onboard software version allows to keep track of onboard soft/firmware revisions.
The onboard software version
The system time is the time of the master clock, typically the computer clock of the main onboard computer.
Timestamp of the master clock in microseconds since UNIX epoch.
A ping message either requesting or responding to a ping. This allows to measure the system latencies, including serial port, radio modem and UDP connections.
PING sequence
0: request ping from all receiving systems, if greater than 0: message is a ping response and number is the system id of the requesting system
0: request ping from all receiving components, if greater than 0: message is a ping response and number is the system id of the requesting system
Unix timestamp in microseconds
UTC date and time from GPS module
GPS UTC date ddmmyy
GPS UTC time hhmmss
Request to control this MAV
System the GCS requests control for
0: request control of this MAV, 1: Release control of this MAV
0: key as plaintext, 1-255: future, different hashing/encryption variants. The GCS should in general use the safest mode possible initially and then gradually move down the encryption level if it gets a NACK message indicating an encryption mismatch.
Password / Key, depending on version plaintext or encrypted. 25 or less characters, NULL terminated. The characters may involve A-Z, a-z, 0-9, and "!?,.-"
Accept / deny control of this MAV
ID of the GCS this message
0: request control of this MAV, 1: Release control of this MAV
0: ACK, 1: NACK: Wrong passkey, 2: NACK: Unsupported passkey encryption method, 3: NACK: Already under control
This message acknowledges an action. IMPORTANT: The acknowledgement can be also negative, e.g. the MAV rejects a reset message because it is in-flight. The action ids are defined in ENUM MAV_ACTION in mavlink/include/mavlink_types.h
The action id
0: Action DENIED, 1: Action executed
An action message allows to execute a certain onboard action. These include liftoff, land, storing parameters too EEPROM, shutddown, etc. The action ids are defined in ENUM MAV_ACTION in mavlink/include/mavlink_types.h
The system executing the action
The component executing the action
The action id
Set the system mode, as defined by enum MAV_MODE in mavlink/include/mavlink_types.h. There is no target component id as the mode is by definition for the overall aircraft, not only for one component.
The system setting the mode
The new mode
Set the system navigation mode, as defined by enum MAV_NAV_MODE in mavlink/include/mavlink_types.h. The navigation mode applies to the whole aircraft and thus all components.
The system setting the mode
The new navigation mode
Request to read the onboard parameter with the param_id string id. Onboard parameters are stored as key[const char*] -> value[float]. This allows to send a parameter to any other component (such as the GCS) without the need of previous knowledge of possible parameter names. Thus the same GCS can store different parameters for different autopilots. See also http://qgroundcontrol.org/parameter_interface for a full documentation of QGroundControl and IMU code.
System ID
Component ID
Onboard parameter id
Parameter index. Send -1 to use the param ID field as identifier
Request all parameters of this component. After his request, all parameters are emitted.
System ID
Component ID
Emit the value of a onboard parameter. The inclusion of param_count and param_index in the message allows the recipient to keep track of received parameters and allows him to re-request missing parameters after a loss or timeout.
Onboard parameter id
Onboard parameter value
Total number of onboard parameters
Index of this onboard parameter
Set a parameter value TEMPORARILY to RAM. It will be reset to default on system reboot. Send the ACTION MAV_ACTION_STORAGE_WRITE to PERMANENTLY write the RAM contents to EEPROM. IMPORTANT: The receiving component should acknowledge the new parameter value by sending a param_value message to all communication partners. This will also ensure that multiple GCS all have an up-to-date list of all parameters. If the sending GCS did not receive a PARAM_VALUE message within its timeout time, it should re-send the PARAM_SET message.
System ID
Component ID
Onboard parameter id
Onboard parameter value
The global position, as returned by the Global Positioning System (GPS). This is
NOT the global position estimate of the sytem, but rather a RAW sensor value. See message GLOBAL_POSITION for the global position estimate. Coordinate frame is right-handed, Z-axis up (GPS frame)
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
0-1: no fix, 2: 2D fix, 3: 3D fix. Some applications will not use the value of this field unless it is at least two, so always correctly fill in the fix.
Latitude in 1E7 degrees
Longitude in 1E7 degrees
Altitude in 1E3 meters (millimeters)
GPS HDOP
GPS VDOP
GPS ground speed (m/s)
Compass heading in degrees, 0..360 degrees
The RAW IMU readings for the usual 9DOF sensor setup. This message should contain the scaled values to the described units
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
X acceleration (mg)
Y acceleration (mg)
Z acceleration (mg)
Angular speed around X axis (millirad /sec)
Angular speed around Y axis (millirad /sec)
Angular speed around Z axis (millirad /sec)
X Magnetic field (milli tesla)
Y Magnetic field (milli tesla)
Z Magnetic field (milli tesla)
The positioning status, as reported by GPS. This message is intended to display status information about each satellite visible to the receiver. See message GLOBAL_POSITION for the global position estimate. This message can contain information for up to 20 satellites.
Number of satellites visible
Global satellite ID
0: Satellite not used, 1: used for localization
Elevation (0: right on top of receiver, 90: on the horizon) of satellite
Direction of satellite, 0: 0 deg, 255: 360 deg.
Signal to noise ratio of satellite
The RAW IMU readings for the usual 9DOF sensor setup. This message should always contain the true raw values without any scaling to allow data capture and system debugging.
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
X acceleration (raw)
Y acceleration (raw)
Z acceleration (raw)
Angular speed around X axis (raw)
Angular speed around Y axis (raw)
Angular speed around Z axis (raw)
X Magnetic field (raw)
Y Magnetic field (raw)
Z Magnetic field (raw)
The RAW pressure readings for the typical setup of one absolute pressure and one differential pressure sensor. The sensor values should be the raw, unscaled ADC values.
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
Absolute pressure (hectopascal)
Differential pressure 1 (hectopascal)
Differential pressure 2 (hectopascal)
Raw Temperature measurement (0.01 degrees celsius per tick is default unit)
The attitude in the aeronautical frame (right-handed, Z-down, X-front, Y-right).
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
Roll angle (rad)
Pitch angle (rad)
Yaw angle (rad)
Roll angular speed (rad/s)
Pitch angular speed (rad/s)
Yaw angular speed (rad/s)
The filtered local position (e.g. fused computer vision and accelerometers). Coordinate frame is right-handed, Z-axis down (aeronautical frame)
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
X Position
Y Position
Z Position
X Speed
Y Speed
Z Speed
The filtered global position (e.g. fused GPS and accelerometers). Coordinate frame is right-handed, Z-axis up (GPS frame)
Timestamp (microseconds since unix epoch)
Latitude, in degrees
Longitude, in degrees
Absolute altitude, in meters
X Speed (in Latitude direction, positive: going north)
Y Speed (in Longitude direction, positive: going east)
Z Speed (in Altitude direction, positive: going up)
The global position, as returned by the Global Positioning System (GPS). This is
NOT the global position estimate of the sytem, but rather a RAW sensor value. See message GLOBAL_POSITION for the global position estimate. Coordinate frame is right-handed, Z-axis up (GPS frame)
Timestamp (microseconds since UNIX epoch or microseconds since system boot)
0-1: no fix, 2: 2D fix, 3: 3D fix. Some applications will not use the value of this field unless it is at least two, so always correctly fill in the fix.
Latitude in degrees
Longitude in degrees
Altitude in meters
GPS HDOP
GPS VDOP
GPS ground speed
Compass heading in degrees, 0..360 degrees
The general system state. If the system is following the MAVLink standard, the system state is mainly defined by three orthogonal states/modes: The system mode, which is either LOCKED (motors shut down and locked), MANUAL (system under RC control), GUIDED (system with autonomous position control, position setpoint controlled manually) or AUTO (system guided by path/waypoint planner). The NAV_MODE defined the current flight state: LIFTOFF (often an open-loop maneuver), LANDING, WAYPOINTS or VECTOR. This represents the internal navigation state machine. The system status shows wether the system is currently active or not and if an emergency occured. During the CRITICAL and EMERGENCY states the MAV is still considered to be active, but should start emergency procedures autonomously. After a failure occured it should first move from active to critical to allow manual intervention and then move to emergency after a certain timeout.
System mode, see MAV_MODE ENUM in mavlink/include/mavlink_types.h
Navigation mode, see MAV_NAV_MODE ENUM
System status flag, see MAV_STATUS ENUM
Maximum usage in percent of the mainloop time, (0%: 0, 100%: 1000) should be always below 1000
Battery voltage, in millivolts (1 = 1 millivolt)
Remaining battery energy: (0%: 0, 100%: 1000)
Dropped packets (packets that were corrupted on reception on the MAV)
The RAW values of the RC channels received. The standard PPM modulation is as follows: 1000 microseconds: 0%, 2000 microseconds: 100%. Individual receivers/transmitters might violate this specification.
RC channel 1 value, in microseconds
RC channel 2 value, in microseconds
RC channel 3 value, in microseconds
RC channel 4 value, in microseconds
RC channel 5 value, in microseconds
RC channel 6 value, in microseconds
RC channel 7 value, in microseconds
RC channel 8 value, in microseconds
Receive signal strength indicator, 0: 0%, 255: 100%
The scaled values of the RC channels received. (-100%) -10000, (0%) 0, (100%) 10000
RC channel 1 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 2 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 3 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 4 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 5 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 6 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 7 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
RC channel 8 value scaled, (-100%) -10000, (0%) 0, (100%) 10000
Receive signal strength indicator, 0: 0%, 255: 100%
The RAW values of the servo outputs (for RC input from the remote, use the RC_CHANNELS messages). The standard PPM modulation is as follows: 1000 microseconds: 0%, 2000 microseconds: 100%.
Servo output 1 value, in microseconds
Servo output 2 value, in microseconds
Servo output 3 value, in microseconds
Servo output 4 value, in microseconds
Servo output 5 value, in microseconds
Servo output 6 value, in microseconds
Servo output 7 value, in microseconds
Servo output 8 value, in microseconds
Message encoding a waypoint. This message is emitted to announce
the presence of a waypoint and to set a waypoint on the system. The waypoint can be either in x, y, z meters (type: LOCAL) or x:lat, y:lon. The global and body frame are related as: positive Z-down, positive X(front looking north, positive Y(body:right) looking east. Therefore y encodes in global mode the latitude, whereas x encodes the longitude and z the GPS altitude (WGS84).
System ID
Component ID
Sequence
The coordinate system of the waypoint. see MAV_FRAME in mavlink_types.h
The scheduled action for the waypoint. see MAV_COMMAND in common.xml MAVLink specs
false:0, true:1
autocontinue to next wp
PARAM1 / For NAV command waypoints: Radius in which the waypoint is accepted as reached, in meters
PARAM2 / For NAV command waypoints: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds
PARAM3 / For LOITER command waypoints: Orbit to circle around the waypoint, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.
PARAM4 / For NAV and LOITER command waypoints: Yaw orientation in degrees, [0..360] 0 = NORTH
PARAM5 / local: x position, global: longitude
PARAM6 / y position: global: latitude
PARAM7 / z position: global: altitude
Request the information of the waypoint with the sequence number seq. The response of the system to this message should be a WAYPOINT message.
System ID
Component ID
Sequence
Set the waypoint with sequence number seq as current waypoint. This means that the MAV will continue to this waypoint on the shortest path (not following the waypoints in-between).
System ID
Component ID
Sequence
Message that announces the sequence number of the current active waypoint. The MAV will fly towards this waypoint.
Sequence
Request the overall list of waypoints from the system/component.
System ID
Component ID
This message is emitted as response to WAYPOINT_REQUEST_LIST by the MAV. The GCS can then request the individual waypoints based on the knowledge of the total number of waypoints.
System ID
Component ID
Number of Waypoints in the Sequence
Delete all waypoints at once.
System ID
Component ID
A certain waypoint has been reached. The system will either hold this position (or circle on the orbit) or (if the autocontinue on the WP was set) continue to the next waypoint.
Sequence
Ack message during waypoint handling. The type field states if this message is a positive ack (type=0) or if an error happened (type=non-zero).
System ID
Component ID
0: OK, 1: Error
As local waypoints exist, the global waypoint reference allows to transform between the local coordinate frame and the global (GPS) coordinate frame. This can be necessary when e.g. in- and outdoor settings are connected and the MAV should move from in- to outdoor.
System ID
Component ID
global x position * 1E7
global y position * 1E7
global z position * 1000
local x position that matches the global x position
local y position that matches the global y position
local z position that matches the global z position
Once the MAV sets a new GPS-Local correspondence, this message announces the origin (0,0,0) position
Latitude (WGS84), expressed as * 1E7
Longitude (WGS84), expressed as * 1E7
Altitude(WGS84), expressed as * 1000
Set the setpoint for a local position controller. This is the position in local coordinates the MAV should fly to. This message is sent by the path/waypoint planner to the onboard position controller. As some MAVs have a degree of freedom in yaw (e.g. all helicopters/quadrotors), the desired yaw angle is part of the message.
System ID
Component ID
x position
y position
z position
Desired yaw angle
Transmit the current local setpoint of the controller to other MAVs (collision avoidance) and to the GCS.
x position
y position
z position
Desired yaw angle
Position fix: 0: lost, 2: 2D position fix, 3: 3D position fix
Vision position fix: 0: lost, 1: 2D local position hold, 2: 2D global position fix, 3: 3D global position fix
GPS position fix: 0: no reception, 1: Minimum 1 satellite, but no position fix, 2: 2D position fix, 3: 3D position fix
Attitude estimation health: 0: poor, 255: excellent
0: Attitude control disabled, 1: enabled
0: X, Y position control disabled, 1: enabled
0: Z position control disabled, 1: enabled
0: Yaw angle control disabled, 1: enabled
Set a safety zone (volume), which is defined by two corners of a cube. This message can be used to tell the MAV which setpoints/waypoints to accept and which to reject. Safety areas are often enforced by national or competition regulations.
System ID
Component ID
Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
x position 1 / Latitude 1
y position 1 / Longitude 1
z position 1 / Altitude 1
x position 2 / Latitude 2
y position 2 / Longitude 2
z position 2 / Altitude 2
Read out the safety zone the MAV currently assumes.
Coordinate frame, as defined by MAV_FRAME enum in mavlink_types.h. Can be either global, GPS, right-handed with Z axis up or local, right handed, Z axis down.
x position 1 / Latitude 1
y position 1 / Longitude 1
z position 1 / Altitude 1
x position 2 / Latitude 2
y position 2 / Longitude 2
z position 2 / Altitude 2
The output of the attitude controller. This output is the control response the controller currently generates and the attitude the MAV would take if it is under control of the attitude controller. The primary use of this message is to check the response and signs of the controller before the actual flight.
1: enabled, 0: disabled
Attitude roll: -128: -100%, 127: +100%
Attitude pitch: -128: -100%, 127: +100%
Attitude yaw: -128: -100%, 127: +100%
Attitude thrust: -128: -100%, 127: +100%
The output of the position controller. The primary use of this message is to check the response and signs of the controller before the actual flight.
1: enabled, 0: disabled
Position x: -128: -100%, 127: +100%
Position y: -128: -100%, 127: +100%
Position z: -128: -100%, 127: +100%
Position yaw: -128: -100%, 127: +100%
Outputs of the APM navigation controller. The primary use of this message is to check the response and signs
of the controller before actual flight and to assist with tuning controller parameters
Current desired roll in degrees
Current desired pitch in degrees
Current desired heading in degrees
Bearing to current waypoint/target in degrees
Distance to active waypoint in meters
Current altitude error in meters
Current airspeed error in meters/second
Current crosstrack error on x-y plane in meters
The goal position of the system. This position is the input to any navigation or path planning algorithm and does NOT represent the current controller setpoint.
x position
y position
z position
yaw orientation in radians, 0 = NORTH
Corrects the systems state by adding an error correction term to the position and velocity, and by rotating the attitude by a correction angle.
x position error
y position error
z position error
roll error (radians)
pitch error (radians)
yaw error (radians)
x velocity
y velocity
z velocity
The system setting the altitude
The new altitude in meters
The target requested to send the message stream.
The target requested to send the message stream.
The ID of the requested message type
The requested interval between two messages of this type
1 to start sending, 0 to stop sending.
The system to be controlled
roll
pitch
yaw
thrust
roll control enabled auto:0, manual:1
pitch auto:0, manual:1
yaw auto:0, manual:1
thrust auto:0, manual:1
The filtered global position (e.g. fused GPS and accelerometers). The position is in GPS-frame (right-handed, Z-up)
Latitude / X Position, expressed as * 1E7
Longitude / Y Position, expressed as * 1E7
Altitude in meters, expressed as * 1000 (millimeters)
Ground X Speed (Latitude), expressed as m/s * 100
Ground Y Speed (Longitude), expressed as m/s * 100
Ground Z Speed (Altitude), expressed as m/s * 100
Metrics typically displayed on a HUD for fixed wing aircraft
Current airspeed in m/s
Current ground speed in m/s
Current heading in degrees, in compass units (0..360, 0=north)
Current throttle setting in integer percent, 0 to 100
Current altitude (MSL), in meters
Current climb rate in meters/second
Name
Timestamp
x
y
z
Send a key-value pair as float. The use of this message is discouraged for normal packets, but a quite efficient way for testing new messages and getting experimental debug output.
Name of the debug variable
Floating point value
Send a key-value pair as integer. The use of this message is discouraged for normal packets, but a quite efficient way for testing new messages and getting experimental debug output.
Name of the debug variable
Signed integer value
Status text message. These messages are printed in yellow in the COMM console of QGroundControl. WARNING: They consume quite some bandwidth, so use only for important status and error messages. If implemented wisely, these messages are buffered on the MCU and sent only at a limited rate (e.g. 10 Hz).
Severity of status, 0 = info message, 255 = critical fault
Status text message, without null termination character
Send a debug value. The index is used to discriminate between values. These values show up in the plot of QGroundControl as DEBUG N.
index of debug variable
DEBUG value