common.xml 105 KB
Newer Older
lm's avatar
lm committed
1
<?xml version='1.0'?>
James Goppert's avatar
James Goppert committed
2
<mavlink>
lm's avatar
lm committed
3 4
     <version>3</version>
     <enums>
5
          <enum name="MAV_AUTOPILOT">
lm's avatar
lm committed
6
               <description>Micro air vehicle / autopilot classes. This identifies the individual model.</description>
7
               <entry value="0" name="MAV_AUTOPILOT_GENERIC">
lm's avatar
lm committed
8 9
                    <description>Generic autopilot, full support for everything</description>
               </entry>
10
               <entry value="1" name="MAV_AUTOPILOT_PIXHAWK">
lm's avatar
lm committed
11 12
                    <description>PIXHAWK autopilot, http://pixhawk.ethz.ch</description>
               </entry>
13
               <entry value="2" name="MAV_AUTOPILOT_SLUGS">
lm's avatar
lm committed
14 15
                    <description>SLUGS autopilot, http://slugsuav.soe.ucsc.edu</description>
               </entry>
16
               <entry value="3" name="MAV_AUTOPILOT_ARDUPILOTMEGA">
lm's avatar
lm committed
17 18
                    <description>ArduPilotMega / ArduCopter, http://diydrones.com</description>
               </entry>
19
               <entry value="4" name="MAV_AUTOPILOT_OPENPILOT">
lm's avatar
lm committed
20 21
                    <description>OpenPilot, http://openpilot.org</description>
               </entry>
lm's avatar
lm committed
22
               <entry value="5" name="MAV_AUTOPILOT_GENERIC_WAYPOINTS_ONLY">
lm's avatar
lm committed
23 24
                    <description>Generic autopilot only supporting simple waypoints</description>
               </entry>
lm's avatar
lm committed
25
               <entry value="6" name="MAV_AUTOPILOT_GENERIC_WAYPOINTS_AND_SIMPLE_NAVIGATION_ONLY">
lm's avatar
lm committed
26 27
                    <description>Generic autopilot supporting waypoints and other simple navigation commands</description>
               </entry>
28
               <entry value="7" name="MAV_AUTOPILOT_GENERIC_MISSION_FULL">
lm's avatar
lm committed
29 30
                    <description>Generic autopilot supporting the full mission command set</description>
               </entry>
31
               <entry value="8" name="MAV_AUTOPILOT_INVALID">
lm's avatar
lm committed
32 33
                    <description>No valid autopilot, e.g. a GCS or other MAVLink component</description>
               </entry>
34
               <entry value="9" name="MAV_AUTOPILOT_PPZ">
lm's avatar
lm committed
35 36
                    <description>PPZ UAV - http://nongnu.org/paparazzi</description>
               </entry>
37
               <entry value="10" name="MAV_AUTOPILOT_UDB">
lm's avatar
lm committed
38 39
                    <description>UAV Dev Board</description>
               </entry>
40
               <entry value="11" name="MAV_AUTOPILOT_FP">
lm's avatar
lm committed
41 42 43 44
                    <description>FlexiPilot</description>
               </entry>
          </enum>
          <!-- WARNING: MAV_ACTION Enum is no longer supported - has been removed. Please use MAV_CMD -->
45 46
          <enum name="MAV_MODE_FLAG">
          		<description>These flags encode the MAV mode.</description>
lm's avatar
lm committed
47
          		<entry value="128" name="MAV_MODE_FLAG_SAFETY_ARMED">
48
          			<description>0b10000000 MAV safety set to armed. Motors are enabled / running / can start. Ready to fly.</description>
49
          		</entry>
lm's avatar
lm committed
50 51
                <entry value="64" name="MAV_MODE_FLAG_MANUAL_INPUT_ENABLED">
          			<description>0b01000000 remote control input is enabled.</description>
52
          		</entry>
lm's avatar
lm committed
53 54
          		<entry value="32" name="MAV_MODE_FLAG_HIL_ENABLED">
          			<description>0b00100000 hardware in the loop simulation. All motors / actuators are blocked, but internal software is full operational.</description>
55
          		</entry>
lm's avatar
lm committed
56 57
                <entry value="16" name="MAV_MODE_FLAG_STABILIZE_ENABLED">
          			<description>0b00010000 system stabilizes electronically its attitude (and optionally position). It needs however further control inputs to move around.</description>
58
          		</entry>
lm's avatar
lm committed
59 60
                <entry value="8" name="MAV_MODE_FLAG_GUIDED_ENABLED">
          			<description>0b00001000 guided mode enabled, system flies MISSIONs / mission items.</description>
61
          		</entry>
lm's avatar
lm committed
62 63 64 65 66 67 68 69
                <entry value="4" name="MAV_MODE_FLAG_AUTO_ENABLED">
          			<description>0b00000100 autonomous mode enabled, system finds its own goal positions. Guided flag can be set or not, depends on the actual implementation.</description>
          		</entry>
                <entry value="2" name="MAV_MODE_FLAG_TEST_ENABLED">
          			<description>0b00000010 system has a test mode enabled. This flag is intended for temporary system tests and should not be used for stable implementations.</description>
          		</entry>
                <entry value="1" name="MAV_MODE_FLAG_RESERVED_ENABLED">
          			<description>0b00000001 Reserved for future use.</description>
70 71 72 73
          		</entry>
          </enum>
          
          <enum name="MAV_MODE_FLAG_DECODE_POSITION">
lm's avatar
lm committed
74 75 76
          		<description>These values encode the bit positions of the decode position. These values can be used to read the value of a flag bit by combining the base_mode variable with AND with the flag position value. The result will be either 0 or 1, depending on if the flag is set or not.</description>
                <entry value="128" name="MAV_MODE_FLAG_DECODE_POSITION_SAFETY">
          			<description>First bit:  10000000</description>
77
          		</entry>
lm's avatar
lm committed
78
                <entry value="64" name="MAV_MODE_FLAG_DECODE_POSITION_MANUAL">
79 80
          			<description>Second bit: 01000000</description>
          		</entry>
lm's avatar
lm committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
          		<entry value="32" name="MAV_MODE_FLAG_DECODE_POSITION_HIL">
          			<description>Third bit:  00100000</description>
          		</entry>
                <entry value="16" name="MAV_MODE_FLAG_DECODE_POSITION_STABILIZE">
          			<description>Fourth bit: 00010000</description>
          		</entry>
                <entry value="8" name="MAV_MODE_FLAG_DECODE_POSITION_GUIDED">
          			<description>Fifth bit:  00001000</description>
          		</entry>
                <entry value="4" name="MAV_MODE_FLAG_DECODE_POSITION_AUTO">
          			<description>Sixt bit:   00000100</description>
          		</entry>
                <entry value="2" name="MAV_MODE_FLAG_DECODE_POSITION_TEST">
          			<description>Seventh bit: 00000010</description>
          		</entry>
                <entry value="1" name="MAV_MODE_FLAG_DECODE_POSITION_RESERVED">
          			<description>Eighth bit: 00000001</description>
98 99 100
          		</entry>
          </enum>
          
lm's avatar
lm committed
101
          <enum name="MAV_MODE">
lm's avatar
lm committed
102 103
               <description>These defines are predefined OR-combined mode flags. There is no need to use values from this enum, but it
               simplifies the use of the mode flags. Note that manual input is enabled in all modes as a safety override.</description>
LM's avatar
LM committed
104
               <entry value="0" name="MAV_MODE_PREFLIGHT">
lm's avatar
lm committed
105
                    <description>System is not ready to fly, booting, calibrating, etc. No flag is set.</description>
lm's avatar
lm committed
106
               </entry>
lm's avatar
lm committed
107 108
               <entry value="80" name="MAV_MODE_STABILIZE_DISARMED">
                    <description>System is allowed to be active, under assisted RC control.</description>
lm's avatar
lm committed
109
               </entry>
lm's avatar
lm committed
110 111
               <entry value="208" name="MAV_MODE_STABILIZE_ARMED">
                    <description>System is allowed to be active, under assisted RC control.</description>
lm's avatar
lm committed
112
               </entry>
lm's avatar
lm committed
113 114
               <entry value="64" name="MAV_MODE_MANUAL_DISARMED">
                    <description>System is allowed to be active, under manual (RC) control, no stabilization</description>
lm's avatar
lm committed
115
               </entry>
lm's avatar
lm committed
116 117
               <entry value="192" name="MAV_MODE_MANUAL_ARMED">
                    <description>System is allowed to be active, under manual (RC) control, no stabilization</description>
118
               </entry>
lm's avatar
lm committed
119 120
               <entry value="88" name="MAV_MODE_GUIDED_DISARMED">
                    <description>System is allowed to be active, under autonomous control, manual setpoint</description>
121
               </entry>
lm's avatar
lm committed
122 123
               <entry value="216" name="MAV_MODE_GUIDED_ARMED">
                    <description>System is allowed to be active, under autonomous control, manual setpoint</description>
124
               </entry>
lm's avatar
lm committed
125 126
               <entry value="92" name="MAV_MODE_AUTO_DISARMED">
                    <description>System is allowed to be active, under autonomous control and navigation (the trajectory is decided onboard and not pre-programmed by MISSIONs)</description>
127
               </entry>
lm's avatar
lm committed
128 129
               <entry value="220" name="MAV_MODE_AUTO_ARMED">
                    <description>System is allowed to be active, under autonomous control and navigation (the trajectory is decided onboard and not pre-programmed by MISSIONs)</description>
lm's avatar
lm committed
130
               </entry>
lm's avatar
lm committed
131 132
               <entry value="66" name="MAV_MODE_TEST_DISARMED">
                    <description>UNDEFINED mode. This solely depends on the autopilot - use with caution, intended for developers only.</description>
133
               </entry>
lm's avatar
lm committed
134 135
               <entry value="194" name="MAV_MODE_TEST_ARMED">
                    <description>UNDEFINED mode. This solely depends on the autopilot - use with caution, intended for developers only.</description>
lm's avatar
lm committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
               </entry>
          </enum>
          <enum name="MAV_STATE">
               <entry value="0" name="MAV_STATE_UNINIT">
                    <description>Uninitialized system, state is unknown.</description>
               </entry>
               <entry name="MAV_STATE_BOOT">
                    <description>System is booting up.</description>
               </entry>
               <entry name="MAV_STATE_CALIBRATING">
                    <description>System is calibrating and not flight-ready.</description>
               </entry>
               <entry name="MAV_STATE_STANDBY">
                    <description>System is grounded and on standby. It can be launched any time.</description>
               </entry>
               <entry name="MAV_STATE_ACTIVE">
                    <description>System is active and might be already airborne. Motors are engaged.</description>
               </entry>
               <entry name="MAV_STATE_CRITICAL">
                    <description>System is in a non-normal flight mode. It can however still navigate.</description>
               </entry>
               <entry name="MAV_STATE_EMERGENCY">
                    <description>System is in a non-normal flight mode. It lost control over parts or over the whole airframe. It is in mayday and going down.</description>
               </entry>
               <entry name="MAV_STATE_POWEROFF">
                    <description>System just initialized its power-down sequence, will shut down now.</description>
               </entry>
          </enum>
          <enum name="MAV_TYPE">
               <entry value="0" name="MAV_TYPE_GENERIC">
                    <description>Generic micro air vehicle.</description>
               </entry>
               <entry value="1" name="MAV_TYPE_FIXED_WING">
                    <description>Fixed wing aircraft.</description>
               </entry>
               <entry value="2" name="MAV_TYPE_QUADROTOR">
                    <description>Quadrotor</description>
               </entry>
               <entry value="3" name="MAV_TYPE_COAXIAL">
                    <description>Coaxial helicopter</description>
               </entry>
               <entry value="4" name="MAV_TYPE_HELICOPTER">
                    <description>Normal helicopter with tail rotor.</description>
               </entry>
