Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
3acd8d7
gimbal_v2: ROI location/none may be sent to gimbal device (mavlink#2616)
hamishwillee Sep 23, 2026
62d27d4
events: remove WIP status (mavlink#2587)
hamishwillee Sep 23, 2026
c8a0ef0
define_xml_element: update uAvionix range, add loweheiser (mavlink#2601)
hamishwillee Sep 23, 2026
b1151b1
xml_schema: document mission/fence/rally/command MAV_CMD attributes (…
hamishwillee Sep 23, 2026
6fd9930
parameter: param_id is 7-bit ASCII, ext param_value is raw bytes (mav…
hamishwillee Sep 23, 2026
418fb2c
offboard_control: fix SET_POSITION_TARGET_GLOBAL_INT capability row (…
hamishwillee Sep 23, 2026
122bad1
standard_modes: restart mode download if AVAILABLE_MODES.seq changes …
hamishwillee Sep 23, 2026
929505b
SUMMARY: add marsh and stemstudios dialects to sidebar (mavlink#2272,…
hamishwillee Sep 23, 2026
376c1c9
uavcan_interaction: request UAVCAN_NODE_INFO with MAV_CMD_REQUEST_MES…
hamishwillee Sep 23, 2026
343eb28
camera: requester commands are superseded, not deprecated (mavlink#2376)
hamishwillee Sep 23, 2026
6185a8e
events: fix MAV_EVENT_CURRENT_SEQUENCE_FLAGS link anchor
hamishwillee Sep 23, 2026
73a8d22
parameter: use PARAM_ERROR for invalid parameter requests; fix STATUS…
hamishwillee Sep 23, 2026
7c6d77e
Fix broken messages/index.md#dialects links; clarify prebuilt librari…
hamishwillee Sep 23, 2026
d84a8f8
gimbal_v2: remove GIMBAL_MANAGER_TRACK_* commands (removed from XML i…
hamishwillee Sep 23, 2026
8710200
gimbal: fix v1 page's link to Gimbal Protocol v2; fix typo
hamishwillee Sep 23, 2026
fe30089
parameter: add PARAM_ERROR and MAV_PARAM_ERROR to summary tables (mav…
hamishwillee Sep 23, 2026
36ed59a
payload: add RELAY_STATUS to generic payload table (mavlink#2391)
hamishwillee Sep 23, 2026
737d723
generate_libraries: remove broken link to messages/index.md heading
hamishwillee Sep 23, 2026
4dfb297
Apply batched suggestions from code review
hamishwillee Sep 23, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@
"SIYI",
"Skydio",
"STATUSTEXT",
"stemstudios",
"subcomponent",
"Synturian",
"SYSID",
Expand Down
4 changes: 3 additions & 1 deletion en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
- [MAVLink Id Assignment (sysid, compid)](services/mavlink_id_assignment.md)
- [Payload Protocols](services/payload.md)
- [Traffic Management (UTM/ADS-B)](services/traffic_management.md)
- [Events Interface (WIP)](services/events.md)
- [Events Interface](services/events.md)
- [Standard Flight Modes](services/standard_modes.md)
- [Time Synchronization](services/timesync.md)
- [Dialects & Tests](messages/dialects.md)
Expand All @@ -81,8 +81,10 @@
- [cubepilot.xml](messages/cubepilot.md)
- [icarous.xml](messages/icarous.md)
- [loweheiser.xml](messages/loweheiser.md)
- [marsh.xml](messages/marsh.md)
- [paparazzi.xml](messages/paparazzi.md)
- [storm32.xml](messages/storm32.md)
- [stemstudios.xml](messages/stemstudios.md)
- [uAvionix.xml](messages/uAvionix.md)
- [all.xml](messages/all.md)
- [python_array_test.xml](messages/python_array_test.md)
Expand Down
2 changes: 1 addition & 1 deletion en/getting_started/generate_libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For more information see [Supported Languages](../index.md#supported_languages).
## Pre-requisites

1. You must already have [Installed the MAVLink toolchain](../getting_started/installation.md), which includes the mavgenerate and mavgen tools used below as well as the [XML Message Definitions](../messages/index.md).
1. If you are generating messages for a [custom dialect](../messages/dialects.md), copy the dialect [XML definition file(s)](../messages/index.md#xml-definition-files--dialects) into the directory [message_definitions/v1.0/](https://github.com/mavlink/mavlink/tree/master/message_definitions/v1.0).
1. If you are generating messages for a [custom dialect](../messages/dialects.md), copy the dialect XML definition file(s) into the directory [message_definitions/v1.0/](https://github.com/mavlink/mavlink/tree/master/message_definitions/v1.0).

::: info
_mavgen_ can handle dialects that have relative paths for included XML files (e.g typically [common.xml](../messages/common.md)), but other generators may not.
Expand Down
2 changes: 1 addition & 1 deletion en/getting_started/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

Download or Generate MAVLink source files for your [dialect](../messages/index.md#dialects):
Download or Generate MAVLink source files for your [dialect](../messages/dialects.md#dialects):

- **Download the [pre-built MAVLink source files](../index.md#prebuilt_libraries)** if you're working in a C/C++ project and using standard dialects.
- **Generate the MAVLink source files** to use any other [supported language](../index.md#supported_languages), add/modify messages or dialects, or use the example scripts:
Expand Down
2 changes: 1 addition & 1 deletion en/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This topic explains how to install the [MAVLink toolchain](https://github.com/mavlink/mavlink). The toolchain includes the [XML message definitions](../messages/index.md) as well as the GUI/command line tools that use the definitions to [Generate MAVLink Source Files](../getting_started/generate_libraries.md).

::: tip
You do not need to install or generate the source files if you are using the C programming language and a standard [dialect](../messages/index.md#dialects).
You do not need to install or generate the source files if you are using the C programming language and [standard definitions](../messages/index.md) or a [dialect](../messages/dialects.md#dialects) published in the MAVLink repository.
Just get the [prebuilt libraries](../index.md#prebuilt_libraries) and then jump to [Using C Libraries](../mavgen_c/index.md).
:::

Expand Down
3 changes: 2 additions & 1 deletion en/guide/define_xml_element.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,8 @@ Allocated ranges are listed below (a more complete list is provided in the comme
| Dialect | Range |
| ----------------- | ------------- |
| Common.xml | 300 - 10000 |
| uAvionix.xml | 10001-10999 |
| uAvionix.xml | 10001 - 10049 |
| loweheiser.xml | 10150 - 10199 |
| ArduPilotMega.xml | 11000 - 11999 |
| icarous.xml | 42000 - 42999 |

Expand Down
2 changes: 1 addition & 1 deletion en/guide/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The scripts have the following requirements:
- Python 2.7+ and 3.3+
- `PYTHONPATH` specifies the directory path that contains the `mavlink` repository.
- Write access to the entire **mavlink** folder.
- Your [dialect](../messages/index.md#dialects)'s XML file is in `message_definitions/*/`
- Your XML definition file is in `message_definitions/*/`

The scripts can be executed by running Python with the `-m` switch, which indicates that the given script exists on the `PYTHONPATH`. The following code runs **mavlogdump.py** in **/pymavlink/tools/** on the recorded MAVLink stream `test_run.mavlink` (other scripts in **/tools** and **/scripts** can be run in a similar fashion):

Expand Down
2 changes: 1 addition & 1 deletion en/guide/uavcan_interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The bridge node must emit the message `UAVCAN_NODE_INFO` in the following cases:
(please read the UAVCAN specification for a more detailed description of the principles of bus monitoring):
- A new node has appeared online.
- A known node has restarted.
- Reception of the MAVLink command `MAV_CMD_UAVCAN_GET_NODE_INFO`.
- Reception of a [MAV_CMD_REQUEST_MESSAGE](../messages/common.md#MAV_CMD_REQUEST_MESSAGE) requesting `UAVCAN_NODE_INFO`.
In this case, the bridge node is required to emit `UAVCAN_NODE_INFO` once for every known node.
- It is also allowed, but not required, to unconditionally emit messages `UAVCAN_NODE_INFO` at a very low rate,
in order to guarantee that the remote equipment always has a valid model of the on-board UAVCAN bus.
Expand Down
8 changes: 7 additions & 1 deletion en/guide/xml_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ For example, see [MAV_CMD_NAV_PAYLOAD_PLACE](../messages/common.md#MAV_CMD_NAV_P
```xml
<enum name="MAV_CMD">
....
<entry value="94" name="MAV_CMD_NAV_PAYLOAD_PLACE" hasLocation="true" isDestination="true">
<entry value="94" name="MAV_CMD_NAV_PAYLOAD_PLACE" hasLocation="true" isDestination="true" mission="true" command="true">
<description>Descend and place payload. Vehicle moves to specified location, descends until it detects a hanging payload has reached the ground, and then releases the payload. If ground is not detected before the reaching the maximum descent value (param1), the command will complete without releasing the payload.</description>
<param index="1" label="Max Descent" units="m" minValue="0">Maximum distance to descend.</param>
<param index="2">Empty</param>
Expand All @@ -164,6 +164,12 @@ Attributes:
`hasLocation` should be applied if this is `true`.
- `hasAltitudeOnly`: A boolean (default `false`) that indicates the entry has altitude information in param 7 but no position information params 5 and 6 (e.g. [MAV_CMD_NAV_CONTINUE_AND_CHANGE_ALT](../messages/common.md#MAV_CMD_NAV_CONTINUE_AND_CHANGE_ALT)).
Mutually exclusive with `hasLocation`.
- `mission`: A boolean (default `false`) that indicates the entry can be used in a mission plan ([Mission Protocol](../services/mission.md)).
- `fence`: A boolean (default `false`) that indicates the entry can be used in a geofence plan.
- `rally`: A boolean (default `false`) that indicates the entry can be used in a rally point plan.
- `command`: A boolean (default `false`) that indicates the entry can be sent using the [Command Protocol](../services/command.md).

Any combination of `mission`, `fence`, `rally` and `command` may be set.

Nested elements:

Expand Down
2 changes: 1 addition & 1 deletion en/mavgen_c/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This topic explains how to get and use the library.

## Getting the C MAVLink Library {#get_libraries}

If you are using a [standard dialect](../messages/index.md#dialects) then download the _MAVLink 2_ library from Github: [c_library_v2](https://github.com/mavlink/c_library_v2).
If you are and XML definition file published in the MAVLink repository then download the _MAVLink 2_ library from Github: [c_library_v2](https://github.com/mavlink/c_library_v2).

::: tip
The MAVLink 2 library supports both MAVLink 2 and MAVLink 1, and is rebuilt for all the _standard dialects_ whenever any of the definitions in the _mavlink/mavlink_ repo change.
Expand Down
2 changes: 1 addition & 1 deletion en/mavgen_python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For custom dialects the library needs to be generated first.

### Get the Standard MAVLink Dialect

If you need a [standard dialect](../messages/index.md#dialects) then you can install these (for both MAVLink 1 and 2) with _pymavlink_ using _pip_:
If you need an XML definition file published in the MAVLink repository then you can install these (for both MAVLink 1 and 2) with _pymavlink_ using _pip_:

```sh
pip install pymavlink
Expand Down
4 changes: 2 additions & 2 deletions en/services/camera.md
Original file line number Diff line number Diff line change
Expand Up @@ -512,9 +512,9 @@ Other components like a GCS will typically only use the camera `BATTERY_STATUS.b
| <a id="MAV_CMD_CAMERA_TRACK_RECTANGLE"></a>[MAV_CMD_CAMERA_TRACK_RECTANGLE](../messages/common.md#MAV_CMD_CAMERA_TRACK_RECTANGLE) | Initiate visual rectangle tracking, if supported by the camera ([CAMERA_CAP_FLAGS_HAS_TRACKING_RECTANGLE](#CAMERA_CAP_FLAGS) is set). |
| <a id="MAV_CMD_CAMERA_STOP_TRACKING"></a>[MAV_CMD_CAMERA_STOP_TRACKING](../messages/common.md#MAV_CMD_CAMERA_STOP_TRACKING) | Stop camera tracking (as initiated using `MAV_CMD_CAMERA_TRACK_POINT` or `MAV_CMD_CAMERA_TRACK_RECTANGLE`). |

#### Deprecated Commands
#### Superseded Commands

These commands have been deprecated, replaced by the generic requester command [MAV_CMD_REQUEST_MESSAGE](#MAV_CMD_REQUEST_MESSAGE)
These commands have been superseded by the generic requester command [MAV_CMD_REQUEST_MESSAGE](#MAV_CMD_REQUEST_MESSAGE)

| Command | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
16 changes: 7 additions & 9 deletions en/services/events.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Events Interface (WIP)
# Events Interface

::: warning
The Events Interface is a work in progress and may change.
It has an initial implementation in PX4 and QGroundControl and is planned for ArduPilot.
::: info
The Events Interface is implemented in PX4 and QGroundControl.

The information below is just an overview.
Full details of the interface are provided in the: [Events Interface Proposal](https://docs.google.com/document/d/18qdDgfML97lItom09MJhngYnFzAm1zFdmlCKG7TaBpg/edit)
Expand Down Expand Up @@ -48,15 +47,14 @@ The following key features are provided by the interface:
| <a id="REQUEST_EVENT"></a>[REQUEST_EVENT](../messages/common.md#REQUEST_EVENT) | Request one or more events to be (re-)sent. If first_sequence==last_sequence, only a single event is requested. Note that first_sequence can be larger than last_sequence (because the sequence number can wrap). Each sequence will trigger an EVENT or EVENT_ERROR response. |
| <a id="RESPONSE_EVENT_ERROR"></a>[RESPONSE_EVENT_ERROR](../messages/common.md#RESPONSE_EVENT_ERROR) | Response to a [REQUEST_EVENT](#REQUEST_EVENT) if there is an error requesting an event, including the reason. The most common reason would be that the event is not longer available (has been discarded). |

| Enum | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <a id="MAV_EVENT_CURRENT_SEQUENCE_FLAGS"></a>[MAV_EVENT_CURRENT_SEQUENCE_FLAGS](../messages/common.md#CURRENT_EVENT_SEQUENCE) | Flags for [CURRENT_EVENT_SEQUENCE](#CURRENT_EVENT_SEQUENCE). For example, to indicate when the sequence has reset. |
| <a id="MAV_EVENT_ERROR_REASON"></a>[MAV_EVENT_ERROR_REASON](../messages/common.md#MAV_EVENT_ERROR_REASON) | Reasons for an error, as provided in [RESPONSE_EVENT_ERROR](#RESPONSE_EVENT_ERROR). For example, common error would be that the event is not available (i.e. it has been discarded). |
| Enum | Description |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <a id="MAV_EVENT_CURRENT_SEQUENCE_FLAGS"></a>[MAV_EVENT_CURRENT_SEQUENCE_FLAGS](../messages/common.md#MAV_EVENT_CURRENT_SEQUENCE_FLAGS) | Flags for [CURRENT_EVENT_SEQUENCE](#CURRENT_EVENT_SEQUENCE). For example, to indicate when the sequence has reset. |
| <a id="MAV_EVENT_ERROR_REASON"></a>[MAV_EVENT_ERROR_REASON](../messages/common.md#MAV_EVENT_ERROR_REASON) | Reasons for an error, as provided in [RESPONSE_EVENT_ERROR](#RESPONSE_EVENT_ERROR). For example, common error would be that the event is not available (i.e. it has been discarded). |

## Implementations

Implementation PRs and other information is listed below.
All of these should be considered prototypes/WIP.

- QGroundControl
- PR: [Events interface (first iteration) #9217](https://github.com/mavlink/qgroundcontrol/pull/9217)
Expand Down
2 changes: 1 addition & 1 deletion en/services/gimbal.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Gimbal Configuration Protocol (v1)

::: warning
This service definition has been superseded by [Gimbal Protocol v2](../services/gimbal.md) (gimbal manufacturers/GCSs/autopilots are expected to use the new API, but the old API is still in broad use, and there is no plan to for it to be removed).
This service definition has been superseded by [Gimbal Protocol v2](../services/gimbal_v2.md) (gimbal manufacturers/GCSs/autopilots are expected to use the new API, but the old API is still in broad use, and there is no plan for it to be removed).
:::

The gimbal configuration message set uses a number of commands and few special-purpose messages to configure a payload mount.
Expand Down
Loading
Loading