summaryrefslogtreecommitdiffstats
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorColin T.A. Gray <colinta@gmail.com>2017-12-05 19:56:15 +0100
committerJack Humbert <jack.humb@gmail.com>2017-12-08 22:10:42 +0100
commit16546ee06fa71bd9b9e9d3fda7c8816675e12185 (patch)
tree0fb62a810727a5c0745f94573715b6c027f577a3 /docs/feature_rgblight.md
parent1620d78e73f8e01ed1d48255c655d9eb6cc1b135 (diff)
downloadqmk_firmware-16546ee06fa71bd9b9e9d3fda7c8816675e12185.tar.gz
qmk_firmware-16546ee06fa71bd9b9e9d3fda7c8816675e12185.tar.xz
Add 'rgblight_disable' and 'rgblight_setrgb_at/rgblight_sethsv_at'
Refactors rgblight_toggle to use rgblight_enable or rgblight_disable Use 'rgblight_setrgb_at/rgblight_sethsv_at' to control an individual LED
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 9d8f537df..bd9cb352c 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -80,6 +80,20 @@ const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};
const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90};
```
+### LED control
+
+Look in `rgblights.h` for all available functions, but if you want to control all or some LEDs your goto functions are:
+
+```c
+rgblight_disable(); // turn all lights off
+rgblight_enable(); // turn lights on, based on their previous state (stored in EEPROM)
+
+rgblight_setrgb(r, g, b); // where r/g/b is a number from 0..255. Turns all the LEDs to this color
+rgblight_sethsv(h, s, v); // HSV color control
+rgblight_setrgb_at(r,g,b, LED); // control a single LED. 0 <= LED < RGBLED_NUM
+rgblight_sethsv_at(h,s,v, LED); // control a single LED. 0 <= LED < RGBLED_NUM
+```
+
## RGB Lighting Keycodes
These control the RGB Lighting functionality.