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
  31 Then you should be able to use the keycodes below to change the RGB lighting to your liking.
  32
  33 ### Color Selection
  34
  35 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.
  36
  37 <img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250"/>
  38
  39 Changing the **Hue** cycles around the circle.
  40 Changing the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color.
  41 Changing the **Value** sets the overall brightness.
  42
  43 ## Keycodes
  44
  45 |Key                |Aliases   |Description                                                         |
  46 |-------------------|----------|--------------------------------------------------------------------|
  47 |`RGB_TOG`          |          |Toggle RGB lighting on or off                                       |
  48 |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held           |
  49 |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
  50 |`RGB_HUI`          |          |Increase hue                                                        |
  51 |`RGB_HUD`          |          |Decrease hue                                                        |
  52 |`RGB_SAI`          |          |Increase saturation                                                 |
  53 |`RGB_SAD`          |          |Decrease saturation                                                 |
  54 |`RGB_VAI`          |          |Increase value (brightness)                                         |
  55 |`RGB_VAD`          |          |Decrease value (brightness)                                         |
  56 |`RGB_MODE_PLAIN`   |`RGB_M_P `|Static (no animation) mode                                          |
  57 |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode                                            |
  58 |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode                                              |
  59 |`RGB_MODE_SWIRL`   |`RGB_M_SW`|Swirl animation mode                                                |
  60 |`RGB_MODE_SNAKE`   |`RGB_M_SN`|Snake animation mode                                                |
  61 |`RGB_MODE_KNIGHT`  |`RGB_M_K` |"Knight Rider" animation mode                                       |
  62 |`RGB_MODE_XMAS`    |`RGB_M_X` |Christmas animation mode                                            |
  63 |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode                                      |
  64 |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode                                |
  65
  66 ?> For backwards compatibility, `RGB_SMOD` is another alias of `RGB_MOD`.
  67
  68 ## Configuration
  69
  70 Your RGB lighting can be configured by placing these `#define`s in your `config.h`:
  71
  72 |Define               |Default      |Description                                                                  |
  73 |---------------------|-------------|-----------------------------------------------------------------------------|
  74 |`RGBLIGHT_HUE_STEP`  |`10`         |The number of steps to cycle through the hue by                              |
  75 |`RGBLIGHT_SAT_STEP`  |`17`         |The number of steps to increment the saturation by                           |
  76 |`RGBLIGHT_VAL_STEP`  |`17`         |The number of steps to increment the brightness by                           |
  77 |`RGBLIGHT_LIMIT_VAL` |`255`        |The maximum brightness level                                                 |
  78 |`RGBLIGHT_SLEEP`     |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep|
  79
  80 ## Animations
  81
  82 Not only can this lighting be whatever color you want, if `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal:
  83
  84 |Mode |Description          |
  85 |-----|---------------------|
  86 |1    |Solid color          |
  87 |2-5  |Solid color breathing|
  88 |6-8  |Cycling rainbow      |
  89 |9-14 |Swirling rainbow     |
  90 |15-20|Snake                |
  91 |21-23|Knight               |
  92 |24   |Christmas            |
  93 |25-34|Static gradient      |
  94 |35   |RGB Test             |
  95 |36   |Alternating          |
  96
  97 Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
  98
  99 The following options can be used to tweak the various animations:
 100
 101 |Define                              |Default      |Description                                                                          |
 102 |------------------------------------|-------------|-------------------------------------------------------------------------------------|
 103 |`RGBLIGHT_ANIMATIONS`               |*Not defined*|If defined, enables additional animation modes                                       |
 104 |`RGBLIGHT_EFFECT_BREATHE_CENTER`    |`1.85`       |Used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 |
 105 |`RGBLIGHT_EFFECT_BREATHE_MAX`       |`255`        |The maximum brightness for the breathing mode. Valid values are 1 to 255             |
 106 |`RGBLIGHT_EFFECT_SNAKE_LENGTH`      |`4`          |The number of LEDs to light up for the "Snake" animation                             |
 107 |`RGBLIGHT_EFFECT_KNIGHT_LENGTH`     |`3`          |The number of LEDs to light up for the "Knight" animation                            |
 108 |`RGBLIGHT_EFFECT_KNIGHT_OFFSET`     |`0`          |The number of LEDs to start the "Knight" animation from the start of the strip by    |
 109 |`RGBLIGHT_EFFECT_KNIGHT_LED_NUM`    |`RGBLED_NUM` |The number of LEDs to have the "Knight" animation travel                             |
 110 |`RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL`|`1000`       |How long to wait between light changes for the "Christmas" animation, in milliseconds|
 111 |`RGBLIGHT_EFFECT_CHRISTMAS_STEP`    |`2`          |The number of LEDs to group the red/green colors by for the "Christmas" animation    |
 112
 113 You can also modify the speeds that the different modes animate at:
 114
 115 ```c
 116 // How long (in milliseconds) to wait between animation steps for each of the "Solid color breathing" animations
 117 const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};
 118
 119 // How long (in milliseconds) to wait between animation steps for each of the "Cycling rainbow" animations
 120 const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};
 121
 122 // How long (in milliseconds) to wait between animation steps for each of the "Swirling rainbow" animations
 123 const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};
 124
 125 // How long (in milliseconds) to wait between animation steps for each of the "Snake" animations
 126 const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
 127
 128 // How long (in milliseconds) to wait between animation steps for each of the "Knight" animations
 129 const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};
 130
 131 // These control which hues are selected for each of the "Static gradient" modes
 132 const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90};
 133 ```
 134
 135 ## Functions
 136
 137 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:
 138
 139 |Function                           |Description                                                                                                                                                            |
 140 |-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 141 |`rgblight_enable()`                |Turn LEDs on, based on their previous state                                                                                                                            |
 142 |`rgblight_enable_noeeprom()`       |Turn LEDs on, based on their previous state (not written to EEPROM)                                                                                                    |
 143 |`rgblight_disable()`               |Turn LEDs off                                                                                                                                                          |
 144 |`rgblight_disable_noeeprom()`      |Turn LEDs off (not written to EEPROM)                                                                                                                                  |
 145 |`rgblight_mode(x)`                 |Set the mode, if RGB animations are enabled                                                                                                                            |
 146 |`rgblight_mode_noeeprom(x)`        |Set the mode, if RGB animations are enabled (not written to EEPROM)                                                                                                    |
 147 |`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)                                                                    |
 148 |`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)                       |
 149 |`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                                                                   |
 150 |`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)                                           |
 151 |`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)|
 152
 153 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!
 154
 155 ## Hardware Modification
 156
 157 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.