docs/feature_rgblight.md

   1 # RGB Lighting
   2
   3 QMK has the ability to control RGB LEDs attached to your keyboard. This is commonly called *underglow*, due to the LEDs often being mounted on the bottom of the keyboard, producing a nice diffused effect when combined with a translucent case.
   4
   5 ![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/3774a7fcdab5544fc787f4c200be05fcd417e31f/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
   6
   7 Some keyboards come with RGB LEDs preinstalled. Others must have them installed after the fact. See the [Hardware Modification](#hardware-modification) section for information on adding RGB lighting to your keyboard.
   8
   9 Currently QMK supports the following addressable LEDs on AVR microcontrollers (however, the white LED in RGBW variants is not supported):
  10
  11  * WS2811, WS2812, WS2812B, WS2812C, etc.
  12  * SK6812, SK6812MINI, SK6805
  13
  14 These LEDs are called "addressable" because instead of using a wire per color, each LED contains a small microchip that understands a special protocol sent over a single wire. The chip passes on the remaining data to the next LED, allowing them to be chained together. In this way, you can easily control the color of the individual LEDs.
  15
  16 ## Usage
  17
  18 On keyboards with onboard RGB LEDs, it is usually enabled by default. If it is not working for you, check that your `rules.mk` includes the following:
  19
  20 ```make
  21 RGBLIGHT_ENABLE = yes
  22 ```
  23
  24 At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these.
  25
  26 |Define         |Description                                                                                              |
  27 |---------------|---------------------------------------------------------------------------------------------------------|
  28 |`RGB_DI_PIN`   |The pin connected to the data pin of the LEDs                                                            |
  29 |`RGBLED_NUM`   |The number of LEDs connected                                                                             |
  30 |`RGBLED_SPLIT` |(Optional) For split keyboards, the number of LEDs connected on each half directly wired to `RGB_DI_PIN` |
  31
  32 Then you should be able to use the keycodes below to change the RGB lighting to your liking.
  33
  34 ### Color Selection
  35
  36 QMK uses [Hue, Saturation, and Value](https://en.wikipedia.org/wiki/HSL_and_HSV) to select colors rather than RGB. The color wheel below demonstrates how this works.
  37
  38 <img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250"/>
  39
  40 Changing the **Hue** cycles around the circle.
  41 Changing the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color.
  42 Changing the **Value** sets the overall brightness.
  43
  44 ## Keycodes
  45
  46 |Key                |Aliases   |Description                                                         |
  47 |-------------------|----------|--------------------------------------------------------------------|
  48 |`RGB_TOG`          |          |Toggle RGB lighting on or off                                       |
  49 |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held           |
  50 |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
  51 |`RGB_HUI`          |          |Increase hue                                                        |
  52 |`RGB_HUD`          |          |Decrease hue                                                        |
  53 |`RGB_SAI`          |          |Increase saturation                                                 |
  54 |`RGB_SAD`          |          |Decrease saturation                                                 |
  55 |`RGB_VAI`          |          |Increase value (brightness)                                         |
  56 |`RGB_VAD`          |          |Decrease value (brightness)                                         |
  57 |`RGB_MODE_PLAIN`   |`RGB_M_P `|Static (no animation) mode                                          |
  58 |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode                                            |
  59 |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode                                              |
  60 |`RGB_MODE_SWIRL`   |`RGB_M_SW`|Swirl animation mode                                                |
  61 |`RGB_MODE_SNAKE`   |`RGB_M_SN`|Snake animation mode                                                |
  62 |`RGB_MODE_KNIGHT`  |`RGB_M_K` |"Knight Rider" animation mode                                       |
  63 |`RGB_MODE_XMAS`    |`RGB_M_X` |Christmas animation mode                                            |
  64 |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode                                      |
  65 |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode                                |
  66
  67 ## Configuration
  68
  69 Your RGB lighting can be configured by placing these `#define`s in your `config.h`:
  70
  71 |Define               |Default      |Description                                                                  |
  72 |---------------------|-------------|-----------------------------------------------------------------------------|
  73 |`RGBLIGHT_HUE_STEP`  |`10`         |The number of steps to cycle through the hue by                              |
  74 |`RGBLIGHT_SAT_STEP`  |`17`         |The number of steps to increment the saturation by                           |
  75 |`RGBLIGHT_VAL_STEP`  |`17`         |The number of steps to increment the brightness by                           |
  76 |`RGBLIGHT_LIMIT_VAL` |`255`        |The maximum brightness level                                                 |
  77 |`RGBLIGHT_SLEEP`     |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep|
  78
  79 ## Animations
  80
  81
  82 Not only can this lighting be whatever color you want,
  83 if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal:
  84
  85 |Mode number symbol           |Additional number  |Description                            |
  86 |-----------------------------|-------------------|---------------------------------------|
  87 |`RGBLIGHT_MODE_STATIC_LIGHT` | *None*            |Solid color (this mode is always enabled) |
  88 |`RGBLIGHT_MODE_BREATHING`    | 0,1,2,3           |Solid color breathing                  |
  89 |`RGBLIGHT_MODE_RAINBOW_MOOD` | 0,1,2             |Cycling rainbow                        |
  90 |`RGBLIGHT_MODE_RAINBOW_SWIRL`| 0,1,2,3,4,5       |Swirling rainbow                       |
  91 |`RGBLIGHT_MODE_SNAKE`        | 0,1,2,3,4,5       |Snake                                  |
  92 |`RGBLIGHT_MODE_KNIGHT`       | 0,1,2             |Knight                                 |
  93 |`RGBLIGHT_MODE_CHRISTMAS`    | *None*            |Christmas                              |
  94 |`RGBLIGHT_MODE_STATIC_GRADIENT`| 0,1,..,9        |Static gradient                        |
  95 |`RGBLIGHT_MODE_RGB_TEST`     | *None*            |RGB Test                               |
  96 |`RGBLIGHT_MODE_ALTERNATING`  | *None*            |Alternating                            |
  97
  98 Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
  99
 100 Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol.
 101
 102 The following options can be used to tweak the various animations:
 103
 104 |Define                              |Default      |Description                                                                          |
 105 |------------------------------------|-------------|-------------------------------------------------------------------------------------|
 106 |`RGBLIGHT_EFFECT_BREATHING`         |*Not defined*|If defined, enable breathing animation mode.                                         |
 107 |`RGBLIGHT_EFFECT_RAINBOW_MOOD`      |*Not defined*|If defined, enable rainbow mood animation mode.                                      |
 108 |`RGBLIGHT_EFFECT_RAINBOW_SWIRL`     |*Not defined*|If defined, enable rainbow swirl animation mode.                                     |
 109 |`RGBLIGHT_EFFECT_SNAKE`             |*Not defined*|If defined, enable snake animation mode.                                             |
 110 |`RGBLIGHT_EFFECT_KNIGHT`            |*Not defined*|If defined, enable knight animation mode.                                            |
 111 |`RGBLIGHT_EFFECT_CHRISTMAS`         |*Not defined*|If defined, enable christmas animation mode.                                         |
 112 |`RGBLIGHT_EFFECT_STATIC_GRADIENT`   |*Not defined*|If defined, enable static gradient mode.                                             |
 113 |`RGBLIGHT_EFFECT_RGB_TEST`          |*Not defined*|If defined, enable RGB test animation mode.                                          |
 114 |`RGBLIGHT_EFFECT_ALTERNATING`       |*Not defined*|If defined, enable alternating animation mode.                                       |
 115 |`RGBLIGHT_ANIMATIONS`               |*Not defined*|If defined, enables all additional animation modes                                   |
 116 |`RGBLIGHT_EFFECT_BREATHE_CENTER`    |`1.85`       |Used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 |
 117 |`RGBLIGHT_EFFECT_BREATHE_MAX`       |`255`        |The maximum brightness for the breathing mode. Valid values are 1 to 255             |
 118 |`RGBLIGHT_EFFECT_SNAKE_LENGTH`      |`4`          |The number of LEDs to light up for the "Snake" animation                             |
 119 |`RGBLIGHT_EFFECT_KNIGHT_LENGTH`     |`3`          |The number of LEDs to light up for the "Knight" animation                            |
 120 |`RGBLIGHT_EFFECT_KNIGHT_OFFSET`     |`0`          |The number of LEDs to start the "Knight" animation from the start of the strip by    |
 121 |`RGBLIGHT_EFFECT_KNIGHT_LED_NUM`    |`RGBLED_NUM` |The number of LEDs to have the "Knight" animation travel                             |
 122 |`RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL`|`1000`       |How long to wait between light changes for the "Christmas" animation, in milliseconds|
 123 |`RGBLIGHT_EFFECT_CHRISTMAS_STEP`    |`2`          |The number of LEDs to group the red/green colors by for the "Christmas" animation    |
 124 |`RGBLIGHT_RAINBOW_SWIRL_RANGE`      |`360`        |Range adjustment for the rainbow swirl effect to get different swirls                |
 125
 126 You can also modify the speeds that the different modes animate at:
 127
 128 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
 129
 130 ```c
 131 // How long (in milliseconds) to wait between animation steps for each of the "Solid color breathing" animations
 132 const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};
 133
 134 // How long (in milliseconds) to wait between animation steps for each of the "Cycling rainbow" animations
 135 const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};
 136
 137 // How long (in milliseconds) to wait between animation steps for each of the "Swirling rainbow" animations
 138 const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};
 139
 140 // How long (in milliseconds) to wait between animation steps for each of the "Snake" animations
 141 const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
 142
 143 // How long (in milliseconds) to wait between animation steps for each of the "Knight" animations
 144 const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};
 145
 146 // These control which hues are selected for each of the "Static gradient" modes
 147 const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90};
 148 ```
 149
 150 ## Functions
 151
 152 If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight.h) for the full list, but the most commonly used functions include:
 153
 154 |Function                                    |Description                                                                                                                                                   |
 155 |--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
 156 |`rgblight_enable()`                         |Turn LEDs on, based on their previous state                                                                                                                   |
 157 |`rgblight_enable_noeeprom()`                |Turn LEDs on, based on their previous state (not written to EEPROM)                                                                                           |
 158 |`rgblight_disable()`                        |Turn LEDs off                                                                                                                                                 |
 159 |`rgblight_disable_noeeprom()`               |Turn LEDs off (not written to EEPROM)                                                                                                                         |
 160 |`rgblight_mode(x)`                          |Set the mode, if RGB animations are enabled                                                                                                                   |
 161 |`rgblight_mode_noeeprom(x)`                 |Set the mode, if RGB animations are enabled (not written to EEPROM)                                                                                           |
 162 |`rgblight_setrgb(r, g, b)`                  |Set all LEDs to the given RGB value where `r`/`g`/`b` are between 0 and 255 (not written to EEPROM)                                                           |
 163 |`rgblight_setrgb_at(r, g, b, led)`          |Set a single LED to the given RGB value, where `r`/`g`/`b` are between 0 and 255 and `led` is between 0 and `RGBLED_NUM` (not written to EEPROM)              |
 164 |`rgblight_setrgb_range(r, g, b, start, end)`|Set a continuous range of LEDs to the given RGB value, where `r`/`g`/`b` are between 0 and 255 and `start`(included) and `stop`(excluded) are between 0 and `RGBLED_NUM` (not written to EEPROM)|
 165 |`rgblight_setrgb_master(r, g, b)`           |Set the LEDs on the master side  to the given RGB value, where `r`/`g`/`b` are between 0 and 255 (not written to EEPROM)                                      |
 166 |`rgblight_setrgb_slave(r, g, b)`            |Set the LEDs on the slave side  to the given RGB value, where `r`/`g`/`b` are between 0 and 255 (not written to EEPROM)                                       |
 167 |`rgblight_sethsv(h, s, v)`                  |Set all LEDs to the given HSV value where `h` is between 0 and 360 and `s`/`v` are between 0 and 255                                                          |
 168 |`rgblight_sethsv_noeeprom(h, s, v)`         |Set all LEDs to the given HSV value where `h` is between 0 and 360 and `s`/`v` are between 0 and 255 (not written to EEPROM)                                  |
 169 |`rgblight_sethsv_at(h, s, v, led)`          |Set a single LED to the given HSV value, where `h` is between 0 and 360, `s`/`v` are between 0 and 255, and `led` is between 0 and `RGBLED_NUM` (not written to EEPROM)|
 170 |`rgblight_sethsv_range(h, s, v, start, end)`|Set a continuous range of LEDs to the given HSV value, where `h` is between 0 and 360, `s`/`v` are between 0 and 255, and `start`(included) and `stop`(excluded) are between 0 and `RGBLED_NUM` (not written to EEPROM)|
 171 |`rgblight_sethsv_master(h, s, v)`           |Set the LEDs on the master side to the given HSV value, where `h` is between 0 and 360, `s`/`v` are between 0 and 255 (not written to EEPROM)                 |
 172 |`rgblight_sethsv_slave(h, s, v)`            |Set the LEDs on the slave side to the given HSV value, where `h` is between 0 and 360, `s`/`v` are between 0 and 255 (not written to EEPROM)                  |
 173 |`rgblight_toggle()`                         |Toggle all LEDs between on and off                                                                                                                            |
 174 |`rgblight_toggle_noeeprom()`                |Toggle all LEDs between on and off (not written to EEPROM)                                                                                                    |
 175 |`rgblight_step()`                           |Change the mode to the next RGB animation in the list of enabled RGB animations                                                                               |
 176 |`rgblight_step_noeeprom()`                  |Change the mode to the next RGB animation in the list of enabled RGB animations (not written to EEPROM)                                                       |
 177 |`rgblight_step_reverse()`                   |Change the mode to the previous RGB animation in the list of enabled RGB animations                                                                           |
 178 |`rgblight_step_reverse_noeeprom()`          |Change the mode to the previous RGB animation in the list of enabled RGB animations (not written to EEPROM)                                                   |
 179 |`rgblight_increase_hue()`                   |Increase the hue for all LEDs. This wraps around at maximum hue                                                                                               |
 180 |`rgblight_increase_hue_noeeprom()`          |Increase the hue for all LEDs. This wraps around at maximum hue (not written to EEPROM)                                                                       |
 181 |`rgblight_decrease_hue()`                   |Decrease the hue for all LEDs. This wraps around at minimum hue                                                                                               |
 182 |`rgblight_decrease_hue_noeeprom()`          |Decrease the hue for all LEDs. This wraps around at minimum hue (not written to EEPROM)                                                                       |
 183 |`rgblight_increase_sat()`                   |Increase the saturation for all LEDs. This wraps around at maximum saturation                                                                                 |
 184 |`rgblight_increase_sat_noeeprom()`          |Increase the saturation for all LEDs. This wraps around at maximum saturation (not written to EEPROM)                                                         |
 185 |`rgblight_decrease_sat()`                   |Decrease the saturation for all LEDs. This wraps around at minimum saturation                                                                                 |
 186 |`rgblight_decrease_sat_noeeprom()`          |Decrease the saturation for all LEDs. This wraps around at minimum saturation (not written to EEPROM)                                                         |
 187 |`rgblight_increase_val()`                   |Increase the value for all LEDs. This wraps around at maximum value                                                                                           |
 188 |`rgblight_increase_val_noeeprom()`          |Increase the value for all LEDs. This wraps around at maximum value (not written to EEPROM)                                                                   |
 189 |`rgblight_decrease_val()`                   |Decrease the value for all LEDs. This wraps around at minimum value                                                                                           |
 190 |`rgblight_decrease_val_noeeprom()`          |Decrease the value for all LEDs. This wraps around at minimum value (not written to EEPROM)                                                                   |
 191 |`rgblight_set_clipping_range(pos, num)`     |Set clipping Range                                                                                                                                            |
 192
 193 Additionally, [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h) defines several predefined shortcuts for various colors. Feel free to add to this list!
 194
 195 ## Changing the order of the LEDs
 196
 197 If you want to make the logical order of LEDs different from the electrical connection order, you can do this by defining the `RGBLIGHT_LED_MAP` macro in your `config.h`.
 198
 199 Normally, the contents of the LED buffer are output to the LEDs in the same order.
 200 <img src="https://user-images.githubusercontent.com/2170248/55743718-01866c80-5a6e-11e9-8134-25419928327a.JPG" alt="simple dicrect" width="50%"/>
 201
 202 By defining `RGBLIGHT_LED_MAP` as in the example below, you can specify the LED with addressing in reverse order of the electrical connection order.
 203
 204 ```c
 205 // config.h
 206
 207 #define RGBLED_NUM 4
 208 #define RGBLIGHT_LED_MAP { 3, 2, 1, 0 }
 209
 210 ```
 211 <img src="https://user-images.githubusercontent.com/2170248/55743725-08ad7a80-5a6e-11e9-83ed-126a2b0209fc.JPG" alt="simple mapped" width="50%"/>
 212
 213 For keyboards that use the RGB LEDs as a backlight for each key, you can also define it as in the example below.
 214
 215 ```c
 216 // config.h
 217
 218 #define RGBLED_NUM 30
 219
 220 /* RGB LED Conversion macro from physical array to electric array */
 221 #define LED_LAYOUT( \
 222     L00, L01, L02, L03, L04, L05,  \
 223     L10, L11, L12, L13, L14, L15,  \
 224     L20, L21, L22, L23, L24, L25,  \
 225     L30, L31, L32, L33, L34, L35,  \
 226     L40, L41, L42, L43, L44, L45 ) \
 227   { \
 228     L05, L04, L03, L02, L01, L00,   \
 229     L10, L11, L12, L13, L14, L15,   \
 230     L25, L24, L23, L22, L21, L20,   \
 231     L30, L31, L32, L33, L34, L35,   \
 232     L46, L45, L44, L43, L42, L41    \
 233   }
 234
 235 /* RGB LED logical order map */
 236 /* Top->Bottom, Right->Left */
 237 #define RGBLIGHT_LED_MAP LED_LAYOUT( \
 238   25, 20, 15, 10,  5,  0,       \
 239   26, 21, 16, 11,  6,  1,       \
 240   27, 22, 17, 12,  7,  2,       \
 241   28, 23, 18, 13,  8,  3,       \
 242   29, 24, 19, 14,  9,  4 )
 243
 244 ```
 245 ## Clipping Range
 246
 247 Using the `rgblight_set_clipping_range()` function, you can prepare more buffers than the actual number of LEDs, and output some of the buffers to the LEDs. This is useful if you want the split keyboard to treat left and right LEDs as logically contiguous.
 248
 249 You can set the Clipping Range by executing the following code.
 250
 251 ```c
 252 // some soruce
 253   rgblight_set_clipping_range(3, 4);
 254 ```
 255 <img src="https://user-images.githubusercontent.com/2170248/55743785-2bd82a00-5a6e-11e9-9d4b-1b4ffaf4932b.JPG" alt="clip direct" width="70%"/>
 256
 257 In addition to setting the Clipping Range, you can use `RGBLIGHT_LED_MAP` together.
 258
 259 ```c
 260 // config.h
 261 #define RGBLED_NUM 8
 262 #define RGBLIGHT_LED_MAP { 7, 6, 5, 4, 3, 2, 1, 0 }
 263
 264 // some soruce
 265   rgblight_set_clipping_range(3, 4);
 266 ```
 267 <img src="https://user-images.githubusercontent.com/2170248/55743747-119e4c00-5a6e-11e9-91e5-013203ffae8a.JPG" alt="clip mapped" width="70%"/>
 268
 269 If your keyboard lacks onboard underglow LEDs, you may often be able to solder on an RGB LED strip yourself. You will need to find an unused pin to wire to the data pin of your LED strip. Some keyboards may break out unused pins from the MCU to make soldering easier. The other two pins, VCC and GND, must also be connected to the appropriate power pins.