lm's avatar
lm committed
180
               <entry value="5" name="MAV_TYPE_ANTENNA_TRACKER">
lm's avatar
lm committed
181 182
                    <description>Ground installation</description>
               </entry>
lm's avatar
lm committed
183
               <entry value="6" name="MAV_TYPE_GCS">
lm's avatar
lm committed
184 185 186 187 188 189 190 191 192 193 194
                    <description>Operator control unit / ground control station</description>
               </entry>
               <entry value="7" name="MAV_TYPE_AIRSHIP">
                    <description>Airship, controlled</description>
               </entry>
               <entry value="8" name="MAV_TYPE_FREE_BALLOON">
                    <description>Free balloon, uncontrolled</description>
               </entry>
               <entry value="9" name="MAV_TYPE_ROCKET">
                    <description>Rocket</description>
               </entry>
lm's avatar
lm committed
195
               <entry value="10" name="MAV_TYPE_GROUND_ROVER">
lm's avatar
lm committed
196 197
                    <description>Ground rover</description>
               </entry>
lm's avatar
lm committed
198
               <entry value="11" name="MAV_TYPE_SURFACE_BOAT">
lm's avatar
lm committed
199 200
                    <description>Surface vessel, boat, ship</description>
               </entry>
lm's avatar
lm committed
201
               <entry value="12" name="MAV_TYPE_SUBMARINE">
lm's avatar
lm committed
202 203 204 205 206 207 208 209
                    <description>Submarine</description>
               </entry>
               <entry value="13" name="MAV_TYPE_HEXAROTOR">
                    <description>Hexarotor</description>
               </entry>
               <entry value="14" name="MAV_TYPE_OCTOROTOR">
                    <description>Octorotor</description>
               </entry>
lm's avatar
lm committed
210 211 212 213 214 215
               <entry value="15" name="MAV_TYPE_TRICOPTER">
                    <description>Octorotor</description>
               </entry>
               <entry value="16" name="MAV_TYPE_FLAPPING_WING">
                    <description>Flapping wing</description>
               </entry>
lm's avatar
lm committed
216 217 218 219 220
          </enum>
          <enum name="MAV_COMPONENT">
               <entry value="220" name="MAV_COMP_ID_GPS">
                    <description/>
               </entry>
lm's avatar
lm committed
221
               <entry value="190" name="MAV_COMP_ID_MISSIONPLANNER">
lm's avatar
lm committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
                    <description/>
               </entry>
               <entry value="195" name="MAV_COMP_ID_PATHPLANNER">
                    <description/>
               </entry>
               <entry value="180" name="MAV_COMP_ID_MAPPER">
                    <description/>
               </entry>
               <entry value="100" name="MAV_COMP_ID_CAMERA">
                    <description/>
               </entry>
               <entry value="200" name="MAV_COMP_ID_IMU">
                    <description/>
               </entry>
               <entry value="201" name="MAV_COMP_ID_IMU_2">
                    <description/>
               </entry>
               <entry value="202" name="MAV_COMP_ID_IMU_3">
                    <description/>
               </entry>
               <entry value="240" name="MAV_COMP_ID_UDP_BRIDGE">
                    <description/>
               </entry>
               <entry value="241" name="MAV_COMP_ID_UART_BRIDGE">
                    <description/>
               </entry>
               <entry value="250" name="MAV_COMP_ID_SYSTEM_CONTROL">
                    <description/>
               </entry>
               <entry value="140" name="MAV_COMP_ID_SERVO1">
                    <description/>
               </entry>
               <entry value="141" name="MAV_COMP_ID_SERVO2">
                    <description/>
               </entry>
               <entry value="142" name="MAV_COMP_ID_SERVO3">
                    <description/>
               </entry>
               <entry value="143" name="MAV_COMP_ID_SERVO4">
                    <description/>
               </entry>
               <entry value="144" name="MAV_COMP_ID_SERVO5">
                    <description/>
               </entry>
               <entry value="145" name="MAV_COMP_ID_SERVO6">
                    <description/>
               </entry>
               <entry value="146" name="MAV_COMP_ID_SERVO7">
                    <description/>
               </entry>
               <entry value="147" name="MAV_COMP_ID_SERVO8">
                    <description/>
               </entry>
               <entry value="148" name="MAV_COMP_ID_SERVO9">
                    <description/>
               </entry>
               <entry value="149" name="MAV_COMP_ID_SERVO10">
                    <description/>
               </entry>
               <entry value="150" name="MAV_COMP_ID_SERVO11">
                    <description/>
               </entry>
               <entry value="151" name="MAV_COMP_ID_SERVO12">
                    <description/>
               </entry>
               <entry value="152" name="MAV_COMP_ID_SERVO13">
                    <description/>
               </entry>
               <entry value="153" name="MAV_COMP_ID_SERVO14">
                    <description/>
               </entry>
          </enum>
          <enum name="MAV_FRAME">
               <entry value="0" name="MAV_FRAME_GLOBAL">
296
                    <description>Global coordinate frame, WGS84 coordinate system. First value / x: latitude, second value / y: longitude, third value / z: positive altitude over mean sea level (MSL)</description>
lm's avatar
lm committed
297 298 299 300 301 302 303 304
               </entry>
               <entry value="1" name="MAV_FRAME_LOCAL_NED">
                    <description>Local coordinate frame, Z-up (x: north, y: east, z: down).</description>
               </entry>
               <entry value="2" name="MAV_FRAME_MISSION">
                    <description>NOT a coordinate frame, indicates a mission command.</description>
               </entry>
               <entry value="3" name="MAV_FRAME_GLOBAL_RELATIVE_ALT">
305
                    <description>Global coordinate frame, WGS84 coordinate system, relative altitude over ground with respect to the home position. First value / x: latitude, second value / y: longitude, third value / z: positive altitude with 0 being at the altitude of the home location.</description>
lm's avatar
lm committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
               </entry>
               <entry value="4" name="MAV_FRAME_LOCAL_ENU">
                    <description>Local coordinate frame, Z-down (x: east, y: north, z: up)</description>
               </entry>
          </enum>
          <enum name="MAVLINK_DATA_STREAM_TYPE">
               <entry name="MAVLINK_DATA_STREAM_IMG_JPEG">
                    <description/>
               </entry>
               <entry name="MAVLINK_DATA_STREAM_IMG_BMP">
                    <description/>
               </entry>
               <entry name="MAVLINK_DATA_STREAM_IMG_RAW8U">
                    <description/>
               </entry>
               <entry name="MAVLINK_DATA_STREAM_IMG_RAW32U">
                    <description/>
               </entry>
               <entry name="MAVLINK_DATA_STREAM_IMG_PGM">
                    <description/>
               </entry>
               <entry name="MAVLINK_DATA_STREAM_IMG_PNG">
                    <description/>
               </entry>
          </enum>
          <enum name="MAV_CMD">
               <description>Commands to be executed by the MAV. They can be executed on user request,
James Goppert's avatar
James Goppert committed
333 334 335 336
      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. This command list is similar what
      ARINC 424 is for commercial aircraft: A data format how to interpret waypoint/mission data.</description>
lm's avatar
lm committed
337
               <entry value="16" name="MAV_CMD_NAV_WAYPOINT">
lm's avatar
lm committed
338 339 340
                    <description>Navigate to MISSION.</description>
                    <param index="1">Hold time in decimal seconds. (ignored by fixed wing, time to stay at MISSION for rotary wing)</param>
                    <param index="2">Acceptance radius in meters (if the sphere with this radius is hit, the MISSION counts as reached)</param>
lm's avatar
lm committed
341
                    <param index="3">0 to pass through the WP, if > 0 radius in meters to pass by WP. Positive value for clockwise orbit, negative value for counter-clockwise orbit. Allows trajectory control.</param>
lm's avatar
lm committed
342
                    <param index="4">Desired yaw angle at MISSION (rotary wing)</param>
lm's avatar
lm committed
343 344 345 346 347
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="17" name="MAV_CMD_NAV_LOITER_UNLIM">
lm's avatar
lm committed
348
                    <description>Loiter around this MISSION an unlimited amount of time</description>
lm's avatar
lm committed
349 350
                    <param index="1">Empty</param>
                    <param index="2">Empty</param>
lm's avatar
lm committed
351
                    <param index="3">Radius around MISSION, in meters. If positive loiter clockwise, else counter-clockwise</param>
lm's avatar
lm committed
352 353 354 355 356 357
                    <param index="4">Desired yaw angle.</param>
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="18" name="MAV_CMD_NAV_LOITER_TURNS">
lm's avatar
lm committed
358
                    <description>Loiter around this MISSION for X turns</description>
lm's avatar
lm committed
359 360
                    <param index="1">Turns</param>
                    <param index="2">Empty</param>
lm's avatar
lm committed
361
                    <param index="3">Radius around MISSION, in meters. If positive loiter clockwise, else counter-clockwise</param>
lm's avatar
lm committed
362 363 364 365 366 367
                    <param index="4">Desired yaw angle.</param>
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="19" name="MAV_CMD_NAV_LOITER_TIME">
lm's avatar
lm committed
368
                    <description>Loiter around this MISSION for X seconds</description>
lm's avatar
lm committed
369 370
                    <param index="1">Seconds (decimal)</param>
                    <param index="2">Empty</param>
lm's avatar
lm committed
371
                    <param index="3">Radius around MISSION, in meters. If positive loiter clockwise, else counter-clockwise</param>
lm's avatar
lm committed
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
                    <param index="4">Desired yaw angle.</param>
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="20" name="MAV_CMD_NAV_RETURN_TO_LAUNCH">
                    <description>Return to launch location</description>
                    <param index="1">Empty</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="21" name="MAV_CMD_NAV_LAND">
                    <description>Land at location</description>
                    <param index="1">Empty</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Desired yaw angle.</param>
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="22" name="MAV_CMD_NAV_TAKEOFF">
                    <description>Takeoff from ground / hand</description>
                    <param index="1">Minimum pitch (if airspeed sensor present), desired pitch without sensor</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Yaw angle (if magnetometer present), ignored without magnetometer</param>
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="80" name="MAV_CMD_NAV_ROI">
                    <description>Sets the region of interest (ROI) for a sensor set or the
