From 4580d3a730c078484ea417575c617c17598b5a39 Mon Sep 17 00:00:00 2001 From: skullydazed Date: Wed, 6 Sep 2017 14:49:19 -0700 Subject: RGB improvements (#1684) * Allow the knight animation to be restricted to a portion of the LED strip * Add keys for jumping directly to particular animation modes * Remove orphaned break statements * Tweak the `RGB_MODE` buttons so they cycle through the same mode. * small indentation fix --- docs/feature_rgblight.md | 130 ++++++-- docs/gitbook/images/color-wheel.svg | 441 +++++++++++++++++++++++++++ keyboards/clueboard/keymaps/default/keymap.c | 4 +- keyboards/clueboard/rev2/config.h | 11 +- quantum/quantum.c | 158 ++++++---- quantum/quantum_keycodes.h | 16 + quantum/rgblight.c | 24 +- quantum/rgblight.h | 10 +- 8 files changed, 699 insertions(+), 95 deletions(-) create mode 100644 docs/gitbook/images/color-wheel.svg diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 7f12155cb7..e7b1bb9d25 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -1,8 +1,107 @@ # RGB Lighting - +If you've installed addressable RGB lights on your keyboard you can control them with QMK. Currently we support the following addressable LEDs on Atmel AVR processors: -## RGB Under Glow Mod +* WS2811 and variants (WS2812, WS2812B, WS2812C, etc) +* SK6812RGBW + +Some keyboards come with RGB LEDs pre-installed. Others have to have LEDs installed after the fact. See below for information on modifying your keyboard. + +## Selecting Colors + +QMK uses Hue, Saturation, and Value to set color rather than using RGB. You can use the color wheel below to see how this works. Changing the Hue will cycle around the circle. Saturation will affect the intensity of the color, which you can see as you move from the inner part to the outer part of the wheel. Value sets the overall brightness. + +![gitbook/images/color-wheel.svg] + +If you would like to learn more about HSV you can start with the [wikipedia article](https://en.wikipedia.org/wiki/HSL_and_HSV). + +## Configuration + +Before RGB Lighting can be used you have to enable it in `rules.mk`: + + RGBLIGHT_ENABLE = yes + +You can configure the behavior of the RGB lighting by defining values inside `config.h`. + +### Required Configuration + +At minimum you have to define the pin your LED strip is connected to and the number of LEDs connected. + +```c +#define RGB_DI_PIN D7 // The pin the LED strip is connected to +#define RGBLED_NUM 14 // Number of LEDs in your strip +``` + +### Optional Configuration + +You can change the behavior of the RGB Lighting by setting these configuration values. Use `#define