Skip to content

Commit

Permalink
Updated LED_STRIP docs with undocumented CLI commands
Browse files Browse the repository at this point in the history
  • Loading branch information
FiorixF1 committed Feb 14, 2022
1 parent 7b4415f commit ae77ed3
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions docs/LedStrip.md
Expand Up @@ -201,7 +201,7 @@ And each LED has overlays:
* `T` - `T`hrust state.
* `B` - `B`link (flash twice) mode.
* `O` - Lars`O`n Scanner (Cylon Effect).
* `N` - Blink on la`N`ding (throttle < 50%).
* `V` - `V`TX Frequency.

`cc` specifies the color number (0 based index).

Expand Down Expand Up @@ -284,15 +284,29 @@ Note: this mode requires a current sensor. If you don't have the actual device y

This mode blinks the current LED, alternatively from black to the current active color.

#### Blink on landing

This mode blinks the current LED, alternatively from black to the current active color, when throttle is below 50% and the craft is armed.

#### Larson Scanner (Cylon Effect)

The Larson Scanner replicates the scanning "eye" effect seen on the mechanical Cylons and on Kitt from Knight Rider.
This overlay dims all of the LEDs it is assigned to and brightens certain ones at certain times in accordance with the animation. The animation is active regardless of arm state.

#### VTX Frequency

This overlay makes the LED color dependent on the current channel of the VTX, in case it is equipped with SmartAudio or IRC Tramp.
The color is selected according to the following table:

Frequency range | Default color | Color index
------------ | ------------- | -------------
<= 5672 | White | 1
|> 5672 <= 5711 | Red | 2
|> 5711 <= 5750 | Orange | 3
|> 5750 <= 5789 | Yellow | 4
|> 5789 <= 5829 | Green | 6
|> 5829 <= 5867 | Blue | 10
|> 5867 <= 5906 | Dark violet | 11
|> 5906 | Deep pink | 13

The default color can be changed by double-clicking the color and moving the Hue slider or by using the color command in the CLI.

#### Flight Mode & Orientation

This mode shows the flight mode and orientation.
Expand Down Expand Up @@ -364,7 +378,7 @@ Note: Armed State cannot be used with Flight Mode.

#### Thrust state

This mode fades the LED current LED color to the previous/next color in the HSB color space depending on throttle stick position. When the throttle is in the middle position the color is unaffected, thus it can be mixed with orientation colors to indicate orientation and throttle at the same time. Thrust should normally be combined with Color or Mode/Orientation.
This mode fades the current LED color to the previous/next color in the HSB color space depending on throttle stick position. When the throttle is in the middle position the color is unaffected, thus it can be mixed with orientation colors to indicate orientation and throttle at the same time. Thrust should normally be combined with Color or Mode/Orientation.

#### Thrust ring state

Expand Down Expand Up @@ -455,7 +469,7 @@ Mode Colors can be configured using the cli `mode_color` command.
- No arguments: lists all mode colors
- arguments: mode, function, color

First 7 groups of ModeIndexes are :
First 8 groups of ModeIndexes are :

| mode | name |
|------|-------------|
Expand All @@ -466,6 +480,7 @@ First 7 groups of ModeIndexes are :
| 4 | mag |
| 5 | baro |
| 6 | special |
| 7 | channel |

Modes 0 to 5 functions:

Expand Down Expand Up @@ -493,11 +508,14 @@ Mode 6 use these functions:

The ColorIndex is picked from the colors array ("palette").

Mode 7 is used along with Thrust state to make the LED color dependent on a channel different from the throttle.

Examples (using the default colors):

- set armed color to red: ```mode_color 6 1 2```
- set disarmed color to yellow: ```mode_color 6 0 4```
- set Headfree mode 'south' to Cyan: ```mode_color 1 2 8```
- set color dependent on AUX 1 in Thrust state: ```mode_color 7 0 4```

## Positioning

Expand Down

0 comments on commit ae77ed3

Please sign in to comment.