LM's avatar
LM committed
409 410 411
            vehicle itself. This can then be used by the vehicles control
            system to control the vehicle attitude and the attitude of various
            sensors such as cameras.</description>
lm's avatar
lm committed
412
                    <param index="1">Region of intereset mode. (see MAV_ROI enum)</param>
lm's avatar
lm committed
413
                    <param index="2">MISSION index/ target ID. (see MAV_ROI enum)</param>
lm's avatar
lm committed
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
                    <param index="3">ROI index (allows a vehicle to manage multiple ROI's)</param>
                    <param index="4">Empty</param>
                    <param index="5">x the location of the fixed ROI (see MAV_FRAME)</param>
                    <param index="6">y</param>
                    <param index="7">z</param>
               </entry>
               <entry value="81" name="MAV_CMD_NAV_PATHPLANNING">
                    <description>Control autonomous path planning on the MAV.</description>
                    <param index="1">0: Disable local obstacle avoidance / local path planning (without resetting map), 1: Enable local path planning, 2: Enable and reset local path planning</param>
                    <param index="2">0: Disable full path planning (without resetting map), 1: Enable, 2: Enable and reset map/occupancy grid, 3: Enable and reset planned route, but not occupancy grid</param>
                    <param index="3">Empty</param>
                    <param index="4">Yaw angle at goal, in compass degrees, [0..360]</param>
                    <param index="5">Latitude/X of goal</param>
                    <param index="6">Longitude/Y of goal</param>
                    <param index="7">Altitude/Z of goal</param>
               </entry>
               <entry value="95" name="MAV_CMD_NAV_LAST">
                    <description>NOP - This command is only used to mark the upper limit of the NAV/ACTION commands in the enumeration</description>
                    <param index="1">Empty</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="112" name="MAV_CMD_CONDITION_DELAY">
                    <description>Delay mission state machine.</description>
                    <param index="1">Delay in seconds (decimal)</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="113" name="MAV_CMD_CONDITION_CHANGE_ALT">
                    <description>Ascend/descend at rate.  Delay mission state machine until desired altitude reached.</description>
                    <param index="1">Descent / Ascend rate (m/s)</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Finish Altitude</param>
               </entry>
               <entry value="114" name="MAV_CMD_CONDITION_DISTANCE">
                    <description>Delay mission state machine until within desired distance of next NAV point.</description>
                    <param index="1">Distance (meters)</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="115" name="MAV_CMD_CONDITION_YAW">
                    <description>Reach a certain target angle.</description>
                    <param index="1">target angle: [0-360], 0 is north</param>
                    <param index="2">speed during yaw change:[deg per second]</param>
                    <param index="3">direction: negative: counter clockwise, positive: clockwise [-1,1]</param>
                    <param index="4">relative offset or absolute angle: [ 1,0]</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="159" name="MAV_CMD_CONDITION_LAST">
                    <description>NOP - This command is only used to mark the upper limit of the CONDITION commands in the enumeration</description>
                    <param index="1">Empty</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="176" name="MAV_CMD_DO_SET_MODE">
                    <description>Set system mode.</description>
                    <param index="1">Mode, as defined by ENUM MAV_MODE</param>
LM's avatar
LM committed
493
                    <param index="2">Empty</param>
lm's avatar
lm committed
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="177" name="MAV_CMD_DO_JUMP">
                    <description>Jump to the desired command in the mission list.  Repeat this action only the specified number of times</description>
                    <param index="1">Sequence number</param>
                    <param index="2">Repeat count</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="178" name="MAV_CMD_DO_CHANGE_SPEED">
                    <description>Change speed and/or throttle set points.</description>
                    <param index="1">Speed type (0=Airspeed, 1=Ground Speed)</param>
                    <param index="2">Speed  (m/s, -1 indicates no change)</param>
                    <param index="3">Throttle  ( Percent, -1 indicates no change)</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="179" name="MAV_CMD_DO_SET_HOME">
                    <description>Changes the home location either to the current location or a specified location.</description>
                    <param index="1">Use current (1=use current location, 0=use specified location)</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Latitude</param>
                    <param index="6">Longitude</param>
                    <param index="7">Altitude</param>
               </entry>
               <entry value="180" name="MAV_CMD_DO_SET_PARAMETER">
                    <description>Set a system parameter.  Caution!  Use of this command requires knowledge of the numeric enumeration value of the parameter.</description>
                    <param index="1">Parameter number</param>
                    <param index="2">Parameter value</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="181" name="MAV_CMD_DO_SET_RELAY">
                    <description>Set a relay to a condition.</description>
                    <param index="1">Relay number</param>
                    <param index="2">Setting (1=on, 0=off, others possible depending on system hardware)</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="182" name="MAV_CMD_DO_REPEAT_RELAY">
                    <description>Cycle a relay on and off for a desired number of cyles with a desired period.</description>
                    <param index="1">Relay number</param>
                    <param index="2">Cycle count</param>
                    <param index="3">Cycle time (seconds, decimal)</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="183" name="MAV_CMD_DO_SET_SERVO">
                    <description>Set a servo to a desired PWM value.</description>
                    <param index="1">Servo number</param>
                    <param index="2">PWM (microseconds, 1000 to 2000 typical)</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="184" name="MAV_CMD_DO_REPEAT_SERVO">
                    <description>Cycle a between its nominal setting and a desired PWM for a desired number of cycles with a desired period.</description>
                    <param index="1">Servo number</param>
                    <param index="2">PWM (microseconds, 1000 to 2000 typical)</param>
                    <param index="3">Cycle count</param>
                    <param index="4">Cycle time (seconds)</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="200" name="MAV_CMD_DO_CONTROL_VIDEO">
                    <description>Control onboard camera system.</description>
                    <param index="1">Camera ID (-1 for all)</param>
                    <param index="2">Transmission: 0: disabled, 1: enabled compressed, 2: enabled raw</param>
                    <param index="3">Transmission mode: 0: video stream, >0: single images every n seconds (decimal)</param>
                    <param index="4">Recording: 0: disabled, 1: enabled compressed, 2: enabled raw</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="240" name="MAV_CMD_DO_LAST">
                    <description>NOP - This command is only used to mark the upper limit of the DO commands in the enumeration</description>
                    <param index="1">Empty</param>
                    <param index="2">Empty</param>
                    <param index="3">Empty</param>
                    <param index="4">Empty</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
               <entry value="241" name="MAV_CMD_PREFLIGHT_CALIBRATION">
                    <description>Trigger calibration. This command will be only accepted if in pre-flight mode.</description>
                    <param index="1">Gyro calibration: 0: no, 1: yes</param>
                    <param index="2">Magnetometer calibration: 0: no, 1: yes</param>
                    <param index="3">Ground pressure: 0: no, 1: yes</param>
                    <param index="4">Radio calibration: 0: no, 1: yes</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
lm's avatar
lm committed
610 611 612 613 614 615 616 617 618 619
               <entry value="242" name="MAV_CMD_PREFLIGHT_SET_SENSOR_OFFSETS">
                    <description>Set sensor offsets. This command will be only accepted if in pre-flight mode.</description>
                    <param index="1">Sensor to adjust the offsets for: 0: gyros, 1: accelerometer, 2: magnetometer, 3: barometer, 4: optical flow</param>
                    <param index="2">X axis offset (or generic dimension 1), in the sensor's raw units</param>
                    <param index="3">Y axis offset (or generic dimension 2), in the sensor's raw units</param>
                    <param index="4">Z axis offset (or generic dimension 3), in the sensor's raw units</param>
                    <param index="5">Generic dimension 4, in the sensor's raw units</param>
                    <param index="6">Generic dimension 5, in the sensor's raw units</param>
                    <param index="7">Generic dimension 6, in the sensor's raw units</param>
               </entry>
lm's avatar
lm committed
620 621 622 623 624 625 626 627 628 629 630
               <entry value="245" name="MAV_CMD_PREFLIGHT_STORAGE">
                    <description>Request storage of different parameter values and logs. This command will be only accepted if in pre-flight mode.</description>
                    <param index="1">Parameter storage: 0: READ FROM FLASH/EEPROM, 1: WRITE CURRENT TO FLASH/EEPROM</param>
                    <param index="2">Mission storage: 0: READ FROM FLASH/EEPROM, 1: WRITE CURRENT TO FLASH/EEPROM</param>
                    <param index="3">Reserved</param>
                    <param index="4">Reserved</param>
                    <param index="5">Empty</param>
                    <param index="6">Empty</param>
                    <param index="7">Empty</param>
               </entry>
          </enum>
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
          <enum name="MAV_DATA_STREAM">
               <description>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.
     </description>
               <entry value="0" name="MAV_DATA_STREAM_ALL">
                    <description>Enable all data streams</description>
               </entry>
               <entry value="1" name="MAV_DATA_STREAM_RAW_SENSORS">
                    <description>Enable IMU_RAW, GPS_RAW, GPS_STATUS packets.</description>
               </entry>
               <entry value="2" name="MAV_DATA_STREAM_EXTENDED_STATUS">
                    <description>Enable GPS_STATUS, CONTROL_STATUS, AUX_STATUS</description>
               </entry>
               <entry value="3" name="MAV_DATA_STREAM_RC_CHANNELS">
                    <description>Enable RC_CHANNELS_SCALED, RC_CHANNELS_RAW, SERVO_OUTPUT_RAW</description>
               </entry>
               <entry value="4" name="MAV_DATA_STREAM_RAW_CONTROLLER">
                    <description>Enable ATTITUDE_CONTROLLER_OUTPUT, POSITION_CONTROLLER_OUTPUT, NAV_CONTROLLER_OUTPUT.</description>
               </entry>
               <entry value="6" name="MAV_DATA_STREAM_POSITION">
                    <description>Enable LOCAL_POSITION, GLOBAL_POSITION/GLOBAL_POSITION_INT messages.</description>
               </entry>
               <entry value="10" name="MAV_DATA_STREAM_EXTRA1">
                    <description>Dependent on the autopilot</description>
               </entry>
               <entry value="11" name="MAV_DATA_STREAM_EXTRA2">
                    <description>Dependent on the autopilot</description>
               </entry>
               <entry value="12" name="MAV_DATA_STREAM_EXTRA3">
                    <description>Dependent on the autopilot</description>
               </entry>
          </enum>
          <enum name="MAV_ROI">
               <description> The ROI (region of interest) for the vehicle. This can be
                be used by the vehicle for camera/vehicle attitude alignment (see
                MAV_CMD_NAV_ROI).
            </description>
               <entry value="0" name="MAV_ROI_NONE">
                    <description>No region of interest.</description>
               </entry>
               <entry value="1" name="MAV_ROI_WPNEXT">
lm's avatar
lm committed
673
                    <description>Point toward next MISSION.</description>
674 675
               </entry>
               <entry value="2" name="MAV_ROI_WPINDEX">
lm's avatar
lm committed
676
                    <description>Point toward given MISSION.</description>
677 678 679 680 681 682 683 684
               </entry>
               <entry value="3" name="MAV_ROI_LOCATION">
                    <description>Point toward fixed location.</description>
               </entry>
               <entry value="4" name="MAV_ROI_TARGET">
                    <description>Point toward of given id.</description>
               </entry>
          </enum>
lm's avatar
lm committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
          <enum name="MAV_CMD_ACK">
               <description>ACK / NACK / ERROR values as a result of MAV_CMDs and for mission item transmission.</description>
               <entry name="MAV_CMD_ACK_OK">
                    <description>Command / mission item is ok.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_FAIL">
                    <description>Generic error message if none of the other reasons fails or if no detailed error reporting is implemented.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_ACCESS_DENIED">
                    <description>The system is refusing to accept this command from this source / communication partner.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_NOT_SUPPORTED">
                    <description>Command or mission item is not supported, other commands would be accepted.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_COORDINATE_FRAME_NOT_SUPPORTED">
                    <description>The coordinate frame of this command / mission item is not supported.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_COORDINATES_OUT_OF_RANGE">
                    <description>The coordinate frame of this command is ok, but he coordinate values exceed the safety limits of this system. This is a generic error, please use the more specific error messages below if possible.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_X_LAT_OUT_OF_RANGE">
                    <description>The X or latitude value is out of range.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_Y_LON_OUT_OF_RANGE">
                    <description>The Y or longitude value is out of range.</description>
               </entry>
               <entry name="MAV_CMD_ACK_ERR_Z_ALT_OUT_OF_RANGE">
                    <description>The Z or altitude value is out of range.</description>
               </entry>
        </enum>
lm's avatar
lm committed
715 716 717 718 719
     </enums>
     <messages>
          <message id="0" name="HEARTBEAT">
               <description>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).</description>
               <field type="uint8_t" name="type">Type of the MAV (quadrotor, helicopter, etc., up to 15 types, defined in MAV_TYPE ENUM)</field>
