diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-10-18 22:29:55 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-18 22:29:55 -0400 |
| commit | ef37f17796a32ccc4b09b5a797c87147259b6088 (patch) | |
| tree | aafdc0f6124b17fd5179b7eb4cd5ad094607788a /docs | |
| parent | 09d3d343755df3fe3019e6774183cede4acc6ff1 (diff) | |
| parent | 608ae0df6dfe4d75bc98c36f6756dc4d69399109 (diff) | |
Merge pull request #109 from Nicell/underglow/state-persistence
Add RGB underglow state Kconfig and settings
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/feature/underglow.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/docs/feature/underglow.md b/docs/docs/feature/underglow.md index c6517ce..ab44ebd 100644 --- a/docs/docs/feature/underglow.md +++ b/docs/docs/feature/underglow.md @@ -35,11 +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` | +| 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 | ## Adding RGB Underglow to a Board |