summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-11-10 14:37:48 -0500
committerGitHub <noreply@github.com>2020-11-10 14:37:48 -0500
commit3b9130096060759737844331ebd2c0668400dd0c (patch)
tree5ea4d0bf00b454757aafc955d3d5cc150cc29bef
parent348a44a8a387e38922e7e275b1ba9af790648016 (diff)
parent413a917d1492ede36f9c5cc4495596a85f43deb1 (diff)
Merge pull request #345 from Nicell/underglow/add-config_
fix(underglow): Add CONFIG_ to underglow Kconfigs
-rw-r--r--app/boards/shields/corne/corne.conf2
-rw-r--r--app/boards/shields/microdox/microdox.conf2
-rw-r--r--docs/docs/feature/underglow.md26
3 files changed, 15 insertions, 15 deletions
diff --git a/app/boards/shields/corne/corne.conf b/app/boards/shields/corne/corne.conf
index b79385b..974243c 100644
--- a/app/boards/shields/corne/corne.conf
+++ b/app/boards/shields/corne/corne.conf
@@ -1,5 +1,5 @@
# Uncomment the following lines to enable the Corne RGB Underglow
-# ZMK_RGB_UNDERGLOW=y
+# CONFIG_ZMK_RGB_UNDERGLOW=y
# CONFIG_WS2812_STRIP=y
# Uncomment the following line to enable the Corne OLED Display
diff --git a/app/boards/shields/microdox/microdox.conf b/app/boards/shields/microdox/microdox.conf
index 253c94e..0d38398 100644
--- a/app/boards/shields/microdox/microdox.conf
+++ b/app/boards/shields/microdox/microdox.conf
@@ -1,5 +1,5 @@
# Uncomment the following lines to enable the Microdox RGB Underglow
-# ZMK_RGB_UNDERGLOW=y
+# CONFIG_ZMK_RGB_UNDERGLOW=y
# CONFIG_WS2812_STRIP=y
# Uncomment the following line to enable the Microdox OLED Display
diff --git a/docs/docs/feature/underglow.md b/docs/docs/feature/underglow.md
index 5e7db0b..a962142 100644
--- a/docs/docs/feature/underglow.md
+++ b/docs/docs/feature/underglow.md
@@ -21,7 +21,7 @@ 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` and `X_STRIP` configuration values in the `.conf` file of your user config directory as such:
+To enable RGB underglow on your board or shield, simply enable the `CONFIG_ZMK_RGB_UNDERGLOW` and `X_STRIP` configuration values in the `.conf` file of your user config directory as such:
```
CONFIG_ZMK_RGB_UNDERGLOW=y
@@ -35,17 +35,17 @@ If your board or shield does not have RGB underglow configured, refer to [Adding
There are various Kconfig options used to configure the RGB underglow feature. These can all be set in the `.conf` file.
-| Option | Description | Default |
-| ----------------------------- | ---------------------------------------------- | ------- |
-| `ZMK_RGB_UNDERGLOW_HUE_STEP` | Hue step in degrees of 360 used by RGB actions | 10 |
-| `ZMK_RGB_UNDERGLOW_SAT_STEP` | Saturation step in percent used by RGB actions | 10 |
-| `ZMK_RGB_UNDERGLOW_BRT_STEP` | Brightness step in percent used by RGB actions | 10 |
-| `ZMK_RGB_UNDERGLOW_HUE_START` | Default hue 0-359 in degrees | 0 |
-| `ZMK_RGB_UNDERGLOW_SAT_START` | Default saturation 0-100 in percent | 100 |
-| `ZMK_RGB_UNDERGLOW_BRT_START` | Default brightness 0-100 in percent | 100 |
-| `ZMK_RGB_UNDERGLOW_SPD_START` | Default effect speed 1-5 | 3 |
-| `ZMK_RGB_UNDERGLOW_EFF_START` | Default effect integer from the effect enum | 0 |
-| `ZMK_RGB_UNDERGLOW_ON_START` | Default on state | y |
+| Option | Description | Default |
+| ------------------------------------ | ---------------------------------------------- | ------- |
+| `CONFIG_ZMK_RGB_UNDERGLOW_HUE_STEP` | Hue step in degrees of 360 used by RGB actions | 10 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_SAT_STEP` | Saturation step in percent used by RGB actions | 10 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_BRT_STEP` | Brightness step in percent used by RGB actions | 10 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_HUE_START` | Default hue 0-359 in degrees | 0 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_SAT_START` | Default saturation 0-100 in percent | 100 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_BRT_START` | Default brightness 0-100 in percent | 100 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_SPD_START` | Default effect speed 1-5 | 3 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_EFF_START` | Default effect integer from the effect enum | 0 |
+| `CONFIG_ZMK_RGB_UNDERGLOW_ON_START` | Default on state | y |
## Adding RGB Underglow to a Board
@@ -122,7 +122,7 @@ 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` and `X_STRIP` configuration values in the `.conf` file of your board (or set a default in the `Kconfig.defconfig`):
+Finally you need to enable the `CONFIG_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