720
               <field type="uint8_t" name="autopilot">Autopilot type / class. defined in MAV_CLASS ENUM</field>
721
               <field type="uint8_t" name="base_mode">System mode bitfield, see MAV_MODE_FLAGS ENUM in mavlink/include/mavlink_types.h</field>
lm's avatar
lm committed
722
               <field type="uint32_t" name="custom_mode">Navigation mode bitfield, see MAV_AUTOPILOT_CUSTOM_MODE ENUM for some examples. This field is autopilot-specific.</field>
723
               <field type="uint8_t" name="system_status">System status flag, see MAV_STATUS ENUM</field>
lm's avatar
lm committed
724 725
               <field type="uint8_t_mavlink_version" name="mavlink_version">MAVLink version</field>
          </message>
726 727
          <message id="1" name="SYS_STATUS">
               <description>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.</description>
lm's avatar
lm committed
728 729 730 731
               <field type="uint32_t" name="onboard_control_sensors_present" print_format="0x%04x">Bitmask showing which onboard controllers and sensors are present. Value of 0: not present. Value of 1: present. Indices: 0: 3D gyro, 1: 3D acc, 2: 3D mag, 3: absolute pressure, 4: differential pressure, 5: GPS, 6: optical flow, 7: computer vision position, 8: laser based position, 9: external ground-truth (Vicon or Leica). Controllers: 10: 3D angular rate control 11: attitude stabilization, 12: yaw position, 13: z/altitude control, 14: x/y position control, 15: motor outputs / control</field>
               <field type="uint32_t" name="onboard_control_sensors_enabled" print_format="0x%04x">Bitmask showing which onboard controllers and sensors are enabled:  Value of 0: not enabled. Value of 1: enabled. Indices: 0: 3D gyro, 1: 3D acc, 2: 3D mag, 3: absolute pressure, 4: differential pressure, 5: GPS, 6: optical flow, 7: computer vision position, 8: laser based position, 9: external ground-truth (Vicon or Leica). Controllers: 10: 3D angular rate control 11: attitude stabilization, 12: yaw position, 13: z/altitude control, 14: x/y position control, 15: motor outputs / control</field>
               <field type="uint32_t" name="onboard_control_sensors_health" print_format="0x%04x">Bitmask showing which onboard controllers and sensors are operational or have an error:  Value of 0: not enabled. Value of 1: enabled. Indices: 0: 3D gyro, 1: 3D acc, 2: 3D mag, 3: absolute pressure, 4: differential pressure, 5: GPS, 6: optical flow, 7: computer vision position, 8: laser based position, 9: external ground-truth (Vicon or Leica). Controllers: 10: 3D angular rate control 11: attitude stabilization, 12: yaw position, 13: z/altitude control, 14: x/y position control, 15: motor outputs / control</field>
               <field type="uint16_t" name="load">Maximum usage in percent of the mainloop time, (0%: 0, 100%: 1000) should be always below 1000</field>
732
               <field type="uint16_t" name="voltage_battery">Battery voltage, in millivolts (1 = 1 millivolt)</field>
733
               <field type="int16_t" name="current_battery">Battery current, in 10*milliamperes (1 = 10 milliampere), -1: autopilot does not measure the current</field>
LM's avatar
LM committed
734 735
               <field type="int8_t" name="battery_remaining">Remaining battery energy: (0%: 0, 100%: 100), -1: autopilot estimate the remaining battery</field>
               <field type="uint16_t" name="drop_rate_comm">Communication drops in percent, (0%: 0, 100%: 10'000), (UART, I2C, SPI, CAN), dropped packets on all links (packets that were corrupted on reception on the MAV)</field>
736 737 738 739 740
               <field type="uint16_t" name="errors_comm">Communication errors (UART, I2C, SPI, CAN), dropped packets on all links (packets that were corrupted on reception on the MAV)</field>
               <field type="uint16_t" name="errors_count1">Autopilot-specific errors</field>
               <field type="uint16_t" name="errors_count2">Autopilot-specific errors</field>
               <field type="uint16_t" name="errors_count3">Autopilot-specific errors</field>
               <field type="uint16_t" name="errors_count4">Autopilot-specific errors</field>
741 742
          </message>
          
lm's avatar
lm committed
743 744
          <message id="2" name="SYSTEM_TIME">
               <description>The system time is the time of the master clock, typically the computer clock of the main onboard computer.</description>
745
               <field type="uint64_t" name="time_unix_usec">Timestamp of the master clock in microseconds since UNIX epoch.</field>
746 747 748 749
               <field type="uint32_t" name="time_boot_ms">Timestamp of the component clock since boot time in milliseconds.</field>
          </message>
          <!-- FIXME to be removed / merged with SYSTEM_TIME -->
          <message id="4" name="PING">
lm's avatar
lm committed
750
               <description>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.</description>
751
               <field type="uint64_t" name="time_usec">Unix timestamp in microseconds</field>
lm's avatar
lm committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
               <field type="uint32_t" name="seq">PING sequence</field>
               <field type="uint8_t" name="target_system">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</field>
               <field type="uint8_t" name="target_component">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</field>
          </message>
          <message id="5" name="CHANGE_OPERATOR_CONTROL">
               <description>Request to control this MAV</description>
               <field type="uint8_t" name="target_system">System the GCS requests control for</field>
               <field type="uint8_t" name="control_request">0: request control of this MAV, 1: Release control of this MAV</field>
               <field type="uint8_t" name="version">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.</field>
               <field type="char[25]" name="passkey">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 "!?,.-"</field>
          </message>
          <message id="6" name="CHANGE_OPERATOR_CONTROL_ACK">
               <description>Accept / deny control of this MAV</description>
               <field type="uint8_t" name="gcs_system_id">ID of the GCS this message </field>
               <field type="uint8_t" name="control_request">0: request control of this MAV, 1: Release control of this MAV</field>
               <field type="uint8_t" name="ack">0: ACK, 1: NACK: Wrong passkey, 2: NACK: Unsupported passkey encryption method, 3: NACK: Already under control</field>
          </message>
          <message id="7" name="AUTH_KEY">
               <description>Emit an encrypted signature / key identifying this system. PLEASE NOTE: This protocol has been kept simple, so transmitting the key requires an encrypted channel for true safety.</description>
               <field type="char[32]" name="key">key</field>
          </message>
          <message id="11" name="SET_MODE">
774
               <description>Set the system mode, as defined by enum MAV_MODE. There is no target component id as the mode is by definition for the overall aircraft, not only for one component.</description>
775 776 777
               <field type="uint8_t" name="target_system">The system setting the mode</field>
               <field type="uint8_t" name="base_mode">The new base mode</field>
               <field type="uint16_t" name="custom_mode">The new autopilot-specific mode. This field can be ignored by an autopilot.</field>
lm's avatar
lm committed
778 779 780 781 782
          </message>
          <message id="20" name="PARAM_REQUEST_READ">
               <description>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.</description>
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
LM's avatar
LM committed
783
               <field type="char[16]" name="param_id">Onboard parameter id</field>
lm's avatar
lm committed
784 785 786 787 788 789 790 791 792
               <field type="int16_t" name="param_index">Parameter index. Send -1 to use the param ID field as identifier</field>
          </message>
          <message id="21" name="PARAM_REQUEST_LIST">
               <description>Request all parameters of this component. After his request, all parameters are emitted.</description>
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
          </message>
          <message id="22" name="PARAM_VALUE">
               <description>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.</description>
LM's avatar
LM committed
793
               <field type="char[16]" name="param_id">Onboard parameter id</field>
lm's avatar
lm committed
794
               <field type="float" name="param_value">Onboard parameter value</field>
795
               <field type="uint8_t" name="param_type">Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t</field>
lm's avatar
lm committed
796 797 798 799 800 801 802
               <field type="uint16_t" name="param_count">Total number of onboard parameters</field>
               <field type="uint16_t" name="param_index">Index of this onboard parameter</field>
          </message>
          <message id="23" name="PARAM_SET">
               <description>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.</description>
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
LM's avatar
LM committed
803
               <field type="char[16]" name="param_id">Onboard parameter id</field>
lm's avatar
lm committed
804
               <field type="float" name="param_value">Onboard parameter value</field>
805
               <field type="uint8_t" name="param_type">Onboard parameter type: 0: float, 1: uint8_t, 2: int8_t, 3: uint16_t, 4: int16_t, 5: uint32_t, 6: int32_t</field>
lm's avatar
lm committed
806
          </message>
lm's avatar
lm committed
807
          <message id="24" name="GPS_RAW_INT">
lm's avatar
lm committed
808
               <description>The global position, as returned by the Global Positioning System (GPS). This is
809 810
                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)
            </description>
811
               <field type="uint64_t" name="time_usec">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
