aboutsummaryrefslogtreecommitdiffstats
path: root/docs/config_options.md
diff options
context:
space:
mode:
authorJoshua Diamond <josh@windowoffire.com>2020-05-13 16:39:05 -0400
committerGitHub <noreply@github.com>2020-05-13 21:39:05 +0100
commita8a8bf0ff3d6e1c9637079b925b30cf7eb8913fd (patch)
tree3e7f1d53536711151fb7f8aebe63ab4d41f1d298 /docs/config_options.md
parentfadd3cb4617fe7e48c802c4470a50df36e6c5109 (diff)
downloadfirmware-a8a8bf0ff3d6e1c9637079b925b30cf7eb8913fd.tar.gz
firmware-a8a8bf0ff3d6e1c9637079b925b30cf7eb8913fd.tar.bz2
firmware-a8a8bf0ff3d6e1c9637079b925b30cf7eb8913fd.zip
Allow expanding from 8 to 32 RGB Lighting Layers (#8941)
* Allow 16 lighting layers * Require #define RGBLIGHT_LAYERS_16 to enable 16 layers * Override RGBLIGHT_MAX_LAYERS to set maximum number of lighting layers * Enforce lower bound on RGBLIGHT_MAX_LAYERS Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Fix an error in the check for valid RGBLIGHT_MAX_LAYERS * Don't use bitfield / PACKED, as it causes bloat * Update documentation re: up to 32 lighting layers * Run cformat * Add note about increasing FW size in docs/config_options.md Co-authored-by: Drashna Jaelre <drashna@live.com> * Remove no-longer-valid comment * Add doc note that split sync will be slower Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'docs/config_options.md')
-rw-r--r--docs/config_options.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index f76685702..b96079e60 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -192,6 +192,9 @@ If you define these options you will enable the associated feature, which may in
* run RGB animations
* `#define RGBLIGHT_LAYERS`
* Lets you define [lighting layers](feature_rgblight.md?id=lighting-layers) that can be toggled on or off. Great for showing the current keyboard layer or caps lock state.
+* `#define RGBLIGHT_MAX_LAYERS`
+ * Defaults to 8. Can be expanded up to 32 if more [lighting layers](feature_rgblight.md?id=lighting-layers) are needed.
+ * Note: Increasing the maximum will increase the firmware size and slow sync on split keyboards.
* `#define RGBLIGHT_LAYER_BLINK`
* Adds ability to [blink](feature_rgblight.md?id=lighting-layer-blink) a lighting layer for a specified number of milliseconds (e.g. to acknowledge an action).
* `#define RGBLED_NUM 12`