docs/feature_rgblight.md

   1 # RGB Lighting
   2
   3 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:
   4
   5 * WS2811 and variants (WS2812, WS2812B, WS2812C, etc)
   6 * SK6812RGBW
   7
   8 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.
   9
  10 ## Selecting Colors
  11
  12 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.
  13
  14 <img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250">
  15
  16 If you would like to learn more about HSV you can start with the [Wikipedia article](https://en.wikipedia.org/wiki/HSL_and_HSV).
  17
  18 ## Configuration
  19
  20 Before RGB Lighting can be used you have to enable it in `rules.mk`:
  21
  22     RGBLIGHT_ENABLE = yes
  23
  24 You can configure the behavior of the RGB lighting by defining values inside `config.h`.
  25
  26 ### Required Configuration
  27
  28 At minimum you have to define the pin your LED strip is connected to and the number of LEDs connected.
  29
  30 ```c
  31 #define RGB_DI_PIN D7     // The pin the LED strip is connected to
  32 #define RGBLED_NUM 14     // Number of LEDs in your strip
  33 ```
  34
  35 ### Optional Configuration
  36
  37 You can change the behavior of the RGB Lighting by setting these configuration values. Use `#define <Option> <Value>` in a `config.h` at the keyboard, revision, or keymap level.
  38
  39 | Option | Default Value | Description |
  40 |--------|---------------|-------------|
  41 | `RGBLIGHT_HUE_STEP` | 10 | How many hues you want to have available. |
  42 | `RGBLIGHT_SAT_STEP` | 17 | How many steps of saturation you'd like. |
  43 | `RGBLIGHT_VAL_STEP` | 17 | The number of levels of brightness you want. |
  44 | `RGBLIGHT_LIMIT_VAL` | 255 | Limit the val of HSV to limit the maximum brightness simply. |
  45
  46 ### Animations
  47
  48 If you have `#define RGBLIGHT_ANIMATIONS` in your `config.h` you will have a number of animation modes you can cycle through using the `RGB_MOD` key. You can also `#define` other options to tweak certain animations.
  49
  50 | Option | Default Value | Description |
  51 |--------|---------------|-------------|
  52 | `RGBLIGHT_ANIMATIONS` | | `#define` this to enable animation modes. |
  53 | `RGBLIGHT_EFFECT_BREATHE_CENTER` | 1.85 | Used to calculate the curve for the breathing animation. Valid values 1.0-2.7. |
  54 | `RGBLIGHT_EFFECT_BREATHE_MAX` | 255 | The maximum brightness for the breathing mode. Valid values 1-255. |
  55 | `RGBLIGHT_EFFECT_SNAKE_LENGTH` | 4 | The number of LEDs to light up for the "snake" animation. |
  56 | `RGBLIGHT_EFFECT_KNIGHT_LENGTH` | 3 | The number of LEDs to light up for the "knight" animation. |
  57 | `RGBLIGHT_EFFECT_KNIGHT_OFFSET` | 0 | Start the knight animation this many LEDs from the start of the strip. |
  58 | `RGBLIGHT_EFFECT_KNIGHT_LED_NUM` | RGBLED_NUM | The number of LEDs to have the "knight" animation travel. |
  59 | `RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL` | 1000 | How long to wait between light changes for the "christmas" animation. Specified in ms. |
  60 | `RGBLIGHT_EFFECT_CHRISTMAS_STEP` | 2 | How many LED's to group the red/green colors by for the christmas mode. |
  61
  62 You can also tweak the behavior of the animations by defining these consts in your `keymap.c`. These mostly affect the speed different modes animate at.
  63
  64 ```c
  65 // How long (in ms) to wait between animation steps for the breathing mode
  66 const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};
  67
  68 // How long (in ms) to wait between animation steps for the rainbow mode
  69 const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};
  70
  71 // How long (in ms) to wait between animation steps for the swirl mode
  72 const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};
  73
  74 // How long (in ms) to wait between animation steps for the snake mode
  75 const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
  76
  77 // How long (in ms) to wait between animation steps for the knight modes
  78 const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};
  79
  80 // These control which colors are selected for the gradient mode
  81 const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90};
  82 ```
  83
  84 ### LED Control
  85
  86 Look in `rgblights.h` for all available functions, but if you want to control all or some LEDs your goto functions are:
  87
  88 ```c
  89 rgblight_disable();  // turn all lights off
  90 rgblight_enable();  // turn lights on, based on their previous state (stored in EEPROM)
  91
  92 rgblight_setrgb(r, g, b);  // where r/g/b is a number from 0..255.  Turns all the LEDs to this color
  93 rgblight_sethsv(h, s, v);  // HSV color control
  94 rgblight_setrgb_at(r,g,b, LED);  // control a single LED.  0 <= LED < RGBLED_NUM
  95 rgblight_sethsv_at(h,s,v, LED);  // control a single LED.  0 <= LED < RGBLED_NUM
  96 ```
  97
  98 ## RGB Lighting Keycodes
  99
 100 These control the RGB Lighting functionality.
 101
 102 |Key                |Aliases   |Description                                                         |
 103 |-------------------|----------|--------------------------------------------------------------------|
 104 |`RGB_TOG`          |          |Toggle RGB lighting on or off                                       |
 105 |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held           |
 106 |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
 107 |`RGB_HUI`          |          |Increase hue                                                        |
 108 |`RGB_HUD`          |          |Decrease hue                                                        |
 109 |`RGB_SAI`          |          |Increase saturation                                                 |
 110 |`RGB_SAD`          |          |Decrease saturation                                                 |
 111 |`RGB_VAI`          |          |Increase value (brightness)                                         |
 112 |`RGB_VAD`          |          |Decrease value (brightness)                                         |
 113 |`RGB_MODE_PLAIN`   |`RGB_M_P `|Static (no animation) mode                                          |
 114 |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode                                            |
 115 |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode                                              |
 116 |`RGB_MODE_SWIRL`   |`RGB_M_SW`|Swirl animation mode                                                |
 117 |`RGB_MODE_SNAKE`   |`RGB_M_SN`|Snake animation mode                                                |
 118 |`RGB_MODE_KNIGHT`  |`RGB_M_K` |"Knight Rider" animation mode                                       |
 119 |`RGB_MODE_XMAS`    |`RGB_M_X` |Christmas animation mode                                            |
 120 |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode                                      |
 121
 122 note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`.
 123
 124 ## Hardware Modification
 125
 126 ![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
 127
 128 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
 129
 130 For this mod, you need an unused pin wiring to DI of WS2812 strip. After wiring the VCC, GND, and DI, you can enable the underglow in your Makefile.
 131
 132     RGBLIGHT_ENABLE = yes
 133
 134 In order to use the underglow animation functions, you need to have `#define RGBLIGHT_ANIMATIONS` in your `config.h`.
 135
 136 Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the `F4` pin by default:
 137
 138     #define RGB_DI_PIN F4     // The pin your RGB strip is wired to
 139     #define RGBLED_NUM 14     // Number of LEDs
 140
 141 You'll need to edit `RGB_DI_PIN` to the pin you have your `DI` on your RGB strip wired to.