lm's avatar
lm committed
812 813 814
               <field type="uint8_t" name="fix_type">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.</field>
               <field type="int32_t" name="lat">Latitude in 1E7 degrees</field>
               <field type="int32_t" name="lon">Longitude in 1E7 degrees</field>
LM's avatar
LM committed
815 816 817 818
               <field type="int32_t" name="alt">Altitude in 1E3 meters (millimeters) above MSL</field>
               <field type="uint16_t" name="eph">GPS HDOP horizontal dilution of position in cm (m*100). If unknown, set to: 65535</field>
               <field type="uint16_t" name="epv">GPS VDOP horizontal dilution of position in cm (m*100). If unknown, set to: 65535</field>
               <field type="uint16_t" name="vel">GPS ground speed (m/s * 100). If unknown, set to: 65535</field>
819
               <field type="uint16_t" name="cog">Course over ground (NOT heading, but direction of movement) in degrees * 100, 0.0..359.99 degrees. If unknown, set to: 65535</field>
LM's avatar
LM committed
820
               <field type="uint8_t" name="satellites_visible">Number of satellites visible. If unknown, set to 255</field>
lm's avatar
lm committed
821
          </message>
lm's avatar
lm committed
822
          <message id="25" name="GPS_STATUS">
823 824 825 826 827 828 829 830
               <description>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.</description>
               <field type="uint8_t" name="satellites_visible">Number of satellites visible</field>
               <field type="uint8_t[20]" name="satellite_prn">Global satellite ID</field>
               <field type="uint8_t[20]" name="satellite_used">0: Satellite not used, 1: used for localization</field>
               <field type="uint8_t[20]" name="satellite_elevation">Elevation (0: right on top of receiver, 90: on the horizon) of satellite</field>
               <field type="uint8_t[20]" name="satellite_azimuth">Direction of satellite, 0: 0 deg, 255: 360 deg.</field>
               <field type="uint8_t[20]" name="satellite_snr">Signal to noise ratio of satellite</field>
          </message>
lm's avatar
lm committed
831
          <message id="26" name="SCALED_IMU">
lm's avatar
lm committed
832
               <description>The RAW IMU readings for the usual 9DOF sensor setup. This message should contain the scaled values to the described units</description>
833
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
lm's avatar
lm committed
834 835 836 837 838 839 840 841 842 843
               <field type="int16_t" name="xacc">X acceleration (mg)</field>
               <field type="int16_t" name="yacc">Y acceleration (mg)</field>
               <field type="int16_t" name="zacc">Z acceleration (mg)</field>
               <field type="int16_t" name="xgyro">Angular speed around X axis (millirad /sec)</field>
               <field type="int16_t" name="ygyro">Angular speed around Y axis (millirad /sec)</field>
               <field type="int16_t" name="zgyro">Angular speed around Z axis (millirad /sec)</field>
               <field type="int16_t" name="xmag">X Magnetic field (milli tesla)</field>
               <field type="int16_t" name="ymag">Y Magnetic field (milli tesla)</field>
               <field type="int16_t" name="zmag">Z Magnetic field (milli tesla)</field>
          </message>
lm's avatar
lm committed
844
          <message id="27" name="RAW_IMU">
lm's avatar
lm committed
845
               <description>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.</description>
846
               <field type="uint64_t" name="time_usec">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
lm's avatar
lm committed
847 848 849 850 851 852 853 854 855 856
               <field type="int16_t" name="xacc">X acceleration (raw)</field>
               <field type="int16_t" name="yacc">Y acceleration (raw)</field>
               <field type="int16_t" name="zacc">Z acceleration (raw)</field>
               <field type="int16_t" name="xgyro">Angular speed around X axis (raw)</field>
               <field type="int16_t" name="ygyro">Angular speed around Y axis (raw)</field>
               <field type="int16_t" name="zgyro">Angular speed around Z axis (raw)</field>
               <field type="int16_t" name="xmag">X Magnetic field (raw)</field>
               <field type="int16_t" name="ymag">Y Magnetic field (raw)</field>
               <field type="int16_t" name="zmag">Z Magnetic field (raw)</field>
          </message>
lm's avatar
lm committed
857
          <message id="28" name="RAW_PRESSURE">
lm's avatar
lm committed
858
               <description>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.</description>
859
               <field type="uint64_t" name="time_usec">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
lm's avatar
lm committed
860 861 862 863 864
               <field type="int16_t" name="press_abs">Absolute pressure (raw)</field>
               <field type="int16_t" name="press_diff1">Differential pressure 1 (raw)</field>
               <field type="int16_t" name="press_diff2">Differential pressure 2 (raw)</field>
               <field type="int16_t" name="temperature">Raw Temperature measurement (raw)</field>
          </message>
lm's avatar
lm committed
865
          <message id="29" name="SCALED_PRESSURE">
lm's avatar
lm committed
866
               <description>The pressure readings for the typical setup of one absolute and differential pressure sensor. The units are as specified in each field.</description>
867
               <field type="uint32_t" name="time_boot_ms">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
lm's avatar
lm committed
868 869 870 871
               <field type="float" name="press_abs">Absolute pressure (hectopascal)</field>
               <field type="float" name="press_diff">Differential pressure 1 (hectopascal)</field>
               <field type="int16_t" name="temperature">Temperature measurement (0.01 degrees celsius)</field>
          </message>
lm's avatar
lm committed
872
          <message id="30" name="ATTITUDE">
lm's avatar
lm committed
873
               <description>The attitude in the aeronautical frame (right-handed, Z-down, X-front, Y-right).</description>
874
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
lm's avatar
lm committed
875 876 877 878 879 880 881
               <field type="float" name="roll">Roll angle (rad)</field>
               <field type="float" name="pitch">Pitch angle (rad)</field>
               <field type="float" name="yaw">Yaw angle (rad)</field>
               <field type="float" name="rollspeed">Roll angular speed (rad/s)</field>
               <field type="float" name="pitchspeed">Pitch angular speed (rad/s)</field>
               <field type="float" name="yawspeed">Yaw angular speed (rad/s)</field>
          </message>
lm's avatar
lm committed
882 883 884 885 886 887 888 889 890 891 892 893 894
          <message id="31" name="ATTITUDE_QUATERNION">
               <description>The attitude in the aeronautical frame (right-handed, Z-down, X-front, Y-right), expressed as quaternion.</description>
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
               <field type="float" name="q1">Quaternion component 1</field>
               <field type="float" name="q2">Quaternion component 2</field>
               <field type="float" name="q3">Quaternion component 3</field>
               <field type="float" name="q4">Quaternion component 4</field>
               <field type="float" name="rollspeed">Roll angular speed (rad/s)</field>
               <field type="float" name="pitchspeed">Pitch angular speed (rad/s)</field>
               <field type="float" name="yawspeed">Yaw angular speed (rad/s)</field>
          </message>
          <message id="32" name="LOCAL_POSITION_NED">
               <description>The filtered local position (e.g. fused computer vision and accelerometers). Coordinate frame is right-handed, Z-axis down (aeronautical frame, NED / north-east-down convention)</description>
895
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
lm's avatar
lm committed
896 897 898 899 900 901 902
               <field type="float" name="x">X Position</field>
               <field type="float" name="y">Y Position</field>
               <field type="float" name="z">Z Position</field>
               <field type="float" name="vx">X Speed</field>
               <field type="float" name="vy">Y Speed</field>
               <field type="float" name="vz">Z Speed</field>
          </message>
lm's avatar
lm committed
903
          <message id="34" name="GLOBAL_POSITION_INT">
904 905 906 907 908 909
               <description>The filtered global position (e.g. fused GPS and accelerometers). The position is in GPS-frame (right-handed, Z-up). It
               is designed as scaled integer message since the resolution of float is not sufficient.</description>
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
               <field type="int32_t" name="lat">Latitude, expressed as * 1E7</field>
               <field type="int32_t" name="lon">Longitude, expressed as * 1E7</field>
               <field type="int32_t" name="alt">Altitude in meters, expressed as * 1000 (millimeters), above MSL</field>
lm's avatar
lm committed
910
               <field type="int32_t" name="relative_alt">Altitude above ground in meters, expressed as * 1000 (millimeters)</field>
911 912 913 914 915
               <field type="int16_t" name="vx">Ground X Speed (Latitude), expressed as m/s * 100</field>
               <field type="int16_t" name="vy">Ground Y Speed (Longitude), expressed as m/s * 100</field>
               <field type="int16_t" name="vz">Ground Z Speed (Altitude), expressed as m/s * 100</field>
               <field type="uint16_t" name="hdg">Compass heading in degrees * 100, 0.0..359.99 degrees. If unknown, set to: 65535</field>
          </message><message id="35" name="RC_CHANNELS_RAW">
lm's avatar
lm committed
916
               <description>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.</description>
917 918
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
               <field type="uint8_t" name="port">Servo output port (set of 8 outputs = 1 port). Most MAVs will just use one, but this allows to encode more than 8 servos.</field>
lm's avatar
lm committed
919 920 921 922 923 924 925 926 927 928 929 930
               <field type="uint16_t" name="chan1_raw">RC channel 1 value, in microseconds</field>
               <field type="uint16_t" name="chan2_raw">RC channel 2 value, in microseconds</field>
               <field type="uint16_t" name="chan3_raw">RC channel 3 value, in microseconds</field>
               <field type="uint16_t" name="chan4_raw">RC channel 4 value, in microseconds</field>
               <field type="uint16_t" name="chan5_raw">RC channel 5 value, in microseconds</field>
               <field type="uint16_t" name="chan6_raw">RC channel 6 value, in microseconds</field>
               <field type="uint16_t" name="chan7_raw">RC channel 7 value, in microseconds</field>
               <field type="uint16_t" name="chan8_raw">RC channel 8 value, in microseconds</field>
               <field type="uint8_t" name="rssi">Receive signal strength indicator, 0: 0%, 255: 100%</field>
          </message>
          <message id="36" name="RC_CHANNELS_SCALED">
               <description>The scaled values of the RC channels received. (-100%) -10000, (0%) 0, (100%) 10000</description>
931 932
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
               <field type="uint8_t" name="port">Servo output port (set of 8 outputs = 1 port). Most MAVs will just use one, but this allows to encode more than 8 servos.</field>
lm's avatar
lm committed
933 934 935 936 937 938 939 940 941 942 943 944
               <field type="int16_t" name="chan1_scaled">RC channel 1 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan2_scaled">RC channel 2 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan3_scaled">RC channel 3 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan4_scaled">RC channel 4 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan5_scaled">RC channel 5 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan6_scaled">RC channel 6 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan7_scaled">RC channel 7 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="int16_t" name="chan8_scaled">RC channel 8 value scaled, (-100%) -10000, (0%) 0, (100%) 10000</field>
               <field type="uint8_t" name="rssi">Receive signal strength indicator, 0: 0%, 255: 100%</field>
          </message>
          <message id="37" name="SERVO_OUTPUT_RAW">
               <description>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%.</description>
