From 79b4a0ea6fdda3bd65cadd40106518ac20914cf5 Mon Sep 17 00:00:00 2001
From: KemoNine <mcrosson@kemonine.info>
Date: Tue, 15 Dec 2020 11:13:02 +0000
Subject: [PATCH] Add RGB_COLOR_HSB to lighting documentation

---
 docs/docs/behaviors/lighting.md | 58 +++++++++++++++++++++++----------
 1 file changed, 40 insertions(+), 18 deletions(-)

diff --git a/docs/docs/behaviors/lighting.md b/docs/docs/behaviors/lighting.md
index 2d4f532e..2a204e52 100644
--- a/docs/docs/behaviors/lighting.md
+++ b/docs/docs/behaviors/lighting.md
@@ -21,19 +21,20 @@ This will allow you to reference the actions defined in this header such as `RGB
 
 Here is a table describing the action for each define:
 
-| Define    | Action                                                    |
-| --------- | --------------------------------------------------------- |
-| `RGB_TOG` | Toggles the RGB feature on and off                        |
-| `RGB_HUI` | Increases the hue of the RGB feature                      |
-| `RGB_HUD` | Decreases the hue of the RGB feature                      |
-| `RGB_SAI` | Increases the saturation of the RGB feature               |
-| `RGB_SAD` | Decreases the saturation of the RGB feature               |
-| `RGB_BRI` | Increases the brightness of the RGB feature               |
-| `RGB_BRD` | Decreases the brightness of the RGB feature               |
-| `RGB_SPI` | Increases the speed of the RGB feature effect's animation |
-| `RGB_SPD` | Decreases the speed of the RGB feature effect's animation |
-| `RGB_EFF` | Cycles the RGB feature's effect forwards                  |
-| `RGB_EFR` | Cycles the RGB feature's effect reverse                   |
+| Define          | Action                                                                                         |
+| --------------- | ---------------------------------------------------------------------------------------------- |
+| `RGB_TOG`       | Toggles the RGB feature on and off                                                             |
+| `RGB_HUI`       | Increases the hue of the RGB feature                                                           |
+| `RGB_HUD`       | Decreases the hue of the RGB feature                                                           |
+| `RGB_SAI`       | Increases the saturation of the RGB feature                                                    |
+| `RGB_SAD`       | Decreases the saturation of the RGB feature                                                    |
+| `RGB_BRI`       | Increases the brightness of the RGB feature                                                    |
+| `RGB_BRD`       | Decreases the brightness of the RGB feature                                                    |
+| `RGB_SPI`       | Increases the speed of the RGB feature effect's animation                                      |
+| `RGB_SPD`       | Decreases the speed of the RGB feature effect's animation                                      |
+| `RGB_EFF`       | Cycles the RGB feature's effect forwards                                                       |
+| `RGB_EFR`       | Cycles the RGB feature's effect reverse                                                        |
+| `RGB_COLOR_HSB` | Sets a specific [HSB (HSV)](https://en.wikipedia.org/wiki/HSL_and_HSV) value for the underglow |
 
 ## RGB Underglow
 
@@ -42,10 +43,31 @@ The "RGB underglow" behavior completes an RGB action given on press.
 ### Behavior Binding
 
 - Reference: `&rgb_ug`
-- Parameter: The RGB action define, e.g. `RGB_TOG` or `RGB_BRI`
+- Parameter #1: The RGB action define, e.g. `RGB_TOG` or `RGB_BRI`
+- Parameter #1: Only applies to `RGB_COLOR_HSB` and is the HSB values of the color to set within parenthesis and separated by a common (see below for an example)
 
-Example:
+:::note HSB Values
 
-```
-&rgb_ug RGB_TOG
-```
+When specifying HSB values you'll need to use `RGB_COLOR_HSB(h, s, b)` in your keymap file. See below for an example.
+
+Value Limits:
+
+- Hue values can _not_ exceed 360 (degrees)
+- Saturation values can _not_ exceed 100 (percent)
+- Brightness values can _not_ exceed 100 (percent)
+
+:::
+
+### Examples
+
+1. Toggle underglow on/off
+
+   ```
+   &rgb_ug RGB_TOG
+   ```
+
+1. Set a specific HSB color (green)
+
+   ```
+   &rgb_ug RGB_COLOR_HSB(128,100,100)
+   ```