Skip to content

Commit 8007163

Browse files
ReFilcaksoylar
andcommitted
feat(docs): Document and define different RGB effects
Co-Authored-By: Cem Aksoylar <caksoylar@users.noreply.github.com>
1 parent 4163465 commit 8007163

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

app/include/dt-bindings/zmk/rgb.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,9 @@
3838
#define RGB_MEFS RGB_MEFS_CMD
3939
#define RGB_COLOR_HSB_VAL(h, s, v) (((h) << 16) + ((s) << 8) + (v))
4040
#define RGB_COLOR_HSB(h, s, v) RGB_COLOR_HSB_CMD##(RGB_COLOR_HSB_VAL(h, s, v))
41-
#define RGB_COLOR_HSV RGB_COLOR_HSB
41+
#define RGB_COLOR_HSV RGB_COLOR_HSB
42+
43+
#define RGB_EFF_SOLID 0
44+
#define RGB_EFF_BREATHE 1
45+
#define RGB_EFF_SPECTRUM 2
46+
#define RGB_EFF_SWIRL 3

docs/docs/keymaps/behaviors/underglow.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ If the `RGB_MEFS` key is held down for longer than [`CONFIG_ZMK_SETTINGS_SAVE_DE
9898
&rgb_ug RGB_COLOR_HSB(128,100,100)
9999
```
100100

101+
1. Select a specific RGB effect (Swirl)
102+
103+
```dts
104+
&rgb_ug RGB_EFS RGB_EFF_SWIRL
105+
```
106+
101107
## Split Keyboards
102108

103109
RGB underglow behaviors are [global](../../features/split-keyboards.md#global-locality-behaviors): This means that when triggered, they affect both the central and peripheral side of split keyboards.

0 commit comments

Comments
 (0)