xenua
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

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

Add missing configuration values for RGB underglow
xmkb
Pete Johanson 4 years ago committed by GitHub
parent
ee5900686b 2863f15006
commit
94549b4a07
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 4 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      app/boards/shields/corne/corne.conf
  2. 3
      app/boards/shields/kyria/kyria.conf
  3. 8
      docs/docs/feature/underglow.md

3
app/boards/shields/corne/corne.conf
Unescape View File

@ -1,5 +1,6 @@
# Uncomment the following line to enable the Corne RGB Underglow # Uncomment the following lines to enable the Corne RGB Underglow
# ZMK_RGB_UNDERGLOW=y # ZMK_RGB_UNDERGLOW=y
# CONFIG_WS2812_STRIP=y
# Uncomment the following line to enable the Corne OLED Display # Uncomment the following line to enable the Corne OLED Display
# CONFIG_ZMK_DISPLAY=y # CONFIG_ZMK_DISPLAY=y

3
app/boards/shields/kyria/kyria.conf
Unescape View File

@ -5,5 +5,6 @@
# Uncomment the following line to enable the Kyria OLED Display # Uncomment the following line to enable the Kyria OLED Display
# CONFIG_ZMK_DISPLAY=y # CONFIG_ZMK_DISPLAY=y
# Uncomment the following line to enable RGB underglow # Uncomment the following lines to enable RGB underglow
# CONFIG_ZMK_RGB_UNDERGLOW=y # CONFIG_ZMK_RGB_UNDERGLOW=y
# CONFIG_WS2812_STRIP=y

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

@ -21,10 +21,12 @@ Here you can see the RGB underglow feature in action using WS2812 LEDs.
## Enabling RGB Underglow ## 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 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). 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 CONFIG_ZMK_RGB_UNDERGLOW=y
# Use the STRIP config specific to the LEDs you're using
CONFIG_WS2812_STRIP=y
``` ```

Write Preview
Loading…
Cancel
Save