Skip to content

Commit

Permalink
PLAY_TUNE_V2: New tune messages
Browse files Browse the repository at this point in the history
  • Loading branch information
hamishwillee authored and LorenzMeier committed Oct 24, 2019
1 parent e6d22b1 commit d231f95
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion message_definitions/v1.0/common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3802,6 +3802,15 @@
<description>CAA (Civil Aviation Authority) registered operator ID.</description>
</entry>
</enum>
<enum name="TUNE_FORMAT">
<description>Tune formats (used for vehicle buzzer/tone generation).</description>
<entry value="0" name="TUNE_FORMAT_QBASIC1_1">
<description>Format is QBasic 1.1 Play: https://www.qbasic.net/en/reference/qb11/Statement/PLAY-006.htm.</description>
</entry>
<entry value="0" name="TUNE_FORMAT_MML_MODERN">
<description>Format is Modern Music Markup Language (MML): https://en.wikipedia.org/wiki/Music_Macro_Language#Modern_MML.</description>
</entry>
</enum>
</enums>
<messages>
<message id="0" name="HEARTBEAT">
Expand Down Expand Up @@ -5418,7 +5427,8 @@
<field type="uint8_t" name="state" display="bitmask">Bitmap for state of buttons.</field>
</message>
<message id="258" name="PLAY_TUNE">
<description>Control vehicle tone generation (buzzer)</description>
<deprecated since="2019-10" replaced_by="PLAY_TUNE_V2">New version explicitly defines format. More interoperable.</deprecated>
<description>Control vehicle tone generation (buzzer).</description>
<field type="uint8_t" name="target_system">System ID</field>
<field type="uint8_t" name="target_component">Component ID</field>
<field type="char[30]" name="tune">tune in board specific format</field>
Expand Down Expand Up @@ -5842,6 +5852,19 @@
<field type="uint32_t[6]" name="link_tx_max" units="KiB/s">Network capacity from the component system. A value of UINT32_MAX implies the field is unused.</field>
<field type="uint32_t[6]" name="link_rx_max" units="KiB/s">Network capacity to the component system. A value of UINT32_MAX implies the field is unused.</field>
</message>
<message id="400" name="PLAY_TUNE_V2">
<description>Play vehicle tone/tune (buzzer). Default format is QBasic 1.1. Supersedes message PLAY_TUNE.</description>
<field type="uint8_t" name="target_system">System ID</field>
<field type="uint8_t" name="target_component">Component ID</field>
<field type="uint8_t" name="format" enum="TUNE_FORMAT">Tune format</field>
<field type="char[252]" name="tune">Tune definition</field>
</message>
<message id="401" name="SUPPORTED_TUNES">
<description>Tune formats supported by vehicle. This should be emitted as response to MAV_CMD_REQUEST_MESSAGE.</description>
<field type="uint8_t" name="target_system">System ID</field>
<field type="uint8_t" name="target_component">Component ID</field>
<field type="uint8_t[200]" name="format" enum="TUNE_FORMAT">Array of supported tune formats</field>
</message>
<!-- Rover specific messages -->
<message id="9000" name="WHEEL_DISTANCE">
<description>Cumulative distance traveled for each reported wheel.</description>
Expand Down

0 comments on commit d231f95

Please sign in to comment.