945 946
               <field type="uint32_t" name="time_usec">Timestamp (since UNIX epoch or microseconds since system boot)</field>
               <field type="uint8_t" name="port">Servo output port (set of 8 outputs = 1 port). Most MAVs will just use one, but this allows to encode more than 8 servos.</field>
lm's avatar
lm committed
947 948 949 950 951 952 953 954 955
               <field type="uint16_t" name="servo1_raw">Servo output 1 value, in microseconds</field>
               <field type="uint16_t" name="servo2_raw">Servo output 2 value, in microseconds</field>
               <field type="uint16_t" name="servo3_raw">Servo output 3 value, in microseconds</field>
               <field type="uint16_t" name="servo4_raw">Servo output 4 value, in microseconds</field>
               <field type="uint16_t" name="servo5_raw">Servo output 5 value, in microseconds</field>
               <field type="uint16_t" name="servo6_raw">Servo output 6 value, in microseconds</field>
               <field type="uint16_t" name="servo7_raw">Servo output 7 value, in microseconds</field>
               <field type="uint16_t" name="servo8_raw">Servo output 8 value, in microseconds</field>
          </message>
lm's avatar
lm committed
956 957 958
          <message id="39" name="MISSION_ITEM">
               <description>Message encoding a MISSION. This message is emitted to announce
                the presence of a MISSION and to set a MISSION on the system. The MISSION can be either in x, y, z meters (type: LOCAL) or x:lat, y:lon, z:altitude. Local frame is Z-down, right handed, global frame is Z-up, right handed
959
            </description>
lm's avatar
lm committed
960 961 962
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint16_t" name="seq">Sequence</field>
lm's avatar
lm committed
963 964
               <field type="uint8_t" name="frame">The coordinate system of the MISSION. see MAV_FRAME in mavlink_types.h</field>
               <field type="uint8_t" name="command">The scheduled action for the MISSION. see MAV_CMD in common.xml MAVLink specs</field>
lm's avatar
lm committed
965 966
               <field type="uint8_t" name="current">false:0, true:1</field>
               <field type="uint8_t" name="autocontinue">autocontinue to next wp</field>
lm's avatar
lm committed
967 968 969 970
               <field type="float" name="param1">PARAM1 / For NAV command MISSIONs: Radius in which the MISSION is accepted as reached, in meters</field>
               <field type="float" name="param2">PARAM2 / For NAV command MISSIONs: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds</field>
               <field type="float" name="param3">PARAM3 / For LOITER command MISSIONs: Orbit to circle around the MISSION, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.</field>
               <field type="float" name="param4">PARAM4 / For NAV and LOITER command MISSIONs: Yaw orientation in degrees, [0..360] 0 = NORTH</field>
lm's avatar
lm committed
971 972 973 974
               <field type="float" name="x">PARAM5 / local: x position, global: latitude</field>
               <field type="float" name="y">PARAM6 / y position: global: longitude</field>
               <field type="float" name="z">PARAM7 / z position: global: altitude</field>
          </message>
lm's avatar
lm committed
975 976
          <message id="40" name="MISSION_REQUEST">
               <description>Request the information of the MISSION with the sequence number seq. The response of the system to this message should be a MISSION message.</description>
lm's avatar
lm committed
977 978 979 980
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint16_t" name="seq">Sequence</field>
          </message>
lm's avatar
lm committed
981 982
          <message id="41" name="MISSION_SET_CURRENT">
               <description>Set the MISSION with sequence number seq as current MISSION. This means that the MAV will continue to this MISSION on the shortest path (not following the MISSIONs in-between).</description>
lm's avatar
lm committed
983 984 985 986
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint16_t" name="seq">Sequence</field>
          </message>
lm's avatar
lm committed
987 988
          <message id="42" name="MISSION_CURRENT">
               <description>Message that announces the sequence number of the current active MISSION. The MAV will fly towards this MISSION.</description>
lm's avatar
lm committed
989 990
               <field type="uint16_t" name="seq">Sequence</field>
          </message>
lm's avatar
lm committed
991 992
          <message id="43" name="MISSION_REQUEST_LIST">
               <description>Request the overall list of MISSIONs from the system/component.</description>
lm's avatar
lm committed
993 994 995
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
          </message>
lm's avatar
lm committed
996 997
          <message id="44" name="MISSION_COUNT">
               <description>This message is emitted as response to MISSION_REQUEST_LIST by the MAV. The GCS can then request the individual MISSIONs based on the knowledge of the total number of MISSIONs.</description>
lm's avatar
lm committed
998 999
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
lm's avatar
lm committed
1000
               <field type="uint16_t" name="count">Number of MISSIONs in the Sequence</field>
lm's avatar
lm committed
1001
          </message>
lm's avatar
lm committed
1002 1003
          <message id="45" name="MISSION_CLEAR_ALL">
               <description>Delete all mission items at once.</description>
lm's avatar
lm committed
1004 1005 1006
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
          </message>
lm's avatar
lm committed
1007 1008
          <message id="46" name="MISSION_ITEM_REACHED">
               <description>A certain mission item 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 MISSION.</description>
lm's avatar
lm committed
1009 1010
               <field type="uint16_t" name="seq">Sequence</field>
          </message>
lm's avatar
lm committed
1011 1012
          <message id="47" name="MISSION_ACK">
               <description>Ack message during MISSION handling. The type field states if this message is a positive ack (type=0) or if an error happened (type=non-zero).</description>
lm's avatar
lm committed
1013 1014
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
lm's avatar
lm committed
1015
               <field type="uint8_t" name="type">0: OK, 1: generic error / not accepting mission commands at all right now, 2: coordinate frame is not supported, 3: command is not supported, 4: mission item exceeds storage space, 5: one of the parameters has an invalid value, 6: param1 has an invalid value, 7: param2 has an invalid value, 8: param3 has an invalid value, 9: param4 has an invalid value, 10: x/param5 has an invalid value, 11: y:param6 has an invalid value, 12: z:param7 has an invalid value, 13: received waypoint out of sequence, 14: not accepting any mission commands from this communication partner</field>
lm's avatar
lm committed
1016
          </message>
1017
          <message id="48" name="SET_GPS_GLOBAL_ORIGIN">
lm's avatar
lm committed
1018
               <description>As local MISSIONs exist, the global MISSION 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.</description>
lm's avatar
lm committed
1019 1020 1021 1022 1023
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="int32_t" name="latitude">global position * 1E7</field>
               <field type="int32_t" name="longitude">global position * 1E7</field>
               <field type="int32_t" name="altitude">global position * 1000</field>
          </message>
1024
          <message id="49" name="GPS_GLOBAL_ORIGIN">
lm's avatar
lm committed
1025 1026 1027 1028 1029
               <description>Once the MAV sets a new GPS-Local correspondence, this message announces the origin (0,0,0) position</description>
               <field type="int32_t" name="latitude">Latitude (WGS84), expressed as * 1E7</field>
               <field type="int32_t" name="longitude">Longitude (WGS84), expressed as * 1E7</field>
               <field type="int32_t" name="altitude">Altitude(WGS84), expressed as * 1000</field>
          </message>
1030
          <message id="50" name="SET_LOCAL_POSITION_SETPOINT">
lm's avatar
lm committed
1031
               <description>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/MISSION 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.</description>
lm's avatar
lm committed
1032 1033
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
lm's avatar
lm committed
1034
               <field type="uint8_t" name="coordinate_frame">Coordinate frame - valid values are only MAV_FRAME_LOCAL_NED or MAV_FRAME_LOCAL_ENU</field>
lm's avatar
lm committed
1035 1036 1037 1038 1039 1040 1041
               <field type="float" name="x">x position</field>
               <field type="float" name="y">y position</field>
               <field type="float" name="z">z position</field>
               <field type="float" name="yaw">Desired yaw angle</field>
          </message>
          <message id="51" name="LOCAL_POSITION_SETPOINT">
               <description>Transmit the current local setpoint of the controller to other MAVs (collision avoidance) and to the GCS.</description>
lm's avatar
lm committed
1042
               <field type="uint8_t" name="coordinate_frame">Coordinate frame - valid values are only MAV_FRAME_LOCAL_NED or MAV_FRAME_LOCAL_ENU</field>
lm's avatar
lm committed
1043 1044 1045 1046 1047
               <field type="float" name="x">x position</field>
               <field type="float" name="y">y position</field>
               <field type="float" name="z">z position</field>
               <field type="float" name="yaw">Desired yaw angle</field>
          </message>
1048 1049
          <message id="52" name="GLOBAL_POSITION_SETPOINT_INT">
               <description>Transmit the current local setpoint of the controller to other MAVs (collision avoidance) and to the GCS.</description>
lm's avatar
lm committed
1050
               <field type="uint8_t" name="coordinate_frame">Coordinate frame - valid values are only MAV_FRAME_GLOBAL or MAV_FRAME_GLOBAL_RELATIVE_ALT</field>
1051 1052 1053 1054
               <field type="int32_t" name="latitude">WGS84 Latitude position in degrees * 1E7</field>
               <field type="int32_t" name="longitude">WGS84 Longitude position in degrees * 1E7</field>
               <field type="int32_t" name="altitude">WGS84 Altitude in meters * 1000 (positive for up)</field>
               <field type="int16_t" name="yaw">Desired yaw angle in degrees * 100</field>
lm's avatar
lm committed
1055
          </message>
1056 1057
          <message id="53" name="SET_GLOBAL_POSITION_SETPOINT_INT">
               <description>Set the current global position setpoint.</description>
lm's avatar
lm committed
1058
               <field type="uint8_t" name="coordinate_frame">Coordinate frame - valid values are only MAV_FRAME_GLOBAL or MAV_FRAME_GLOBAL_RELATIVE_ALT</field>
1059 1060 1061 1062 1063 1064
               <field type="int32_t" name="latitude">WGS84 Latitude position in degrees * 1E7</field>
               <field type="int32_t" name="longitude">WGS84 Longitude position in degrees * 1E7</field>
               <field type="int32_t" name="altitude">WGS84 Altitude in meters * 1000 (positive for up)</field>
               <field type="int16_t" name="yaw">Desired yaw angle in degrees * 100</field>
          </message>
          <message id="54" name="SAFETY_SET_ALLOWED_AREA">
lm's avatar
lm committed
1065
               <description>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/MISSIONs to accept and which to reject. Safety areas are often enforced by national or competition regulations.</description>
lm's avatar
lm committed
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint8_t" name="frame">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.</field>
               <field type="float" name="p1x">x position 1 / Latitude 1</field>
               <field type="float" name="p1y">y position 1 / Longitude 1</field>
               <field type="float" name="p1z">z position 1 / Altitude 1</field>
               <field type="float" name="p2x">x position 2 / Latitude 2</field>
               <field type="float" name="p2y">y position 2 / Longitude 2</field>
               <field type="float" name="p2z">z position 2 / Altitude 2</field>
          </message>
1076
          <message id="55" name="SAFETY_ALLOWED_AREA">
