aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoshua Diamond <josh@windowoffire.com>2020-05-09 04:56:16 -0400
committerGitHub <noreply@github.com>2020-05-09 01:56:16 -0700
commit2fe7e221ec9e412cc008aa5c03eaf27e35ff62c6 (patch)
tree79ae7e86cfb9048b3bd9795b596ec318581d801e /docs
parente0f548085cc9c29e85122d393e74143eb5de1d4d (diff)
downloadqmk_firmware-2fe7e221ec9e412cc008aa5c03eaf27e35ff62c6.tar.gz
qmk_firmware-2fe7e221ec9e412cc008aa5c03eaf27e35ff62c6.zip
New RGB Lighting effect: Twinkle (#8887)
* Add twinkle RGB Lighting effect * 2nd twinkle algo - double-buffering * Further refinement: Per-LED twinkle * Add documentation for Twinkle RBG Lighting mode * Bias twinkle saturation closer to the set value * Fix whitespace
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgblight.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index de19b7419..045d97775 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -94,6 +94,7 @@ if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a n
94|`RGBLIGHT_MODE_STATIC_GRADIENT`| 0,1,..,9 |Static gradient | 94|`RGBLIGHT_MODE_STATIC_GRADIENT`| 0,1,..,9 |Static gradient |
95|`RGBLIGHT_MODE_RGB_TEST` | *None* |RGB Test | 95|`RGBLIGHT_MODE_RGB_TEST` | *None* |RGB Test |
96|`RGBLIGHT_MODE_ALTERNATING` | *None* |Alternating | 96|`RGBLIGHT_MODE_ALTERNATING` | *None* |Alternating |
97|`RGBLIGHT_MODE_TWINKLE` | 0,1,2,3,4,5 |Twinkle |
97 98
98Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration. 99Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
99 100
@@ -103,8 +104,8 @@ Note: For versions older than 0.6.117, The mode numbers were written directly. I
103 104
104Use these defines to add or remove animations from the firmware. When you are running low on flash space, it can be helpful to disable animations you are not using. 105Use these defines to add or remove animations from the firmware. When you are running low on flash space, it can be helpful to disable animations you are not using.
105 106
106|Define |Default |Description | 107|Define |Default |Description |
107|------------------------------------|-------------|-------------------------------------------------------------------------------------| 108|------------------------------------|-------------|-------------------------------------------------------------------------|
108|`RGBLIGHT_ANIMATIONS` |*Not defined*|Enable all additional animation modes. | 109|`RGBLIGHT_ANIMATIONS` |*Not defined*|Enable all additional animation modes. |
109|`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|Enable alternating animation mode. | 110|`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|Enable alternating animation mode. |
110|`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|Enable breathing animation mode. | 111|`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|Enable breathing animation mode. |
@@ -115,6 +116,7 @@ Use these defines to add or remove animations from the firmware. When you are ru
115|`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|Enable RGB test animation mode. | 116|`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|Enable RGB test animation mode. |
116|`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|Enable snake animation mode. | 117|`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|Enable snake animation mode. |
117|`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|Enable static gradient mode. | 118|`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|Enable static gradient mode. |
119|`RGBLIGHT_EFFECT_TWINKLE` |*Not defined*|Enable twinkle animation mode. |
118 120
119### Effect and Animation Settings 121### Effect and Animation Settings
120 122
@@ -131,6 +133,8 @@ The following options are used to tweak the various animations:
131|`RGBLIGHT_EFFECT_KNIGHT_OFFSET` |`0` |The number of LEDs to start the "Knight" animation from the start of the strip by | 133|`RGBLIGHT_EFFECT_KNIGHT_OFFSET` |`0` |The number of LEDs to start the "Knight" animation from the start of the strip by |
132|`RGBLIGHT_RAINBOW_SWIRL_RANGE` |`255` |Range adjustment for the rainbow swirl effect to get different swirls | 134|`RGBLIGHT_RAINBOW_SWIRL_RANGE` |`255` |Range adjustment for the rainbow swirl effect to get different swirls |
133|`RGBLIGHT_EFFECT_SNAKE_LENGTH` |`4` |The number of LEDs to light up for the "Snake" animation | 135|`RGBLIGHT_EFFECT_SNAKE_LENGTH` |`4` |The number of LEDs to light up for the "Snake" animation |
136|`RGBLIGHT_EFFECT_TWINKLE_LIFE` |`75` |Adjusts how quickly each LED brightens and dims when twinkling (in animation steps) |
137|`RGBLIGHT_EFFECT_TWINKLE_PROBABILITY`|`1/127` |Adjusts how likely each LED is to twinkle (on each animation step) |
134 138
135### Example Usage to Reduce Memory Footprint 139### Example Usage to Reduce Memory Footprint
136 1. Remove `RGBLIGHT_ANIMATIONS` from `config.h`. 140 1. Remove `RGBLIGHT_ANIMATIONS` from `config.h`.
@@ -168,6 +172,9 @@ const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
168// How long (in milliseconds) to wait between animation steps for each of the "Knight" animations 172// How long (in milliseconds) to wait between animation steps for each of the "Knight" animations
169const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31}; 173const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};
170 174
175// How long (in milliseconds) to wait between animation steps for each of the "Twinkle" animations
176const uint8_t RGBLED_TWINKLE_INTERVALS[] PROGMEM = {50, 25, 10};
177
171// These control which hues are selected for each of the "Static gradient" modes 178// These control which hues are selected for each of the "Static gradient" modes
172const uint8_t RGBLED_GRADIENT_RANGES[] PROGMEM = {255, 170, 127, 85, 64}; 179const uint8_t RGBLED_GRADIENT_RANGES[] PROGMEM = {255, 170, 127, 85, 64};
173``` 180```