summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick <nick.win999@gmail.com>2020-08-14 21:31:18 -0500
committerNick <nick.win999@gmail.com>2020-08-14 21:31:18 -0500
commitaa4ae90fb7cd7d7e295f9f5d4af8ad63d9bc9715 (patch)
tree811e81ec3acc92130bf119fc4dd006a7fb7cf068 /docs
parent7e8a07e693431adfb64d12262b3c7614920c042c (diff)
Add missing configuration values for RGB underglow
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/feature/underglow.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/docs/feature/underglow.md b/docs/docs/feature/underglow.md
index 780845a..4be752f 100644
--- a/docs/docs/feature/underglow.md
+++ b/docs/docs/feature/underglow.md
@@ -21,10 +21,12 @@ Here you can see the RGB underglow feature in action using WS2812 LEDs.
## Enabling RGB Underglow
-To enable RGB underglow on your board or shield, simply enable the `ZMK_RGB_UNDERGLOW` configuration value in the `.conf` file of your user config directory as such:
+To enable RGB underglow on your board or shield, simply enable the `ZMK_RGB_UNDERGLOW` and `CONFIG_X_STRIP` configuration values in the `.conf` file of your user config directory as such:
```
CONFIG_ZMK_RGB_UNDERGLOW=y
+# Use the STRIP config specific tot he LEDs you're using
+CONFIG_WS2812_STRIP=y
```
If your board or shield does not have RGB underglow configured, refer to [Adding RGB Underglow to a Board](#adding-rgb-underglow-to-a-board).
@@ -114,8 +116,10 @@ Once you have your `led_strip` properly defined you need to add it to the root d
};
```
-Finally you need to enable the `ZMK_RGB_UNDERGLOW` configuration value in the `.conf` file of your board (or set a default in the `Kconfig.defconfig`):
+Finally you need to enable the `ZMK_RGB_UNDERGLOW` and `CONFIG_X_STRIP` STRIP configuration values in the `.conf` file of your board (or set a default in the `Kconfig.defconfig`):
```
CONFIG_ZMK_RGB_UNDERGLOW=y
+# Use the STRIP config specific tot he LEDs you're using
+CONFIG_WS2812_STRIP=y
```