diff --git a/en/messages/all.md b/en/messages/all.md index f73780b05..ec7466bae 100644 --- a/en/messages/all.md +++ b/en/messages/all.md @@ -59,9 +59,9 @@ span.warning { Type | Defined | Included --- | --- | --- -[Messages](#messages) | 0 | 372 -[Enums](#enumerated-types) | 0 | 236 -[Commands](#mav_commands) | 218 | 0 +[Messages](#messages) | 0 | 371 +[Enums](#enumerated-types) | 0 | 234 +[Commands](#mav_commands) | 217 | 0 The following sections list all entities in the dialect (both included and defined in this file). diff --git a/en/messages/common.md b/en/messages/common.md index a4339c2a9..f43a10378 100644 --- a/en/messages/common.md +++ b/en/messages/common.md @@ -213,7 +213,6 @@ param_index | `uint16_t` | | Index of this onboard parameter Set a parameter value (write new value to permanent storage). The receiving component should acknowledge the new parameter value by broadcasting a [PARAM_VALUE](#PARAM_VALUE) message (broadcasting ensures that multiple GCS all have an up-to-date list of all parameters). If the sending GCS did not receive a [PARAM_VALUE](#PARAM_VALUE) within its timeout time, it should re-send the [PARAM_SET](#PARAM_SET) message. The parameter microservice is documented at https://mavlink.io/en/services/parameter.html. -[PARAM_SET](#PARAM_SET) may also be called within the context of a transaction (started with [MAV_CMD_PARAM_TRANSACTION](#MAV_CMD_PARAM_TRANSACTION)). Within a transaction the receiving component should respond with [PARAM_ACK_TRANSACTION](#PARAM_ACK_TRANSACTION) to the setter component (instead of broadcasting [PARAM_VALUE](#PARAM_VALUE)), and [PARAM_SET](#PARAM_SET) should be re-sent if this is ACK not received. Field Name | Type | Values | Description --- | --- | --- | --- @@ -5231,14 +5230,14 @@ Value | Name | Description ### PARAM_ACK {#PARAM_ACK} -Result from [PARAM_EXT_SET](#PARAM_EXT_SET) message (or a [PARAM_SET](#PARAM_SET) within a transaction). +Result from [PARAM_EXT_SET](#PARAM_EXT_SET) message. Value | Name | Description --- | --- | --- 0 | [PARAM_ACK_ACCEPTED](#PARAM_ACK_ACCEPTED) | Parameter value ACCEPTED and SET 1 | [PARAM_ACK_VALUE_UNSUPPORTED](#PARAM_ACK_VALUE_UNSUPPORTED) | Parameter value UNKNOWN/UNSUPPORTED 2 | [PARAM_ACK_FAILED](#PARAM_ACK_FAILED) | Parameter failed to set -3 | [PARAM_ACK_IN_PROGRESS](#PARAM_ACK_IN_PROGRESS) | Parameter value received but not yet set/accepted. A subsequent [PARAM_ACK_TRANSACTION](#PARAM_ACK_TRANSACTION) or [PARAM_EXT_ACK](#PARAM_EXT_ACK) with the final result will follow once operation is completed. This is returned immediately for parameters that take longer to set, indicating that the the parameter was received and does not need to be resent. +3 | [PARAM_ACK_IN_PROGRESS](#PARAM_ACK_IN_PROGRESS) | Parameter value received but not yet set/accepted. A subsequent [PARAM_EXT_ACK](#PARAM_EXT_ACK) with the final result will follow once operation is completed. This is returned immediately for parameters that take longer to set, indicating that the the parameter was received and does not need to be resent. ### CAMERA_MODE {#CAMERA_MODE} diff --git a/en/messages/development.md b/en/messages/development.md index ee4f9ac13..939a2e022 100644 --- a/en/messages/development.md +++ b/en/messages/development.md @@ -36,30 +36,14 @@ span.warning { Type | Defined | Included --- | --- | --- -[Messages](#messages) | 16 | 226 -[Enums](#enumerated-types) | 15 | 144 -[Commands](#mav_commands) | 173 | 0 +[Messages](#messages) | 15 | 226 +[Enums](#enumerated-types) | 13 | 144 +[Commands](#mav_commands) | 172 | 0 The following sections list all entities in the dialect (both included and defined in this file). ## Messages -### PARAM_ACK_TRANSACTION (19) — [WIP] {#PARAM_ACK_TRANSACTION} - -**WORK IN PROGRESS**: Do not use in stable production environments (it may change). - -Response from a [PARAM_SET](#PARAM_SET) message when it is used in a transaction. - -Field Name | Type | Values | Description ---- | --- | --- | --- -target_system | `uint8_t` | | Id of system that sent [PARAM_SET](#PARAM_SET) message. -target_component | `uint8_t` | | Id of system that sent [PARAM_SET](#PARAM_SET) message. -param_id | `char[16]` | | Parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars - applications have to provide 16+1 bytes storage if the ID is stored as string -param_value | `float` | | Parameter value (new value if [PARAM_ACCEPTED](#PARAM_ACCEPTED), current value otherwise) -param_type | `uint8_t` | [MAV_PARAM_TYPE](#MAV_PARAM_TYPE) | Parameter type. -param_result | `uint8_t` | [PARAM_ACK](#PARAM_ACK) | Result code. - - ### AIRSPEED (295) — [WIP] {#AIRSPEED} **WORK IN PROGRESS**: Do not use in stable production environments (it may change). @@ -344,29 +328,6 @@ Value | Name | Description 0 | [AIRSPEED_SENSOR_UNHEALTHY](#AIRSPEED_SENSOR_UNHEALTHY) | Airspeed sensor is unhealthy 1 | [AIRSPEED_SENSOR_USING](#AIRSPEED_SENSOR_USING) | True if the data from this sensor is being actively used by the flight controller for guidance, navigation or control. -### PARAM_TRANSACTION_TRANSPORT — [WIP] {#PARAM_TRANSACTION_TRANSPORT} - -**WORK IN PROGRESS**: Do not use in stable production environments (it may change). - -Possible transport layers to set and get parameters via mavlink during a parameter transaction. - -Value | Name | Description ---- | --- | --- -0 | [PARAM_TRANSACTION_TRANSPORT_PARAM](#PARAM_TRANSACTION_TRANSPORT_PARAM) | Transaction over param transport. -1 | [PARAM_TRANSACTION_TRANSPORT_PARAM_EXT](#PARAM_TRANSACTION_TRANSPORT_PARAM_EXT) | Transaction over param_ext transport. - -### PARAM_TRANSACTION_ACTION — [WIP] {#PARAM_TRANSACTION_ACTION} - -**WORK IN PROGRESS**: Do not use in stable production environments (it may change). - -Possible parameter transaction actions. - -Value | Name | Description ---- | --- | --- -0 | [PARAM_TRANSACTION_ACTION_START](#PARAM_TRANSACTION_ACTION_START) | Commit the current parameter transaction. -1 | [PARAM_TRANSACTION_ACTION_COMMIT](#PARAM_TRANSACTION_ACTION_COMMIT) | Commit the current parameter transaction. -2 | [PARAM_TRANSACTION_ACTION_CANCEL](#PARAM_TRANSACTION_ACTION_CANCEL) | Cancel the current parameter transaction. - ### MAV_STANDARD_MODE — [WIP] {#MAV_STANDARD_MODE} **WORK IN PROGRESS**: Do not use in stable production environments (it may change). @@ -643,19 +604,6 @@ Param (Label) | Description | Values 4 | | -### MAV_CMD_PARAM_TRANSACTION (900) — [WIP] {#MAV_CMD_PARAM_TRANSACTION} - -**WORK IN PROGRESS**: Do not use in stable production environments (it may change). - -Request to start or end a parameter transaction. Multiple kinds of transport layers can be used to exchange parameters in the transaction (param, param_ext and mavftp). The command response can either be a success/failure or an in progress in case the receiving side takes some time to apply the parameters. - -Param (Label) | Description | Values ---- | --- | --- -1 (Action) | Action to be performed (start, commit, cancel, etc.) | [PARAM_TRANSACTION_ACTION](#PARAM_TRANSACTION_ACTION) -2 (Transport) | Possible transport layers to set and get parameters via mavlink during a parameter transaction. | [PARAM_TRANSACTION_TRANSPORT](#PARAM_TRANSACTION_TRANSPORT) -3 (Transaction ID) | Identifier for a specific transaction. | - - ### MAV_CMD_ODID_SET_EMERGENCY (12900) — [WIP] {#MAV_CMD_ODID_SET_EMERGENCY} **WORK IN PROGRESS**: Do not use in stable production environments (it may change).