|
| 1 | +<!-- THIS FILE IS AUTO-GENERATED: https://github.com/mavlink/mavlink/blob/master/doc/mavlink_xml_to_markdown.py --> |
| 2 | + |
| 3 | +# Dialect: stemstudios |
| 4 | + |
| 5 | +:::warning |
| 6 | +This topic documents the version of the dialect file in the [mavlink/mavlink](https://github.com/mavlink/mavlink) Github repository, which may not be up to date with the file in the source repository (it is up to the dialect owner to push changes when needed). |
| 7 | +The source repo should be listed in the comments at the top of the XML definition file listed below (but may not be). |
| 8 | +::: |
| 9 | + |
| 10 | +This topic is a human-readable form of the XML definition file: [stemstudios.xml](https://github.com/mavlink/mavlink/blob/master/message_definitions/v1.0/stemstudios.xml). |
| 11 | + |
| 12 | +<span id="mav2_extension_field"></span> |
| 13 | + |
| 14 | +::: info |
| 15 | + |
| 16 | +- MAVLink 2 [extension fields](../guide/define_xml_element.md#message_extensions) are displayed in blue. |
| 17 | +- Entities from dialects are displayed only as headings (with link to original) |
| 18 | + |
| 19 | +::: |
| 20 | + |
| 21 | +<style> |
| 22 | +span.ext { |
| 23 | + color: blue; |
| 24 | + } |
| 25 | +span.warning { |
| 26 | + color: red; |
| 27 | + } |
| 28 | +</style> |
| 29 | + |
| 30 | +## MAVLink Include Files |
| 31 | + |
| 32 | +- [common.xml](../messages/common.md) |
| 33 | + |
| 34 | +## 목차 |
| 35 | + |
| 36 | +| Type | Defined | Included | |
| 37 | +| -------------------------- | ------- | -------- | |
| 38 | +| [Messages](#messages) | 2 | 232 | |
| 39 | +| [Enums](#enumerated-types) | 1 | 152 | |
| 40 | +| [Commands](#mav_commands) | 166 | 0 | |
| 41 | + |
| 42 | +The following sections list all entities in the dialect (both included and defined in this file). |
| 43 | + |
| 44 | +## Messages |
| 45 | + |
| 46 | +### LED_STRIP_CONFIG (52600) {#LED_STRIP_CONFIG} |
| 47 | + |
| 48 | +Set the colors on an LED strip. The mode field determines how the colors are set. We can: |
| 49 | + |
| 50 | +- Set all LEDs to the first color in our colors array. |
| 51 | +- Set up to 8 consecutive LEDs, starting from a given index, to colors provided in an array. |
| 52 | +- Set the LED colors to change according to the flight mode. |
| 53 | +- Turn all LEDs off (clear). |
| 54 | + Which LED strip to configure is specified by the id field. |
| 55 | + The colors field is an array of up to 8 colors, each represented as a 32-bit integer in the format 0xWWRRGGBB |
| 56 | + where WW is white, RR is the intensity of the red color channel, GG is green, and BB is blue. |
| 57 | + |
| 58 | +| Field Name | Type | Values | Description | |
| 59 | +| ------------------------------------- | ------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | |
| 60 | +| target_system | `uint8_t` | | System ID. | |
| 61 | +| target_component | `uint8_t` | | Component ID (Normally 134 for an LED Strip Controller). | |
| 62 | +| mode | `uint8_t` | [LED_CONFIG_MODE](#LED_CONFIG_MODE) | How to configure LEDs. | |
| 63 | +| index | `uint8_t` | | Set LEDs starting from this index. | |
| 64 | +| length | `uint8_t` | | The number of LEDs to set (up to 8). | |
| 65 | +| id | `uint8_t` | | Which strip to configure. UINT8_MAX for all strips. | |
| 66 | +| colors | `uint32_t[8]` | | Array of 32-bit color values (0xWWRRGGBB). | |
| 67 | + |
| 68 | +### LED_STRIP_STATE (52601) {#LED_STRIP_STATE} |
| 69 | + |
| 70 | +Current LED State. Can be emitted by LED Strip Controller. |
| 71 | + |
| 72 | +| Field Name | Type | Description | |
| 73 | +| --------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | |
| 74 | +| length | `uint8_t` | How many LEDs are being reported in this message. | |
| 75 | +| index | `uint8_t` | Index of first LED being reported. | |
| 76 | +| id | `uint8_t` | Which strip is being reported. | |
| 77 | +| following_flight_mode | `uint8_t` | Are the LED colors changing according to the flight mode (1) or not (0). | |
| 78 | +| colors | `uint32_t[8]` | Array of 32-bit color values (0xWWRRGGBB). | |
| 79 | + |
| 80 | +## Enumerated Types |
| 81 | + |
| 82 | +### LED_CONFIG_MODE {#LED_CONFIG_MODE} |
| 83 | + |
| 84 | +How to configure LEDs. We can: |
| 85 | + |
| 86 | +- Set all LEDs to the first color in our colors array. |
| 87 | +- Set up to 8 consecutive LEDs, starting from a given index, to colors provided in an array. |
| 88 | +- Set the LED colors to change according to the flight mode. |
| 89 | +- Turn all LEDs off (clear). |
| 90 | + |
| 91 | +| Value | Name | Description | |
| 92 | +| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | |
| 93 | +| <a id='LED_CONFIG_MODE_ALL'></a>0 | [LED_CONFIG_MODE_ALL](#LED_CONFIG_MODE_ALL) | Set all LEDs in the target strip to the first color in our colors array. | |
| 94 | +| <a id='LED_CONFIG_MODE_INDEX'></a>1 | [LED_CONFIG_MODE_INDEX](#LED_CONFIG_MODE_INDEX) | Set up to 8 consecutive LEDs, starting from the given index, to the colors provided in the colors array. | |
| 95 | +| <a id='LED_CONFIG_MODE_FOLLOW_FLIGHT_MODE'></a>2 | [LED_CONFIG_MODE_FOLLOW_FLIGHT_MODE](#LED_CONFIG_MODE_FOLLOW_FLIGHT_MODE) | Set all LEDs in target strip to change color according to the flight mode. | |
| 96 | +| <a id='LED_CONFIG_MODE_CLEAR'></a>3 | [LED_CONFIG_MODE_CLEAR](#LED_CONFIG_MODE_CLEAR) | Set all LEDs in the target strip to black (turn off). | |
| 97 | + |
| 98 | +## Commands (MAV_CMD) {#mav_commands} |
| 99 | + |
0 commit comments