qmk

QMK Firmware
git clone git://git.z3bra.org/qmk.git
Log | Files | Refs | Submodules | LICENSE

feature_rgb_matrix.md (20559B)


      1 # RGB Matrix Lighting
      2 
      3 This feature allows you to use RGB LED matrices driven by external drivers. It hooks into the RGBLIGHT system so you can use the same keycodes as RGBLIGHT to control it.
      4 
      5 If you want to use single color LED's you should use the [LED Matrix Subsystem](feature_led_matrix.md) instead.
      6 
      7 ## Driver configuration
      8 ---
      9 ### IS31FL3731
     10 
     11 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
     12 
     13 ```C
     14 RGB_MATRIX_ENABLE = IS31FL3731
     15 ```
     16 
     17 Configure the hardware via your `config.h`:
     18 
     19 ```C
     20 // This is a 7-bit address, that gets left-shifted and bit 0
     21 // set to 0 for write, 1 for read (as per I2C protocol)
     22 // The address will vary depending on your wiring:
     23 // 0b1110100 AD <-> GND
     24 // 0b1110111 AD <-> VCC
     25 // 0b1110101 AD <-> SCL
     26 // 0b1110110 AD <-> SDA
     27 #define DRIVER_ADDR_1 0b1110100
     28 #define DRIVER_ADDR_2 0b1110110
     29 
     30 #define DRIVER_COUNT 2
     31 #define DRIVER_1_LED_TOTAL 25
     32 #define DRIVER_2_LED_TOTAL 24
     33 #define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
     34 ```
     35 
     36 !> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`.
     37 
     38 Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
     39 
     40 Define these arrays listing all the LEDs in your `<keyboard>.c`:
     41 
     42 ```C
     43 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
     44 /* Refer to IS31 manual for these locations
     45  *   driver
     46  *   |  R location
     47  *   |  |      G location
     48  *   |  |      |      B location
     49  *   |  |      |      | */
     50     {0, C1_3,  C2_3,  C3_3},
     51     ....
     52 }
     53 ```
     54 
     55 Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](http://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/issi/is31fl3731.h`. The `driver` is the index of the driver you defined in your `config.h` (`0` or `1` right now).
     56 
     57 ---
     58 ###  IS31FL3733/IS31FL3737
     59 
     60 !> For the IS31FL3737, replace all instances of `IS31FL3733` below with `IS31FL3737`.
     61 
     62 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
     63 
     64 ```C
     65 RGB_MATRIX_ENABLE = IS31FL3733
     66 ```
     67 
     68 Configure the hardware via your `config.h`:
     69 
     70 ```C
     71 // This is a 7-bit address, that gets left-shifted and bit 0
     72 // set to 0 for write, 1 for read (as per I2C protocol)
     73 // The address will vary depending on your wiring:
     74 // 00 <-> GND
     75 // 01 <-> SCL
     76 // 10 <-> SDA
     77 // 11 <-> VCC
     78 // ADDR1 represents A1:A0 of the 7-bit address.
     79 // ADDR2 represents A3:A2 of the 7-bit address.
     80 // The result is: 0b101(ADDR2)(ADDR1)
     81 #define DRIVER_ADDR_1 0b1010000
     82 #define DRIVER_ADDR_2 0b1010000 // this is here for compliancy reasons.
     83 
     84 #define DRIVER_COUNT 2
     85 #define DRIVER_1_LED_TOTAL 64
     86 #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
     87 ```
     88 
     89 Currently only a single drivers is supported, but it would be trivial to support all 4 combinations. For now define `DRIVER_ADDR_2` as `DRIVER_ADDR_1`
     90 
     91 Define these arrays listing all the LEDs in your `<keyboard>.c`:
     92 
     93 ```C
     94 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
     95 /* Refer to IS31 manual for these locations
     96  *   driver
     97  *   |  R location
     98  *   |  |       G location
     99  *   |  |       |       B location
    100  *   |  |       |       | */
    101     {0, B_1,    A_1,    C_1},
    102     ....
    103 }
    104 ```
    105 
    106 Where `X_Y` is the location of the LED in the matrix defined by [the datasheet](http://www.issi.com/WW/pdf/31FL3733.pdf) and the header file `drivers/issi/is31fl3733.h`. The `driver` is the index of the driver you defined in your `config.h` (Only `0` right now).
    107 
    108 ---
    109 
    110 ### WS2812 (AVR only)
    111 
    112 There is basic support for addressable RGB matrix lighting with a WS2811/WS2812{a,b,c} addressable LED strand. To enable it, add this to your `rules.mk`:
    113 
    114 ```C
    115 RGB_MATRIX_ENABLE = WS2812
    116 ```
    117 
    118 Configure the hardware via your `config.h`:
    119 
    120 ```C
    121 // The pin connected to the data pin of the LEDs
    122 #define RGB_DI_PIN D7
    123 // The number of LEDs connected
    124 #define DRIVER_LED_TOTAL 70
    125 ```
    126 
    127 ---
    128 
    129 From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:
    130 
    131 ```C
    132 const led_config_t g_led_config = { {
    133   // Key Matrix to LED Index
    134   {   5, NO_LED, NO_LED,   0 },
    135   { NO_LED, NO_LED, NO_LED, NO_LED },
    136   {   4, NO_LED, NO_LED,   1 },
    137   {   3, NO_LED, NO_LED,   2 }
    138 }, {
    139   // LED Index to Physical Position
    140   { 188,  16 }, { 187,  48 }, { 149,  64 }, { 112,  64 }, {  37,  48 }, {  38,  16 }
    141 }, {
    142   // LED Index to Flag
    143   1, 4, 4, 4, 4, 1
    144 } };
    145 ```
    146 
    147 The first part, `// Key Matrix to LED Index`, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, `// LED Index to Physical Position` represents the LED's physical `{ x, y }` position on the keyboard. The default expected range of values for `{ x, y }` is the inclusive range `{ 0..224, 0..64 }`. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents `{ x, y }` coordinate `{ 0, 0 }` and the bottom right of your keyboard represents `{ 224, 64 }`. Using this as a basis, you can use the following formula to calculate the physical position:
    148 
    149 ```C
    150 x = 224 / (NUMBER_OF_COLS - 1) * COL_POSITION
    151 y =  64 / (NUMBER_OF_ROWS - 1) * ROW_POSITION
    152 ```
    153 
    154 Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout. 
    155 
    156 As mentioned earlier, the center of the keyboard by default is expected to be `{ 112, 32 }`, but this can be changed if you want to more accurately calculate the LED's physical `{ x, y }` positions. Keyboard designers can implement `#define RGB_MATRIX_CENTER { 112, 32 }` in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the `{ x, y }` values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.
    157 
    158 `// LED Index to Flag` is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.
    159 
    160 ## Flags
    161 
    162 |Define                              |Description                                |
    163 |------------------------------------|-------------------------------------------|
    164 |`#define HAS_FLAGS(bits, flags)`    |Returns true if `bits` has all `flags` set.|
    165 |`#define HAS_ANY_FLAGS(bits, flags)`|Returns true if `bits` has any `flags` set.|
    166 |`#define LED_FLAG_NONE      0x00`   |If this LED has no flags.                  |
    167 |`#define LED_FLAG_ALL       0xFF`   |If this LED has all flags.                 |
    168 |`#define LED_FLAG_MODIFIER  0x01`   |If the Key for this LED is a modifier.     |
    169 |`#define LED_FLAG_UNDERGLOW 0x02`   |If the LED is for underglow.               |
    170 |`#define LED_FLAG_KEYLIGHT  0x04`   |If the LED is for key backlight.           |
    171 
    172 ## Keycodes
    173 
    174 All RGB keycodes are currently shared with the RGBLIGHT system:
    175 
    176 * `RGB_TOG` - toggle
    177 * `RGB_MOD` - cycle through modes
    178 * `RGB_HUI` - increase hue
    179 * `RGB_HUD` - decrease hue
    180 * `RGB_SAI` - increase saturation
    181 * `RGB_SAD` - decrease saturation
    182 * `RGB_VAI` - increase value
    183 * `RGB_VAD` - decrease value
    184 * `RGB_SPI` - increase speed effect (no EEPROM support)
    185 * `RGB_SPD` - decrease speed effect (no EEPROM support)
    186 * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system
    187 
    188 ## RGB Matrix Effects
    189 
    190 All effects have been configured to support current configuration values (Hue, Saturation, Value, & Speed) unless otherwise noted below. These are the effects that are currently available:
    191 
    192 ```C
    193 enum rgb_matrix_effects {
    194     RGB_MATRIX_NONE = 0,
    195     RGB_MATRIX_SOLID_COLOR = 1,     // Static single hue, no speed support
    196     RGB_MATRIX_ALPHAS_MODS,         // Static dual hue, speed is hue for secondary hue
    197     RGB_MATRIX_GRADIENT_UP_DOWN,    // Static gradient top to bottom, speed controls how much gradient changes
    198     RGB_MATRIX_BREATHING,           // Single hue brightness cycling animation
    199     RGB_MATRIX_BAND_SAT,        // Single hue band fading saturation scrolling left to right
    200     RGB_MATRIX_BAND_VAL,        // Single hue band fading brightness scrolling left to right
    201     RGB_MATRIX_BAND_PINWHEEL_SAT,   // Single hue 3 blade spinning pinwheel fades saturation
    202     RGB_MATRIX_BAND_PINWHEEL_VAL,   // Single hue 3 blade spinning pinwheel fades brightness
    203     RGB_MATRIX_BAND_SPIRAL_SAT,     // Single hue spinning spiral fades saturation
    204     RGB_MATRIX_BAND_SPIRAL_VAL,     // Single hue spinning spiral fades brightness
    205     RGB_MATRIX_CYCLE_ALL,           // Full keyboard solid hue cycling through full gradient
    206     RGB_MATRIX_CYCLE_LEFT_RIGHT,    // Full gradient scrolling left to right
    207     RGB_MATRIX_CYCLE_UP_DOWN,       // Full gradient scrolling top to bottom
    208     RGB_MATRIX_CYCLE_OUT_IN,        // Full gradient scrolling out to in
    209     RGB_MATRIX_CYCLE_OUT_IN_DUAL,   // Full dual gradients scrolling out to in
    210     RGB_MATRIX_RAINBOW_MOVING_CHEVRON,  // Full gradent Chevron shapped scrolling left to right
    211     RGB_MATRIX_CYCLE_PINWHEEL,      // Full gradient spinning pinwheel around center of keyboard
    212     RGB_MATRIX_CYCLE_SPIRAL,        // Full gradient spinning spiral around center of keyboard
    213     RGB_MATRIX_DUAL_BEACON,         // Full gradient spinning around center of keyboard
    214     RGB_MATRIX_RAINBOW_BEACON,      // Full tighter gradient spinning around center of keyboard
    215     RGB_MATRIX_RAINBOW_PINWHEELS,   // Full dual gradients spinning two halfs of keyboard
    216     RGB_MATRIX_RAINDROPS,           // Randomly changes a single key's hue
    217     RGB_MATRIX_JELLYBEAN_RAINDROPS, // Randomly changes a single key's hue and saturation
    218 #if define(RGB_MATRIX_FRAMEBUFFER_EFFECTS)
    219     RGB_MATRIX_TYPING_HEATMAP,      // How hot is your WPM!
    220     RGB_MATRIX_DIGITAL_RAIN,        // That famous computer simulation
    221 #endif
    222 #if defined(RGB_MATRIX_KEYPRESSES) || defined(RGB_MATRIX_KEYRELEASES)
    223     RGB_MATRIX_SOLID_REACTIVE_SIMPLE,   // Pulses keys hit to hue & value then fades value out
    224     RGB_MATRIX_SOLID_REACTIVE,      // Static single hue, pulses keys hit to shifted hue then fades to current hue
    225     RGB_MATRIX_SOLID_REACTIVE_WIDE       // Hue & value pulse near a single key hit then fades value out
    226     RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE  // Hue & value pulse near multiple key hits then fades value out
    227     RGB_MATRIX_SOLID_REACTIVE_CROSS      // Hue & value pulse the same column and row of a single key hit then fades value out
    228     RGB_MATRIX_SOLID_REACTIVE_MULTICROSS // Hue & value pulse the same column and row of multiple key hits then fades value out
    229     RGB_MATRIX_SOLID_REACTIVE_NEXUS      // Hue & value pulse away on the same column and row of a single key hit then fades value out
    230     RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS // Hue & value pulse away on the same column and row of multiple key hits then fades value out
    231     RGB_MATRIX_SPLASH,              // Full gradient & value pulse away from a single key hit then fades value out
    232     RGB_MATRIX_MULTISPLASH,         // Full gradient & value pulse away from multiple key hits then fades value out
    233     RGB_MATRIX_SOLID_SPLASH,        // Hue & value pulse away from a single key hit then fades value out
    234     RGB_MATRIX_SOLID_MULTISPLASH,   // Hue & value pulse away from multiple key hits then fades value out
    235 #endif
    236     RGB_MATRIX_EFFECT_MAX
    237 };
    238 ```
    239 
    240 You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`:
    241 
    242 
    243 |Define                                                 |Description                                    |
    244 |-------------------------------------------------------|-----------------------------------------------|
    245 |`#define DISABLE_RGB_MATRIX_ALPHAS_MODS`               |Disables `RGB_MATRIX_ALPHAS_MODS`              |
    246 |`#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN`          |Disables `RGB_MATRIX_GRADIENT_UP_DOWN`         |
    247 |`#define DISABLE_RGB_MATRIX_BREATHING`                 |Disables `RGB_MATRIX_BREATHING`                |
    248 |`#define DISABLE_RGB_MATRIX_BAND_SAT`                  |Disables `RGB_MATRIX_BAND_SAT`                 |
    249 |`#define DISABLE_RGB_MATRIX_BAND_VAL`                  |Disables `RGB_MATRIX_BAND_VAL`                 |
    250 |`#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT`         |Disables `RGB_MATRIX_BAND_PINWHEEL_SAT`        |
    251 |`#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL`         |Disables `RGB_MATRIX_BAND_PINWHEEL_VAL`        |
    252 |`#define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT`           |Disables `RGB_MATRIX_BAND_SPIRAL_SAT`          |
    253 |`#define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL`           |Disables `RGB_MATRIX_BAND_SPIRAL_VAL`          |
    254 |`#define DISABLE_RGB_MATRIX_CYCLE_ALL`                 |Disables `RGB_MATRIX_CYCLE_ALL`                |
    255 |`#define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT`          |Disables `RGB_MATRIX_CYCLE_LEFT_RIGHT`         |
    256 |`#define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN`             |Disables `RGB_MATRIX_CYCLE_UP_DOWN`            |
    257 |`#define DISABLE_RGB_MATRIX_CYCLE_OUT_IN`              |Disables `RGB_MATRIX_CYCLE_OUT_IN`             |
    258 |`#define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL`         |Disables `RGB_MATRIX_CYCLE_OUT_IN_DUAL`        |
    259 |`#define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`    |Disables `RGB_MATRIX_RAINBOW_MOVING_CHEVRON`   |
    260 |`#define DISABLE_RGB_MATRIX_DUAL_BEACON`               |Disables `RGB_MATRIX_DUAL_BEACON`              |
    261 |`#define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL`            |Disables `RGB_MATRIX_CYCLE_PINWHEEL`           |
    262 |`#define DISABLE_RGB_MATRIX_CYCLE_SPIRAL`              |Disables `RGB_MATRIX_CYCLE_SPIRAL`             |
    263 |`#define DISABLE_RGB_MATRIX_RAINBOW_BEACON`            |Disables `RGB_MATRIX_RAINBOW_BEACON`           |
    264 |`#define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS`         |Disables `RGB_MATRIX_RAINBOW_PINWHEELS`        |
    265 |`#define DISABLE_RGB_MATRIX_RAINDROPS`                 |Disables `RGB_MATRIX_RAINDROPS`                |
    266 |`#define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS`       |Disables `RGB_MATRIX_JELLYBEAN_RAINDROPS`      |
    267 |`#define DISABLE_RGB_MATRIX_TYPING_HEATMAP`            |Disables `RGB_MATRIX_TYPING_HEATMAP`           |
    268 |`#define DISABLE_RGB_MATRIX_DIGITAL_RAIN`              |Disables `RGB_MATRIX_DIGITAL_RAIN`             |
    269 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE`            |Disables `RGB_MATRIX_SOLID_REACTIVE`           |
    270 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE`     |Disables `RGB_MATRIX_SOLID_REACTIVE_SIMPLE`    |
    271 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE`       |Disables `RGB_MATRIX_SOLID_REACTIVE_WIDE`      |
    272 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE`  |Disables `RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE` |
    273 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS`      |Disables `RGB_MATRIX_SOLID_REACTIVE_CROSS`     |
    274 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS` |Disables `RGB_MATRIX_SOLID_REACTIVE_MULTICROSS`|
    275 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS`      |Disables `RGB_MATRIX_SOLID_REACTIVE_NEXUS`     |
    276 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Disables `RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS`|
    277 |`#define DISABLE_RGB_MATRIX_SPLASH`                    |Disables `RGB_MATRIX_SPLASH`                   |
    278 |`#define DISABLE_RGB_MATRIX_MULTISPLASH`               |Disables `RGB_MATRIX_MULTISPLASH`              |
    279 |`#define DISABLE_RGB_MATRIX_SOLID_SPLASH`              |Disables `RGB_MATRIX_SOLID_SPLASH`             |
    280 |`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH`         |Disables `RGB_MATRIX_SOLID_MULTISPLASH`        |
    281 
    282 
    283 ## Custom RGB Matrix Effects
    284 
    285 By setting `RGB_MATRIX_CUSTOM_USER` (and/or `RGB_MATRIX_CUSTOM_KB`) in `rule.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files.
    286 
    287 To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks something like this:
    288 
    289 `rgb_matrix_user.inc` should go in the root of the keymap directory.
    290 `rgb_matrix_kb.inc` should go in the root of the keyboard directory.
    291 
    292 ```C
    293 // !!! DO NOT ADD #pragma once !!! //
    294 
    295 // Step 1.
    296 // Declare custom effects using the RGB_MATRIX_EFFECT macro
    297 // (note the lack of semicolon after the macro!)
    298 RGB_MATRIX_EFFECT(my_cool_effect)
    299 RGB_MATRIX_EFFECT(my_cool_effect2)
    300 
    301 // Step 2.
    302 // Define effects inside the `RGB_MATRIX_CUSTOM_EFFECT_IMPLS` ifdef block
    303 #ifdef RGB_MATRIX_CUSTOM_EFFECT_IMPLS
    304 
    305 // e.g: A simple effect, self-contained within a single method
    306 static bool my_cool_effect(effect_params_t* params) {
    307   RGB_MATRIX_USE_LIMITS(led_min, led_max);
    308   for (uint8_t i = led_min; i < led_max; i++) {
    309     rgb_matrix_set_color(i, 0xff, 0xff, 0x00);
    310   }
    311   return led_max < DRIVER_LED_TOTAL;
    312 }
    313 
    314 // e.g: A more complex effect, relying on external methods and state, with
    315 // dedicated init and run methods
    316 static uint8_t some_global_state;
    317 static void my_cool_effect2_complex_init(effect_params_t* params) {
    318   some_global_state = 1;
    319 }
    320 static bool my_cool_effect2_complex_run(effect_params_t* params) {
    321   RGB_MATRIX_USE_LIMITS(led_min, led_max);
    322   for (uint8_t i = led_min; i < led_max; i++) {
    323     rgb_matrix_set_color(i, 0xff, some_global_state++, 0xff);
    324   }
    325 
    326   return led_max < DRIVER_LED_TOTAL;
    327 }
    328 static bool my_cool_effect2(effect_params_t* params) {
    329   if (params->init) my_cool_effect2_complex_init(params);
    330   return my_cool_effect2_complex_run(params);
    331 }
    332 
    333 #endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS
    334 ```
    335 
    336 For inspiration and examples, check out the built-in effects under `quantum/rgb_matrix_animation/`
    337 
    338 
    339 ## Colors
    340 
    341 These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.
    342 
    343 |RGB                |HSV                |
    344 |-------------------|-------------------|
    345 |`RGB_WHITE`        |`HSV_WHITE`        |
    346 |`RGB_RED`          |`HSV_RED`          |
    347 |`RGB_CORAL`        |`HSV_CORAL`        |
    348 |`RGB_ORANGE`       |`HSV_ORANGE`       |
    349 |`RGB_GOLDENROD`    |`HSV_GOLDENROD`    |
    350 |`RGB_GOLD`         |`HSV_GOLD`         |
    351 |`RGB_YELLOW`       |`HSV_YELLOW`       |
    352 |`RGB_CHARTREUSE`   |`HSV_CHARTREUSE`   |
    353 |`RGB_GREEN`        |`HSV_GREEN`        |
    354 |`RGB_SPRINGGREEN`  |`HSV_SPRINGGREEN`  |
    355 |`RGB_TURQUOISE`    |`HSV_TURQUOISE`    |
    356 |`RGB_TEAL`         |`HSV_TEAL`         |
    357 |`RGB_CYAN`         |`HSV_CYAN`         |
    358 |`RGB_AZURE`        |`HSV_AZURE`        |
    359 |`RGB_BLUE`         |`HSV_BLUE`         |
    360 |`RGB_PURPLE`       |`HSV_PURPLE`       |
    361 |`RGB_MAGENTA`      |`HSV_MAGENTA`      |
    362 |`RGB_PINK`         |`HSV_PINK`         |
    363 
    364 These are defined in [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h). Feel free to add to this list!
    365 
    366 
    367 ## Additional `config.h` Options
    368 
    369 ```C
    370 #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
    371 #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
    372 #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
    373 #define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
    374 #define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
    375 #define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
    376 #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
    377 #define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_CYCLE_LEFT_RIGHT // Sets the default mode, if none has been set
    378 ```
    379 
    380 ## EEPROM storage
    381 
    382 The EEPROM for it is currently shared with the RGBLIGHT system (it's generally assumed only one RGB would be used at a time), but could be configured to use its own 32bit address with:
    383 
    384 ```C
    385 #define EECONFIG_RGB_MATRIX (uint32_t *)28
    386 ```
    387 
    388 Where `28` is an unused index from `eeconfig.h`.
    389 
    390 ## Suspended state
    391 
    392 To use the suspend feature, add this to your `<keyboard>.c`:
    393 
    394 ```C
    395 void suspend_power_down_kb(void)
    396 {
    397     rgb_matrix_set_suspend_state(true);
    398 }
    399 
    400 void suspend_wakeup_init_kb(void)
    401 {
    402     rgb_matrix_set_suspend_state(false);
    403 }
    404 ```