aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorTakeshi ISHII <2170248+mtei@users.noreply.github.com>2018-09-14 02:24:10 +0900
committerskullydazed <skullydazed@users.noreply.github.com>2018-09-13 10:24:09 -0700
commit6d6d91c834ef3415425e21d895d4ec91c67fd4b8 (patch)
tree45724c30bcfe342d88899db355782250312f1704 /docs/feature_rgblight.md
parentce122c4981c71d33a85db94c787d5ec7a823acc6 (diff)
downloadqmk_firmware-6d6d91c834ef3415425e21d895d4ec91c67fd4b8.tar.gz
qmk_firmware-6d6d91c834ef3415425e21d895d4ec91c67fd4b8.zip
rgblight.[ch] more configurable (#3582)
* add temporary test code rgblight-macro-test1.[ch] * rgblight.h : mode auto numberring and auto generate mode name symbol No change in build result. * rgblight.c use RGBLIGHT_MODE_xxx symbols No change in build result. * quantum.c use RGBLIGHT_MODE_xxx symbols No change in build result. * fix build break. when RGB_MATRIX_ENABLE defined * add temporary test code rgblight-macro-test2.[ch] * modify rgblight_mode_eeprom_helper() and rgblight_sethsv_eeprom_helper() * modify rgblight_task() * configurable each effect compile on/off in config.h * update docs/feature_rgblight.md * fix conflict. docs/feature_rgblight.md * remove temporary test code rgblight-macro-test*.[ch] * fix comment typo. * remove old mode number from comment * update docs/feature_rgblight.md about effect mode * Revert "update docs/feature_rgblight.md about effect mode" This reverts commit 43890663fcc9dda1899df7a37d382fc38b1a6d6d. * some change docs/feature_rgblight.md * fix typo * docs/feature_rgblight.md update: revise mode number table
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md42
1 files changed, 27 insertions, 15 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index d48941a04..925dca724 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -79,20 +79,23 @@ Your RGB lighting can be configured by placing these `#define`s in your `config.
79 79
80## Animations 80## Animations
81 81
82Not only can this lighting be whatever color you want, if `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal: 82
83 83Not only can this lighting be whatever color you want,
84|Mode |Description | 84if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal:
85|-----|---------------------| 85
86|1 |Solid color | 86|Mode number symbol |Additional number |Description |
87|2-5 |Solid color breathing| 87|-----------------------------|-------------------|---------------------------------------|
88|6-8 |Cycling rainbow | 88|`RGBLIGHT_MODE_STATIC_LIGHT` | *None* |Solid color (this mode is always enabled) |
89|9-14 |Swirling rainbow | 89|`RGBLIGHT_MODE_BREATHING` | 0,1,2,3 |Solid color breathing |
90|15-20|Snake | 90|`RGBLIGHT_MODE_RAINBOW_MOOD` | 0,1,2 |Cycling rainbow |
91|21-23|Knight | 91|`RGBLIGHT_MODE_RAINBOW_SWIRL`| 0,1,2,3,4,5 |Swirling rainbow |
92|24 |Christmas | 92|`RGBLIGHT_MODE_SNAKE` | 0,1,2,3,4,5 |Snake |
93|25-34|Static gradient | 93|`RGBLIGHT_MODE_KNIGHT` | 0,1,2 |Knight |
94|35 |RGB Test | 94|`RGBLIGHT_MODE_CHRISTMAS` | *None* |Christmas |
95|36 |Alternating | 95|`RGBLIGHT_MODE_STATIC_GRADIENT`| 0,1,..,9 |Static gradient |
96|`RGBLIGHT_MODE_RGB_TEST` | *None* |RGB Test |
97|`RGBLIGHT_MODE_ALTERNATING` | *None* |Alternating |
98
96 99
97Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration. 100Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
98 101
@@ -100,7 +103,16 @@ The following options can be used to tweak the various animations:
100 103
101|Define |Default |Description | 104|Define |Default |Description |
102|------------------------------------|-------------|-------------------------------------------------------------------------------------| 105|------------------------------------|-------------|-------------------------------------------------------------------------------------|
103|`RGBLIGHT_ANIMATIONS` |*Not defined*|If defined, enables additional animation modes | 106|`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|If defined, enable breathing animation mode. |
107|`RGBLIGHT_EFFECT_RAINBOW_MOOD` |*Not defined*|If defined, enable rainbow mood animation mode. |
108|`RGBLIGHT_EFFECT_RAINBOW_SWIRL` |*Not defined*|If defined, enable rainbow swirl animation mode. |
109|`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|If defined, enable snake animation mode. |
110|`RGBLIGHT_EFFECT_KNIGHT` |*Not defined*|If defined, enable knight animation mode. |
111|`RGBLIGHT_EFFECT_CHRISTMAS` |*Not defined*|If defined, enable christmas animation mode. |
112|`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|If defined, enable static gradient mode. |
113|`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|If defined, enable RGB test animation mode. |
114|`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|If defined, enable alternating animation mode. |
115|`RGBLIGHT_ANIMATIONS` |*Not defined*|If defined, enables all additional animation modes |
104|`RGBLIGHT_EFFECT_BREATHE_CENTER` |`1.85` |Used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 | 116|`RGBLIGHT_EFFECT_BREATHE_CENTER` |`1.85` |Used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 |
105|`RGBLIGHT_EFFECT_BREATHE_MAX` |`255` |The maximum brightness for the breathing mode. Valid values are 1 to 255 | 117|`RGBLIGHT_EFFECT_BREATHE_MAX` |`255` |The maximum brightness for the breathing mode. Valid values are 1 to 255 |
106|`RGBLIGHT_EFFECT_SNAKE_LENGTH` |`4` |The number of LEDs to light up for the "Snake" animation | 118|`RGBLIGHT_EFFECT_SNAKE_LENGTH` |`4` |The number of LEDs to light up for the "Snake" animation |
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-17 07:27:51 +0000