diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-08-15 21:17:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-15 21:17:14 -0400 |
| commit | 94549b4a07985e9b1a462bb64f67c8ade466e377 (patch) | |
| tree | 0a757e59c28ea6dd787f7d6e6d308f81de7f1368 /docs | |
| parent | ee5900686bdb921beccf87566cb1ba4977059f99 (diff) | |
| parent | 2863f150063bc4a31cc819efe973b59b45a10d10 (diff) | |
Merge pull request #89 from Nicell/underglow/fix-configs
Add missing configuration values for RGB underglow
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/feature/underglow.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/docs/feature/underglow.md b/docs/docs/feature/underglow.md index 780845a..c6517ce 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 `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 to the 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 `X_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 to the LEDs you're using +CONFIG_WS2812_STRIP=y ``` |