mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-05-26 01:17:51 +08:00
docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
This commit is contained in:
@@ -1,11 +1,34 @@
|
||||
---
|
||||
pageClass: is-wide-page
|
||||
---
|
||||
|
||||
# ModeCompleted (UORB message)
|
||||
|
||||
Mode completion result, published by an active mode.
|
||||
The possible values of nav_state are defined in the VehicleStatus msg.
|
||||
Note that this is not always published (e.g. when a user switches modes or on
|
||||
failsafe activation)
|
||||
Mode completion result, published by an active mode. The possible values of nav_state are defined in the VehicleStatus msg. Note that this is not always published (e.g. when a user switches modes or on. failsafe activation).
|
||||
|
||||
[source file](https://github.com/PX4/PX4-Autopilot/blob/main/msg/versioned/ModeCompleted.msg)
|
||||
**TOPICS:** mode_completed
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Unit [Frame] | Range/Enum | Description |
|
||||
| --------- | -------- | ------------ | ---------- | -------------------------------------- |
|
||||
| timestamp | `uint64` | | | time since system start (microseconds) |
|
||||
| result | `uint8` | | | One of RESULT\_\* |
|
||||
| nav_state | `uint8` | | | Source mode (values in VehicleStatus) |
|
||||
|
||||
## Constants
|
||||
|
||||
| Name | Type | Value | Description |
|
||||
| --------------------------------------------------------- | -------- | ----- | --------------------------- |
|
||||
| <a href="#MESSAGE_VERSION"></a> MESSAGE_VERSION | `uint32` | 0 |
|
||||
| <a href="#RESULT_SUCCESS"></a> RESULT_SUCCESS | `uint8` | 0 |
|
||||
| <a href="#RESULT_FAILURE_OTHER"></a> RESULT_FAILURE_OTHER | `uint8` | 100 | Mode failed (generic error) |
|
||||
|
||||
## Source Message
|
||||
|
||||
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/versioned/ModeCompleted.msg)
|
||||
|
||||
::: details Click here to see original file
|
||||
|
||||
```c
|
||||
# Mode completion result, published by an active mode.
|
||||
@@ -25,5 +48,6 @@ uint8 RESULT_FAILURE_OTHER = 100 # Mode failed (generic error)
|
||||
uint8 result # One of RESULT_*
|
||||
|
||||
uint8 nav_state # Source mode (values in VehicleStatus)
|
||||
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user