From e86d6b2f65bcc486985f060a8cc0b5eed38678c7 Mon Sep 17 00:00:00 2001
From: ReFil <31960031+ReFil@users.noreply.github.com>
Date: Thu, 19 Oct 2023 09:42:42 +0100
Subject: [PATCH] feat(docs): Document and define different RGB effects

Co-Authored-By: Cem Aksoylar <caksoylar@users.noreply.github.com>
---
 app/include/dt-bindings/zmk/rgb.h        | 7 ++++++-
 docs/docs/keymaps/behaviors/underglow.md | 6 ++++++
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/app/include/dt-bindings/zmk/rgb.h b/app/include/dt-bindings/zmk/rgb.h
index f9ea5f21140..2c1ed34e90c 100644
--- a/app/include/dt-bindings/zmk/rgb.h
+++ b/app/include/dt-bindings/zmk/rgb.h
@@ -38,4 +38,9 @@
 #define RGB_MEFS RGB_MEFS_CMD
 #define RGB_COLOR_HSB_VAL(h, s, v) (((h) << 16) + ((s) << 8) + (v))
 #define RGB_COLOR_HSB(h, s, v) RGB_COLOR_HSB_CMD##(RGB_COLOR_HSB_VAL(h, s, v))
-#define RGB_COLOR_HSV RGB_COLOR_HSB
\ No newline at end of file
+#define RGB_COLOR_HSV RGB_COLOR_HSB
+
+#define RGB_EFF_SOLID 0
+#define RGB_EFF_BREATHE 1
+#define RGB_EFF_SPECTRUM 2
+#define RGB_EFF_SWIRL 3
\ No newline at end of file
diff --git a/docs/docs/keymaps/behaviors/underglow.md b/docs/docs/keymaps/behaviors/underglow.md
index c776ec044c3..8c4be9fe14f 100644
--- a/docs/docs/keymaps/behaviors/underglow.md
+++ b/docs/docs/keymaps/behaviors/underglow.md
@@ -98,6 +98,12 @@ If the `RGB_MEFS` key is held down for longer than [`CONFIG_ZMK_SETTINGS_SAVE_DE
    &rgb_ug RGB_COLOR_HSB(128,100,100)
    ```
 
+1. Select a specific RGB effect (Swirl)
+
+   ```dts
+   &rgb_ug RGB_EFS RGB_EFF_SWIRL
+   ```
+
 ## Split Keyboards
 
 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.