fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-10-15 05:03:33 +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/TuneControl.md
+56 -4
View File
@@ -1,9 +1,60 @@
---
pageClass: is-wide-page
---
# TuneControl (UORB message)
This message is used to control the tunes, when the tune_id is set to CUSTOM
then the frequency, duration are used otherwise those values are ignored.
This message is used to control the tunes, when the tune_id is set to CUSTOM. then the frequency, duration are used otherwise those values are ignored.
[source file](https://github.com/PX4/PX4-Autopilot/blob/main/msg/TuneControl.msg)
**TOPICS:** tune_control
## Fields
| Name | Type | Unit [Frame] | Range/Enum | Description |
| ------------- | -------- | ------------ | ---------- | --------------------------------------------------------------------------------- |
| timestamp | `uint64` | | | time since system start (microseconds) |
| tune_id | `uint8` | | | tune_id corresponding to TuneID::\* from the tune_defaults.h in the tunes library |
| tune_override | `bool` | | | if true the tune which is playing will be stopped and the new started |
| frequency | `uint16` | | | in Hz |
| duration | `uint32` | | | in us |
| silence | `uint32` | | | in us |
| volume | `uint8` | | | value between 0-100 if supported by backend |
## Constants
| Name | Type | Value | Description |
| ------------------------------------------------------------------------- | ------- | ----- | ----------- |
| <a href="#TUNE_ID_STOP"></a> TUNE_ID_STOP | `uint8` | 0 |
| <a href="#TUNE_ID_STARTUP"></a> TUNE_ID_STARTUP | `uint8` | 1 |
| <a href="#TUNE_ID_ERROR"></a> TUNE_ID_ERROR | `uint8` | 2 |
| <a href="#TUNE_ID_NOTIFY_POSITIVE"></a> TUNE_ID_NOTIFY_POSITIVE | `uint8` | 3 |
| <a href="#TUNE_ID_NOTIFY_NEUTRAL"></a> TUNE_ID_NOTIFY_NEUTRAL | `uint8` | 4 |
| <a href="#TUNE_ID_NOTIFY_NEGATIVE"></a> TUNE_ID_NOTIFY_NEGATIVE | `uint8` | 5 |
| <a href="#TUNE_ID_ARMING_WARNING"></a> TUNE_ID_ARMING_WARNING | `uint8` | 6 |
| <a href="#TUNE_ID_BATTERY_WARNING_SLOW"></a> TUNE_ID_BATTERY_WARNING_SLOW | `uint8` | 7 |
| <a href="#TUNE_ID_BATTERY_WARNING_FAST"></a> TUNE_ID_BATTERY_WARNING_FAST | `uint8` | 8 |
| <a href="#TUNE_ID_GPS_WARNING"></a> TUNE_ID_GPS_WARNING | `uint8` | 9 |
| <a href="#TUNE_ID_ARMING_FAILURE"></a> TUNE_ID_ARMING_FAILURE | `uint8` | 10 |
| <a href="#TUNE_ID_PARACHUTE_RELEASE"></a> TUNE_ID_PARACHUTE_RELEASE | `uint8` | 11 |
| <a href="#TUNE_ID_SINGLE_BEEP"></a> TUNE_ID_SINGLE_BEEP | `uint8` | 12 |
| <a href="#TUNE_ID_HOME_SET"></a> TUNE_ID_HOME_SET | `uint8` | 13 |
| <a href="#TUNE_ID_SD_INIT"></a> TUNE_ID_SD_INIT | `uint8` | 14 |
| <a href="#TUNE_ID_SD_ERROR"></a> TUNE_ID_SD_ERROR | `uint8` | 15 |
| <a href="#TUNE_ID_PROG_PX4IO"></a> TUNE_ID_PROG_PX4IO | `uint8` | 16 |
| <a href="#TUNE_ID_PROG_PX4IO_OK"></a> TUNE_ID_PROG_PX4IO_OK | `uint8` | 17 |
| <a href="#TUNE_ID_PROG_PX4IO_ERR"></a> TUNE_ID_PROG_PX4IO_ERR | `uint8` | 18 |
| <a href="#TUNE_ID_POWER_OFF"></a> TUNE_ID_POWER_OFF | `uint8` | 19 |
| <a href="#NUMBER_OF_TUNES"></a> NUMBER_OF_TUNES | `uint8` | 20 |
| <a href="#VOLUME_LEVEL_MIN"></a> VOLUME_LEVEL_MIN | `uint8` | 0 |
| <a href="#VOLUME_LEVEL_DEFAULT"></a> VOLUME_LEVEL_DEFAULT | `uint8` | 20 |
| <a href="#VOLUME_LEVEL_MAX"></a> VOLUME_LEVEL_MAX | `uint8` | 100 |
| <a href="#ORB_QUEUE_LENGTH"></a> ORB_QUEUE_LENGTH | `uint8` | 4 |
## Source Message
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/TuneControl.msg)
::: details Click here to see original file
```c
# This message is used to control the tunes, when the tune_id is set to CUSTOM
@@ -45,5 +96,6 @@ uint8 VOLUME_LEVEL_DEFAULT = 20
uint8 VOLUME_LEVEL_MAX = 100
uint8 ORB_QUEUE_LENGTH = 4
```
:::