aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorWilliam Chang <william@factual.com>2019-05-10 16:44:13 -0700
committerWilliam Chang <william@factual.com>2019-05-10 16:44:13 -0700
commit10975bd4c08a598eed2c74dab0d3187fbbf4b8f5 (patch)
tree3ad0472dde9e18b5ce875043c837709ca32eea6f /docs/feature_rgblight.md
parent9ce186860e78d5afe350636cb7445e18c2577f33 (diff)
parentfebaf9dec42ce4d4ade316f811145a291137ee94 (diff)
downloadqmk_firmware-10975bd4c08a598eed2c74dab0d3187fbbf4b8f5.tar.gz
qmk_firmware-10975bd4c08a598eed2c74dab0d3187fbbf4b8f5.zip
fixed conflict in readme
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md64
1 files changed, 44 insertions, 20 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 4572f45b2..1e0ce9147 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -37,9 +37,9 @@ QMK uses [Hue, Saturation, and Value](https://en.wikipedia.org/wiki/HSL_and_HSV)
37 37
38<img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250"/> 38<img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250"/>
39 39
40Changing the **Hue** cycles around the circle. 40Changing the **Hue** cycles around the circle.<br>
41Changing the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color. 41Changing the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color.<br>
42Changing the **Value** sets the overall brightness. 42Changing the **Value** sets the overall brightness.<br>
43 43
44## Keycodes 44## Keycodes
45 45
@@ -77,8 +77,7 @@ Your RGB lighting can be configured by placing these `#define`s in your `config.
77|`RGBLIGHT_SLEEP` |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep| 77|`RGBLIGHT_SLEEP` |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep|
78|`RGBLIGHT_SPLIT` |*Not defined*|If defined, synchronization functionality for split keyboards is added| 78|`RGBLIGHT_SPLIT` |*Not defined*|If defined, synchronization functionality for split keyboards is added|
79 79
80## Animations 80## Effects and Animations
81
82 81
83Not only can this lighting be whatever color you want, 82Not only can this lighting be whatever color you want,
84if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal: 83if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal:
@@ -100,29 +99,54 @@ Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstrat
100 99
101Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol. 100Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol.
102 101
103The following options can be used to tweak the various animations: 102### Effect and Animation Toggles
103
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.
105
106|Define |Default |Description |
107|------------------------------------|-------------|-------------------------------------------------------------------------------------|
108|`RGBLIGHT_ANIMATIONS` |*Not defined*|Enable all additional animation modes. |
109|`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|Enable alternating animation mode. |
110|`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|Enable breathing animation mode. |
111|`RGBLIGHT_EFFECT_CHRISTMAS` |*Not defined*|Enable christmas animation mode. |
112|`RGBLIGHT_EFFECT_KNIGHT` |*Not defined*|Enable knight animation mode. |
113|`RGBLIGHT_EFFECT_RAINBOW_MOOD` |*Not defined*|Enable rainbow mood animation mode. |
114|`RGBLIGHT_EFFECT_RAINBOW_SWIRL` |*Not defined*|Enable rainbow swirl animation mode. |
115|`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|Enable RGB test animation mode. |
116|`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|Enable snake animation mode. |
117|`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|Enable static gradient mode. |
118
119### Effect and Animation Settings
120
121The following options are used to tweak the various animations:
104 122
105|Define |Default |Description | 123|Define |Default |Description |
106|------------------------------------|-------------|-------------------------------------------------------------------------------------| 124|------------------------------------|-------------|-------------------------------------------------------------------------------------|
107|`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|If defined, enable breathing animation mode. |
108|`RGBLIGHT_EFFECT_RAINBOW_MOOD` |*Not defined*|If defined, enable rainbow mood animation mode. |
109|`RGBLIGHT_EFFECT_RAINBOW_SWIRL` |*Not defined*|If defined, enable rainbow swirl animation mode. |
110|`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|If defined, enable snake animation mode. |
111|`RGBLIGHT_EFFECT_KNIGHT` |*Not defined*|If defined, enable knight animation mode. |
112|`RGBLIGHT_EFFECT_CHRISTMAS` |*Not defined*|If defined, enable christmas animation mode. |
113|`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|If defined, enable static gradient mode. |
114|`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|If defined, enable RGB test animation mode. |
115|`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|If defined, enable alternating animation mode. |
116|`RGBLIGHT_ANIMATIONS` |*Not defined*|If defined, enables all additional animation modes |
117|`RGBLIGHT_EFFECT_BREATHE_CENTER` |*Not defined*|If defined, used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 | 125|`RGBLIGHT_EFFECT_BREATHE_CENTER` |*Not defined*|If defined, used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 |
118|`RGBLIGHT_EFFECT_BREATHE_MAX` |`255` |The maximum brightness for the breathing mode. Valid values are 1 to 255 | 126|`RGBLIGHT_EFFECT_BREATHE_MAX` |`255` |The maximum brightness for the breathing mode. Valid values are 1 to 255 |
119|`RGBLIGHT_EFFECT_SNAKE_LENGTH` |`4` |The number of LEDs to light up for the "Snake" animation |
120|`RGBLIGHT_EFFECT_KNIGHT_LENGTH` |`3` |The number of LEDs to light up for the "Knight" animation |
121|`RGBLIGHT_EFFECT_KNIGHT_OFFSET` |`0` |The number of LEDs to start the "Knight" animation from the start of the strip by |
122|`RGBLIGHT_EFFECT_KNIGHT_LED_NUM` |`RGBLED_NUM` |The number of LEDs to have the "Knight" animation travel |
123|`RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL`|`1000` |How long to wait between light changes for the "Christmas" animation, in milliseconds| 127|`RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL`|`1000` |How long to wait between light changes for the "Christmas" animation, in milliseconds|
124|`RGBLIGHT_EFFECT_CHRISTMAS_STEP` |`2` |The number of LEDs to group the red/green colors by for the "Christmas" animation | 128|`RGBLIGHT_EFFECT_CHRISTMAS_STEP` |`2` |The number of LEDs to group the red/green colors by for the "Christmas" animation |
129|`RGBLIGHT_EFFECT_KNIGHT_LED_NUM` |`RGBLED_NUM` |The number of LEDs to have the "Knight" animation travel |
130|`RGBLIGHT_EFFECT_KNIGHT_LENGTH` |`3` |The number of LEDs to light up for the "Knight" animation |
131|`RGBLIGHT_EFFECT_KNIGHT_OFFSET` |`0` |The number of LEDs to start the "Knight" animation from the start of the strip by |
125|`RGBLIGHT_RAINBOW_SWIRL_RANGE` |`360` |Range adjustment for the rainbow swirl effect to get different swirls | 132|`RGBLIGHT_RAINBOW_SWIRL_RANGE` |`360` |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 |
134
135### Example Usage to Reduce Memory Footprint
136 1. Remove `RGBLIGHT_ANIMATIONS` from `config.h`.
137 1. Selectively add the animations you want to enable. The following would enable two animations and save about 4KiB:
138
139```diff
140 #undef RGBLED_NUM
141-#define RGBLIGHT_ANIMATIONS
142+#define RGBLIGHT_EFFECT_STATIC_GRADIENT
143+#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
144 #define RGBLED_NUM 12
145 #define RGBLIGHT_HUE_STEP 8
146 #define RGBLIGHT_SAT_STEP 8
147```
148
149### Animation Speed
126 150
127You can also modify the speeds that the different modes animate at: 151You can also modify the speeds that the different modes animate at:
128 152