aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-06-22 01:38:58 -0700
committerGitHub <noreply@github.com>2020-06-22 09:38:58 +0100
commit98642ca02878741531105bd879c0d61110198b62 (patch)
treebefd24e847255379c60f9c77df53072245fa6b7b /docs/feature_rgblight.md
parent82dc8faaf30a6b77ec715852c3841fde087b6b07 (diff)
downloadfirmware-98642ca02878741531105bd879c0d61110198b62.tar.gz
firmware-98642ca02878741531105bd879c0d61110198b62.tar.bz2
firmware-98642ca02878741531105bd879c0d61110198b62.zip
Improve keycode handling for RGB (#7677)
Co-authored-by: drashna <drashna@live.com> Co-authored-by: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 5921e9941..a81b50e82 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -64,6 +64,9 @@ Changing the **Value** sets the overall brightness.<br>
|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode |
|`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode |
+!> By default, if you have both the RGB Light and the [RGB Matrix](feature_rgb_matrix.md) feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature.
+
+
## Configuration
Your RGB lighting can be configured by placing these `#define`s in your `config.h`:
@@ -76,6 +79,7 @@ Your RGB lighting can be configured by placing these `#define`s in your `config.
|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level |
|`RGBLIGHT_SLEEP` |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep|
|`RGBLIGHT_SPLIT` |*Not defined*|If defined, synchronization functionality for split keyboards is added|
+|`RGBLIGHT_DISABLE_KEYCODES`|*not defined*|If defined, disables the ability to control RGB Light from the keycodes. You must use code functions to control the feature|
## Effects and Animations