summaryrefslogtreecommitdiffstats
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-08-07 02:51:42 +0200
committerJack Humbert <jack.humb@gmail.com>2017-08-16 21:47:20 +0200
commit9b879b1267cd5cbebf4d73595c7ca4ed52fe5ef4 (patch)
treee47cc787fcb7745d83d6e645b21c00e498b55100 /docs/feature_rgblight.md
parent2709744cdda808121ae91e8467659f715e68a540 (diff)
downloadqmk_firmware-9b879b1267cd5cbebf4d73595c7ca4ed52fe5ef4.tar.gz
qmk_firmware-9b879b1267cd5cbebf4d73595c7ca4ed52fe5ef4.tar.xz
break up keymaps and quantum keycodes into files by feature
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
new file mode 100644
index 000000000..8bbe06b97
--- /dev/null
+++ b/docs/feature_rgblight.md
@@ -0,0 +1,18 @@
+# RGB Lighting
+
+<!-- FIXME: Describe how to use RGB Lighting here. -->
+
+## RGB Lighting Keycodes
+
+This controls the RGB Lighting functionality. Most keyboards use WS2812 (and compatible) LEDs for underlight or case lighting.
+
+|Name|Description|
+|----|-----------|
+|`RGB_TOG`|toggle on/off|
+|`RGB_MOD`|cycle through modes|
+|`RGB_HUI`|hue increase|
+|`RGB_HUD`|hue decrease|
+|`RGB_SAI`|saturation increase|
+|`RGB_SAD`|saturation decrease|
+|`RGB_VAI`|value increase|
+|`RGB_VAD`|value decrease|