kofal.net/zmk
1
0
Fork 1
mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #89 from Nicell/underglow/fix-configs

Browse Source 
Add missing configuration values for RGB underglow
This commit is contained in:
Pete Johanson
2020-08-15 21:17:14 -04:00
committed by GitHub
parent ee5900686b 2863f15006
commit 94549b4a07
3 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/feature/underglow.md
View File

@@ -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
```