fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-10-03 14:38:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: auto-sync metadata [skip ci]

Browse Source 
Co-Authored-By: PX4 BuildBot <bot@px4.io>
This commit is contained in:
PX4BuildBot
2026-02-11 22:43:01 +00:00
parent 01b348c86b
commit 36b5e1e1bb
374 changed files with 12147 additions and 1765 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/msg_docs/LedControl.md
+49 -4
View File
@@ -1,9 +1,53 @@
---
pageClass: is-wide-page
---
# LedControl (UORB message)
LED control: control a single or multiple LED's.
These are the externally visible LED's, not the board LED's
LED control: control a single or multiple LED's. These are the externally visible LED's, not the board LED's.
[source file](https://github.com/PX4/PX4-Autopilot/blob/main/msg/LedControl.msg)
**TOPICS:** led_control
## Fields
| Name | Type | Unit [Frame] | Range/Enum | Description |
| ---------- | -------- | ------------ | ---------- | --------------------------------------------------------------------------------------------------------- |
| timestamp | `uint64` | | | time since system start (microseconds) |
| led_mask | `uint8` | | | bitmask which LED(s) to control, set to 0xff for all |
| color | `uint8` | | | see COLOR\_\* |
| mode | `uint8` | | | see MODE\_\* |
| num_blinks | `uint8` | | | how many times to blink (number of on-off cycles if mode is one of MODE*BLINK*\*) . Set to 0 for infinite |
| priority | `uint8` | | | priority: higher priority events will override current lower priority events (see MAX_PRIORITY) |
## Constants
| Name | Type | Value | Description |
| --------------------------------------------------- | ------- | ----- | --------------------------------------------------------------------------------------- |
| <a href="#COLOR_OFF"></a> COLOR_OFF | `uint8` | 0 | this is only used in the drivers |
| <a href="#COLOR_RED"></a> COLOR_RED | `uint8` | 1 |
| <a href="#COLOR_GREEN"></a> COLOR_GREEN | `uint8` | 2 |
| <a href="#COLOR_BLUE"></a> COLOR_BLUE | `uint8` | 3 |
| <a href="#COLOR_YELLOW"></a> COLOR_YELLOW | `uint8` | 4 |
| <a href="#COLOR_PURPLE"></a> COLOR_PURPLE | `uint8` | 5 |
| <a href="#COLOR_AMBER"></a> COLOR_AMBER | `uint8` | 6 |
| <a href="#COLOR_CYAN"></a> COLOR_CYAN | `uint8` | 7 |
| <a href="#COLOR_WHITE"></a> COLOR_WHITE | `uint8` | 8 |
| <a href="#MODE_OFF"></a> MODE_OFF | `uint8` | 0 | turn LED off |
| <a href="#MODE_ON"></a> MODE_ON | `uint8` | 1 | turn LED on |
| <a href="#MODE_DISABLED"></a> MODE_DISABLED | `uint8` | 2 | disable this priority (switch to lower priority setting) |
| <a href="#MODE_BLINK_SLOW"></a> MODE_BLINK_SLOW | `uint8` | 3 |
| <a href="#MODE_BLINK_NORMAL"></a> MODE_BLINK_NORMAL | `uint8` | 4 |
| <a href="#MODE_BLINK_FAST"></a> MODE_BLINK_FAST | `uint8` | 5 |
| <a href="#MODE_BREATHE"></a> MODE_BREATHE | `uint8` | 6 | continuously increase & decrease brightness (solid color if driver does not support it) |
| <a href="#MODE_FLASH"></a> MODE_FLASH | `uint8` | 7 | two fast blinks (on/off) with timing as in MODE_BLINK_FAST and then off for a while |
| <a href="#MAX_PRIORITY"></a> MAX_PRIORITY | `uint8` | 2 | maximum priority (minimum is 0) |
| <a href="#ORB_QUEUE_LENGTH"></a> ORB_QUEUE_LENGTH | `uint8` | 8 | needs to match BOARD_MAX_LEDS |
## Source Message
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/LedControl.msg)
::: details Click here to see original file
```c
# LED control: control a single or multiple LED's.
@@ -43,5 +87,6 @@ uint8 num_blinks # how many times to blink (number of on-off cycles if mode is o
uint8 priority # priority: higher priority events will override current lower priority events (see MAX_PRIORITY)
uint8 ORB_QUEUE_LENGTH = 8 # needs to match BOARD_MAX_LEDS
```
:::