mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-05-24 23:55:24 +08:00
docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
This commit is contained in:
@@ -1,8 +1,34 @@
|
||||
---
|
||||
pageClass: is-wide-page
|
||||
---
|
||||
|
||||
# PowerButtonState (UORB message)
|
||||
|
||||
power button state notification message
|
||||
power button state notification message.
|
||||
|
||||
[source file](https://github.com/PX4/PX4-Autopilot/blob/main/msg/PowerButtonState.msg)
|
||||
**TOPICS:** power_buttonstate
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Unit [Frame] | Range/Enum | Description |
|
||||
| --------- | -------- | ------------ | ---------- | -------------------------------------- |
|
||||
| timestamp | `uint64` | | | time since system start (microseconds) |
|
||||
| event | `uint8` | | | one of PWR*BUTTON_STATE*\* |
|
||||
|
||||
## Constants
|
||||
|
||||
| Name | Type | Value | Description |
|
||||
| ----------------------------------------------------------------------------------- | ------- | ----- | ----------------------------------------------------------------------- |
|
||||
| <a href="#PWR_BUTTON_STATE_IDEL"></a> PWR_BUTTON_STATE_IDEL | `uint8` | 0 | Button went up without meeting shutdown button down time (delete event) |
|
||||
| <a href="#PWR_BUTTON_STATE_DOWN"></a> PWR_BUTTON_STATE_DOWN | `uint8` | 1 | Button went Down |
|
||||
| <a href="#PWR_BUTTON_STATE_UP"></a> PWR_BUTTON_STATE_UP | `uint8` | 2 | Button went Up |
|
||||
| <a href="#PWR_BUTTON_STATE_REQUEST_SHUTDOWN"></a> PWR_BUTTON_STATE_REQUEST_SHUTDOWN | `uint8` | 3 | Button went Up after meeting shutdown button down time |
|
||||
|
||||
## Source Message
|
||||
|
||||
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/PowerButtonState.msg)
|
||||
|
||||
::: details Click here to see original file
|
||||
|
||||
```c
|
||||
# power button state notification message
|
||||
@@ -15,5 +41,6 @@ uint8 PWR_BUTTON_STATE_UP = 2 # Button went Up
|
||||
uint8 PWR_BUTTON_STATE_REQUEST_SHUTDOWN = 3 # Button went Up after meeting shutdown button down time
|
||||
|
||||
uint8 event # one of PWR_BUTTON_STATE_*
|
||||
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user