From 3abf5ff0dc1bddf00b0b05dab2314dbeb70086b2 Mon Sep 17 00:00:00 2001 From: ReFil <31960031+ReFil@users.noreply.github.com> Date: Thu, 19 Oct 2023 22:18:48 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Cem Aksoylar --- docs/docs/behaviors/underglow.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docs/behaviors/underglow.md b/docs/docs/behaviors/underglow.md index 5185ceaece2..a2e31bcef4e 100644 --- a/docs/docs/behaviors/underglow.md +++ b/docs/docs/behaviors/underglow.md @@ -65,14 +65,14 @@ However the settings will only be saved after [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNC :::note Effect Selection -When using the `RGB_EFS` or `RGB_MEFS` definitions you must also include a number as an argument in the keymap corresponding to the effect you want to select e.g. `RGB_EFS 0`. There are 4 RGB effects currently, defined in [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h). They correspond to the options for [`CONFIG_ZMK_RGB_UNDERGLOW_EFF_START`](../config/underglow.md#kconfig). +When using the `RGB_EFS` or `RGB_MEFS` definitions you must also include a parameter corresponding to the effect you want to select, e.g. `&rgb_ug RGB_EFS RGB_EFF_SOLID`. There are currently 4 RGB effects, defined in [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h): -| Value | Effect | -| ---------------- | ------------------------------------------ | -| RGB_EFF_SOLID | Solid color (Set by HSV) | -| RGB_EFF_BREATHE | Breathe a solid colour | -| RGB_EFF_SPECTRUM | Cycle all LEDs through the colour spectrum | -| RGB_EFF_SWIRL | Swirl a rainbow around the LEDs | +| Value | Effect | +| ---------------- | ----------------------------------------- | +| RGB_EFF_SOLID | Solid color (set by HSB) | +| RGB_EFF_BREATHE | Breathe a solid color | +| RGB_EFF_SPECTRUM | Cycle all LEDs through the color spectrum | +| RGB_EFF_SWIRL | Swirl a rainbow around the LEDs | If the `RGB_MEFS` key is held down for longer than [`CONFIG_ZMK_SETTINGS_SAVE_DEBOUNCE`](../config/system.md#general) milliseconds and the board is reset prior to releasing the key the temporary effect will have been saved to flash memory and will be restored after resetting/power cycling @@ -95,7 +95,7 @@ If the `RGB_MEFS` key is held down for longer than [`CONFIG_ZMK_SETTINGS_SAVE_DE 1. Select a specific RGB effect (Swirl) ```dts - &rgb_ug RGB_EFS 3 + &rgb_ug RGB_EFS RGB_EFF_SWIRL ``` ## Split Keyboards