lm's avatar
lm committed
1077 1078 1079 1080 1081 1082 1083 1084 1085
               <description>Read out the safety zone the MAV currently assumes.</description>
               <field type="uint8_t" name="frame">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.</field>
               <field type="float" name="p1x">x position 1 / Latitude 1</field>
               <field type="float" name="p1y">y position 1 / Longitude 1</field>
               <field type="float" name="p1z">z position 1 / Altitude 1</field>
               <field type="float" name="p2x">x position 2 / Latitude 2</field>
               <field type="float" name="p2y">y position 2 / Longitude 2</field>
               <field type="float" name="p2z">z position 2 / Altitude 2</field>
          </message>
1086
          <message id="56" name="SET_ROLL_PITCH_YAW_THRUST">
1087 1088 1089 1090 1091 1092
               <description>Set roll, pitch and yaw.</description>
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="float" name="roll">Desired roll angle in radians</field>
               <field type="float" name="pitch">Desired pitch angle in radians</field>
               <field type="float" name="yaw">Desired yaw angle in radians</field>
lm's avatar
lm committed
1093
               <field type="float" name="thrust">Collective thrust, normalized to 0 .. 1</field>
1094
          </message>
1095
          <message id="57" name="SET_ROLL_PITCH_YAW_SPEED_THRUST">
1096 1097 1098 1099 1100 1101
               <description>Set roll, pitch and yaw.</description>
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="float" name="roll_speed">Desired roll angular speed in rad/s</field>
               <field type="float" name="pitch_speed">Desired pitch angular speed in rad/s</field>
               <field type="float" name="yaw_speed">Desired yaw angular speed in rad/s</field>
lm's avatar
lm committed
1102
               <field type="float" name="thrust">Collective thrust, normalized to 0 .. 1</field>
1103
          </message>
1104
          <message id="58" name="ROLL_PITCH_YAW_THRUST_SETPOINT">
LM's avatar
LM committed
1105
               <description>Setpoint in roll, pitch, yaw currently active on the system.</description>
1106
               <field type="uint32_t" name="time_boot_ms">Timestamp in milliseconds since system boot</field>
LM's avatar
LM committed
1107 1108 1109
               <field type="float" name="roll">Desired roll angle in radians</field>
               <field type="float" name="pitch">Desired pitch angle in radians</field>
               <field type="float" name="yaw">Desired yaw angle in radians</field>
lm's avatar
lm committed
1110
               <field type="float" name="thrust">Collective thrust, normalized to 0 .. 1</field>
LM's avatar
LM committed
1111
          </message>
1112
          <message id="59" name="ROLL_PITCH_YAW_SPEED_THRUST_SETPOINT">
LM's avatar
LM committed
1113
               <description>Setpoint in rollspeed, pitchspeed, yawspeed currently active on the system.</description>
1114
               <field type="uint32_t" name="time_boot_ms">Timestamp in milliseconds since system boot</field>
LM's avatar
LM committed
1115 1116 1117
               <field type="float" name="roll_speed">Desired roll angular speed in rad/s</field>
               <field type="float" name="pitch_speed">Desired pitch angular speed in rad/s</field>
               <field type="float" name="yaw_speed">Desired yaw angular speed in rad/s</field>
lm's avatar
lm committed
1118
               <field type="float" name="thrust">Collective thrust, normalized to 0 .. 1</field>
lm's avatar
lm committed
1119 1120 1121
          </message>
          <message id="62" name="NAV_CONTROLLER_OUTPUT">
               <description>Outputs of the APM navigation controller. The primary use of this message is to check the response and signs
1122 1123
                of the controller before actual flight and to assist with tuning controller parameters 
            </description>
lm's avatar
lm committed
1124 1125 1126
               <field type="float" name="nav_roll">Current desired roll in degrees</field>
               <field type="float" name="nav_pitch">Current desired pitch in degrees</field>
               <field type="int16_t" name="nav_bearing">Current desired heading in degrees</field>
lm's avatar
lm committed
1127 1128
               <field type="int16_t" name="target_bearing">Bearing to current MISSION/target in degrees</field>
               <field type="uint16_t" name="wp_dist">Distance to active MISSION in meters</field>
lm's avatar
lm committed
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
               <field type="float" name="alt_error">Current altitude error in meters</field>
               <field type="float" name="aspd_error">Current airspeed error in meters/second</field>
               <field type="float" name="xtrack_error">Current crosstrack error on x-y plane in meters</field>
          </message>
          <message id="64" name="STATE_CORRECTION">
               <description>Corrects the systems state by adding an error correction term to the position and velocity, and by rotating the attitude by a correction angle.</description>
               <field type="float" name="xErr">x position error</field>
               <field type="float" name="yErr">y position error</field>
               <field type="float" name="zErr">z position error</field>
               <field type="float" name="rollErr">roll error (radians)</field>
               <field type="float" name="pitchErr">pitch error (radians)</field>
               <field type="float" name="yawErr">yaw error (radians)</field>
               <field type="float" name="vxErr">x velocity</field>
               <field type="float" name="vyErr">y velocity</field>
               <field type="float" name="vzErr">z velocity</field>
          </message>
          <message id="66" name="REQUEST_DATA_STREAM">
               <field type="uint8_t" name="target_system">The target requested to send the message stream.</field>
               <field type="uint8_t" name="target_component">The target requested to send the message stream.</field>
1148
               <field type="uint8_t" name="req_stream_id">The ID of the requested data stream</field>
lm's avatar
lm committed
1149 1150 1151
               <field type="uint16_t" name="req_message_rate">The requested interval between two messages of this type</field>
               <field type="uint8_t" name="start_stop">1 to start sending, 0 to stop sending.</field>
          </message>
1152 1153 1154 1155
          <message id="67" name="DATA_STREAM">
               <field type="uint8_t" name="stream_id">The ID of the requested data stream</field>
               <field type="uint16_t" name="message_rate">The requested interval between two messages of this type</field>
               <field type="uint8_t" name="on_off">1 stream is enabled, 0 stream is stopped.</field>
1156
          </message>
lm's avatar
lm committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
          <message id="69" name="MANUAL_CONTROL">
               <field type="uint8_t" name="target">The system to be controlled</field>
               <field type="float" name="roll">roll</field>
               <field type="float" name="pitch">pitch</field>
               <field type="float" name="yaw">yaw</field>
               <field type="float" name="thrust">thrust</field>
               <field type="uint8_t" name="roll_manual">roll control enabled auto:0, manual:1</field>
               <field type="uint8_t" name="pitch_manual">pitch auto:0, manual:1</field>
               <field type="uint8_t" name="yaw_manual">yaw auto:0, manual:1</field>
               <field type="uint8_t" name="thrust_manual">thrust auto:0, manual:1</field>
          </message>
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
          <message id="70" name="RC_CHANNELS_OVERRIDE">
               <description>The RAW values of the RC channels sent to the MAV to override info received from the RC radio. A value of -1 means no change to that channel. A value of 0 means control of that channel should be released back to the RC radio. The standard PPM modulation is as follows: 1000 microseconds: 0%, 2000 microseconds: 100%. Individual receivers/transmitters might violate this specification.</description>
               <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint16_t" name="chan1_raw">RC channel 1 value, in microseconds</field>
               <field type="uint16_t" name="chan2_raw">RC channel 2 value, in microseconds</field>
               <field type="uint16_t" name="chan3_raw">RC channel 3 value, in microseconds</field>
               <field type="uint16_t" name="chan4_raw">RC channel 4 value, in microseconds</field>
               <field type="uint16_t" name="chan5_raw">RC channel 5 value, in microseconds</field>
               <field type="uint16_t" name="chan6_raw">RC channel 6 value, in microseconds</field>
               <field type="uint16_t" name="chan7_raw">RC channel 7 value, in microseconds</field>
               <field type="uint16_t" name="chan8_raw">RC channel 8 value, in microseconds</field>
          </message>
lm's avatar
lm committed
1181 1182 1183 1184 1185 1186 1187 1188 1189
          <message id="74" name="VFR_HUD">
               <description>Metrics typically displayed on a HUD for fixed wing aircraft</description>
               <field type="float" name="airspeed">Current airspeed in m/s</field>
               <field type="float" name="groundspeed">Current ground speed in m/s</field>
               <field type="int16_t" name="heading">Current heading in degrees, in compass units (0..360, 0=north)</field>
               <field type="uint16_t" name="throttle">Current throttle setting in integer percent, 0 to 100</field>
               <field type="float" name="alt">Current altitude (MSL), in meters</field>
               <field type="float" name="climb">Current climb rate in meters/second</field>
          </message>
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
          <message id="75" name="COMMAND_SHORT">
               <description>Send a command with up to four parameters to the MAV</description>
               <field type="uint8_t" name="target_system">System which should execute the command</field>
               <field type="uint8_t" name="target_component">Component which should execute the command, 0 for all components</field>
               <field type="uint8_t" name="command">Command ID, as defined by MAV_CMD enum.</field>
               <field type="uint8_t" name="confirmation">0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)</field>
               <field type="float" name="param1">Parameter 1, as defined by MAV_CMD enum.</field>
               <field type="float" name="param2">Parameter 2, as defined by MAV_CMD enum.</field>
               <field type="float" name="param3">Parameter 3, as defined by MAV_CMD enum.</field>
               <field type="float" name="param4">Parameter 4, as defined by MAV_CMD enum.</field>
          </message>
          <message id="76" name="COMMAND_LONG">
lm's avatar
lm committed
1202 1203 1204 1205 1206 1207 1208 1209 1210
               <description>Send a command with up to four parameters to the MAV</description>
               <field type="uint8_t" name="target_system">System which should execute the command</field>
               <field type="uint8_t" name="target_component">Component which should execute the command, 0 for all components</field>
               <field type="uint8_t" name="command">Command ID, as defined by MAV_CMD enum.</field>
               <field type="uint8_t" name="confirmation">0: First transmission of this command. 1-255: Confirmation transmissions (e.g. for kill command)</field>
               <field type="float" name="param1">Parameter 1, as defined by MAV_CMD enum.</field>
               <field type="float" name="param2">Parameter 2, as defined by MAV_CMD enum.</field>
               <field type="float" name="param3">Parameter 3, as defined by MAV_CMD enum.</field>
               <field type="float" name="param4">Parameter 4, as defined by MAV_CMD enum.</field>
1211 1212 1213
               <field type="float" name="param5">Parameter 5, as defined by MAV_CMD enum.</field>
               <field type="float" name="param6">Parameter 6, as defined by MAV_CMD enum.</field>
               <field type="float" name="param7">Parameter 7, as defined by MAV_CMD enum.</field>
lm's avatar
lm committed
1214
          </message>
1215
          <message id="77" name="COMMAND_ACK">
lm's avatar
lm committed
1216 1217 1218 1219
               <description>Report status of a command. Includes feedback wether the command was executed</description>
               <field type="float" name="command">Current airspeed in m/s</field>
               <field type="float" name="result">1: Action ACCEPTED and EXECUTED, 1: Action TEMPORARY REJECTED/DENIED, 2: Action PERMANENTLY DENIED, 3: Action UNKNOWN/UNSUPPORTED, 4: Requesting CONFIRMATION</field>
          </message>
1220 1221 1222 1223 1224 1225 1226 1227
          
          <!--
          <message id="80" name="MISSION_ITEM">
          	   <description>One mission element following the MAV_CMD enumeration</description>
          	   <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint16_t" name="id">ID</field>
               <field type="uint16_t" name="id">Total count (size of total mission)</field>
lm's avatar
lm committed
1228 1229
               <field type="uint8_t" name="frame">The coordinate system of the MISSION. see MAV_FRAME in mavlink_types.h</field>
               <field type="uint8_t" name="command">The scheduled action for the MISSION. see MAV_COMMAND in common.xml MAVLink specs</field>
1230 1231
               <field type="uint8_t" name="current">false:0, true:1</field>
               <field type="uint8_t" name="autocontinue">autocontinue to next wp</field>
lm's avatar
lm committed
1232 1233 1234 1235
               <field type="float" name="param1">PARAM1 / For NAV command MISSIONs: Radius in which the MISSION is accepted as reached, in meters</field>
               <field type="float" name="param2">PARAM2 / For NAV command MISSIONs: Time that the MAV should stay inside the PARAM1 radius before advancing, in milliseconds</field>
               <field type="float" name="param3">PARAM3 / For LOITER command MISSIONs: Orbit to circle around the MISSION, in meters. If positive the orbit direction should be clockwise, if negative the orbit direction should be counter-clockwise.</field>
               <field type="float" name="param4">PARAM4 / For NAV and LOITER command MISSIONs: Yaw orientation in degrees, [0..360] 0 = NORTH</field>
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
               <field type="float" name="x">PARAM5 / local: x position, global: latitude</field>
               <field type="float" name="y">PARAM6 / y position: global: longitude</field>
               <field type="float" name="z">PARAM7 / z position: global: altitude</field>
          </message>
          <message id="81" name="MISSION_ACK">
               <description>ACK / NACK for one mission element or a whole mission</description>
          	   <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint8_t" name="mission_status"></field>
               <field type="uint16_t" name="begin_item"></field>
               <field type="uint16_t" name="end_item"></field>
               <field type="uint8_t" name="packet_seq"></field>
          </message>
          <message id="82" name="MISSION_REQUEST">
               <description>One mission element following the MAV_CMD enumeration</description>
          	   <field type="uint8_t" name="target_system">System ID</field>
               <field type="uint8_t" name="target_component">Component ID</field>
               <field type="uint8_t" name="mission_command">Command id: 0: read whole mission, 1: read mission from begin to end, 2: write mission items from begin to end, 3: clear mission.</field>
               <field type="uint16_t" name="begin_item"></field>
               <field type="uint16_t" name="end_item"></field>
          </message> -->
                    <message id="90" name="HIL_STATE">
            <description>Sent from simulation to autopilot. This packet is useful for high throughput
                applications such as hardware in the loop simulations.
            </description>
1261
            <field type="uint64_t" name="time_usec">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
            <field type="float" name="roll">Roll angle (rad)</field>
            <field type="float" name="pitch">Pitch angle (rad)</field>
            <field type="float" name="yaw">Yaw angle (rad)</field>
            <field type="float" name="rollspeed">Roll angular speed (rad/s)</field>
            <field type="float" name="pitchspeed">Pitch angular speed (rad/s)</field>
            <field type="float" name="yawspeed">Yaw angular speed (rad/s)</field>
            <field type="int32_t" name="lat">Latitude, expressed as * 1E7</field>
            <field type="int32_t" name="lon">Longitude, expressed as * 1E7</field>
            <field type="int32_t" name="alt">Altitude in meters, expressed as * 1000 (millimeters)</field>
            <field type="int16_t" name="vx">Ground X Speed (Latitude), expressed as m/s * 100</field>
            <field type="int16_t" name="vy">Ground Y Speed (Longitude), expressed as m/s * 100</field>
            <field type="int16_t" name="vz">Ground Z Speed (Altitude), expressed as m/s * 100</field>
            <field type="int16_t" name="xacc">X acceleration (mg)</field>
            <field type="int16_t" name="yacc">Y acceleration (mg)</field>
            <field type="int16_t" name="zacc">Z acceleration (mg)</field>
        </message>
        <message id="91" name="HIL_CONTROLS">
            <description>Sent from autopilot to simulation. Hardware in the loop control outputs</description>
1280
            <field name="time_usec" type="uint64_t">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
            <field name="roll_ailerons" type="float">Control output -1 .. 1</field>
            <field name="pitch_elevator" type="float">Control output -1 .. 1</field>
            <field name="yaw_rudder" type="float">Control output -1 .. 1</field>
            <field name="throttle" type="float">Throttle 0 .. 1</field>
            <field name="aux1" type="float">Aux 1, -1 .. 1</field>
            <field name="aux2" type="float">Aux 2, -1 .. 1</field>
            <field name="aux3" type="float">Aux 3, -1 .. 1</field>
            <field name="aux4" type="float">Aux 4, -1 .. 1</field>
            <field name="mode" type="uint8_t">System mode (MAV_MODE)</field>
            <field name="nav_mode" type="uint8_t">Navigation mode (MAV_NAV_MODE)</field>
        </message>
        <message id="92" name="HIL_RC_INPUTS_RAW">
               <description>Sent from simulation to autopilot. 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.</description>
1294
               <field type="uint64_t" name="time_usec">Timestamp (microseconds since UNIX epoch or microseconds since system boot)</field>
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
               <field type="uint16_t" name="chan1_raw">RC channel 1 value, in microseconds</field>
               <field type="uint16_t" name="chan2_raw">RC channel 2 value, in microseconds</field>
               <field type="uint16_t" name="chan3_raw">RC channel 3 value, in microseconds</field>
               <field type="uint16_t" name="chan4_raw">RC channel 4 value, in microseconds</field>
               <field type="uint16_t" name="chan5_raw">RC channel 5 value, in microseconds</field>
               <field type="uint16_t" name="chan6_raw">RC channel 6 value, in microseconds</field>
               <field type="uint16_t" name="chan7_raw">RC channel 7 value, in microseconds</field>
               <field type="uint16_t" name="chan8_raw">RC channel 8 value, in microseconds</field>
               <field type="uint16_t" name="chan9_raw">RC channel 9 value, in microseconds</field>
               <field type="uint16_t" name="chan10_raw">RC channel 10 value, in microseconds</field>
               <field type="uint16_t" name="chan11_raw">RC channel 11 value, in microseconds</field>
               <field type="uint16_t" name="chan12_raw">RC channel 12 value, in microseconds</field>
               <field type="uint8_t" name="rssi">Receive signal strength indicator, 0: 0%, 255: 100%</field>
          </message>
          <message id="100" name="OPTICAL_FLOW">
               <description>Optical flow from a flow sensor (e.g. optical mouse sensor)</description>
1311
               <field type="uint64_t" name="time_usec">Timestamp (UNIX)</field>
1312 1313 1314 1315 1316 1317 1318
               <field type="uint8_t" name="sensor_id">Sensor ID</field>
               <field type="int16_t" name="flow_x">Flow in pixels in x-sensor direction</field>
               <field type="int16_t" name="flow_y">Flow in pixels in y-sensor direction</field>
               <field type="uint8_t" name="quality">Optical flow quality / confidence. 0: bad, 255: maximum quality</field>
               <field type="float" name="ground_distance">Ground distance in meters</field>
          </message>
          <!-- MESSAGE IDs 150 - 240: Space for custom messages in individual projectname_messages.xml files -->
1319
          <message id="249" name="MEMORY_VECT">
LM's avatar
LM committed
1320 1321 1322 1323 1324 1325
               <description>Send raw controller memory. The use of this message is discouraged for normal packets, but a quite efficient way for testing new messages and getting experimental debug output.</description>
               <field type="uint16_t" name="address">Starting address of the debug variables</field>
               <field type="uint8_t" name="ver">Version code of the type variable. 0=unknown, type ignored and assumed int16_t. 1=as below</field>
               <field type="uint8_t" name="type">Type code of the memory variables. for ver = 1: 0=16 x int16_t, 1=16 x uint16_t, 2=16 x Q15, 3=16 x 1Q14</field>
               <field type="int8_t[32]" name="value">Memory contents at specified address</field>
          </message>
1326
          <message id="250" name="DEBUG_VECT">
lm's avatar
lm committed
1327
               <field type="char[10]" name="name">Name</field>
1328
               <field type="uint64_t" name="time_usec">Timestamp</field>
lm's avatar
lm committed
1329 1330 1331 1332
               <field type="float" name="x">x</field>
               <field type="float" name="y">y</field>
               <field type="float" name="z">z</field>
          </message>
1333
          <message id="251" name="NAMED_VALUE_FLOAT">
lm's avatar
lm committed
1334
               <description>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.</description>
1335
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
lm's avatar
lm committed
1336 1337 1338
               <field type="char[10]" name="name">Name of the debug variable</field>
               <field type="float" name="value">Floating point value</field>
          </message>
1339
          <message id="252" name="NAMED_VALUE_INT">
lm's avatar
lm committed
1340
               <description>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.</description>
1341
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
lm's avatar
lm committed
1342 1343 1344
               <field type="char[10]" name="name">Name of the debug variable</field>
               <field type="int32_t" name="value">Signed integer value</field>
          </message>
1345
          <message id="253" name="STATUSTEXT">
lm's avatar
lm committed
1346 1347
               <description>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).</description>
               <field type="uint8_t" name="severity">Severity of status, 0 = info message, 255 = critical fault</field>
LM's avatar
LM committed
1348
               <field type="char[50]" name="text">Status text message, without null termination character</field>
lm's avatar
lm committed
1349
          </message>
1350
          <message id="254" name="DEBUG">
lm's avatar
lm committed
1351
               <description>Send a debug value. The index is used to discriminate between values. These values show up in the plot of QGroundControl as DEBUG N.</description>
1352
               <field type="uint32_t" name="time_boot_ms">Timestamp (milliseconds since system boot)</field>
lm's avatar
lm committed
1353 1354 1355
               <field type="uint8_t" name="ind">index of debug variable</field>
               <field type="float" name="value">DEBUG value</field>
          </message>
1356 1357 1358 1359 1360 1361
          <message id="255" name="EXTENDED_MESSAGE">
               <description>Extended message spacer.</description>
               <field type="uint8_t" name="target_system">System which should execute the command</field>
               <field type="uint8_t" name="target_component">Component which should execute the command, 0 for all components</field>
               <field type="uint8_t" name="protocol_flags">Retransmission / ACK flags</field>
          </message>
lm's avatar
lm committed
1362
     </messages>
James Goppert's avatar
James Goppert committed
1363
</mavlink>