docs/feature_rgb_matrix.md

   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 Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
  37
  38 Define these arrays listing all the LEDs in your `<keyboard>.c`:
  39
  40 ```C
  41 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
  42 /* Refer to IS31 manual for these locations
  43     *   driver
  44     *   |  R location
  45     *   |  |      G location
  46     *   |  |      |      B location
  47     *   |  |      |      | */
  48     {0, C1_3,  C2_3,  C3_3},
  49     ....
  50 }
  51 ```
  52
  53 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).
  54
  55 ###  IS31FL3733/IS31FL3737
  56
  57 !> For the IS31FL3737, replace all instances of `IS31FL3733` below with `IS31FL3737`.
  58
  59 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
  60
  61 ```C
  62 RGB_MATRIX_ENABLE = IS31FL3733
  63 ```
  64
  65 Configure the hardware via your `config.h`:
  66
  67 ```C
  68 // This is a 7-bit address, that gets left-shifted and bit 0
  69 // set to 0 for write, 1 for read (as per I2C protocol)
  70 // The address will vary depending on your wiring:
  71 // 00 <-> GND
  72 // 01 <-> SCL
  73 // 10 <-> SDA
  74 // 11 <-> VCC
  75 // ADDR1 represents A1:A0 of the 7-bit address.
  76 // ADDR2 represents A3:A2 of the 7-bit address.
  77 // The result is: 0b101(ADDR2)(ADDR1)
  78 #define DRIVER_ADDR_1 0b1010000
  79 #define DRIVER_ADDR_2 0b1010000 // this is here for compliancy reasons.
  80
  81 #define DRIVER_COUNT 2
  82 #define DRIVER_1_LED_TOTAL 64
  83 #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
  84 ```
  85
  86 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`
  87
  88 Define these arrays listing all the LEDs in your `<keyboard>.c`:
  89
  90 ```C
  91 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
  92 /* Refer to IS31 manual for these locations
  93     *   driver
  94     *   |  R location
  95     *   |  |       G location
  96     *   |  |       |       B location
  97     *   |  |       |       | */
  98     {0, B_1,    A_1,    C_1},
  99     ....
 100 }
 101 ```
 102
 103 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).
 104
 105 From this point forward the configuration is the same for all the drivers.
 106
 107 ```C
 108 const rgb_led g_rgb_leds[DRIVER_LED_TOTAL] = {
 109 /*  {row | col << 4}
 110     *    |         {x=0..224, y=0..64}
 111     *    |            |              modifier
 112     *    |            |                | */
 113     {{0|(0<<4)},   {20.36*0, 21.33*0}, 1},
 114     {{0|(1<<4)},   {20.36*1, 21.33*0}, 1},
 115     ....
 116 }
 117 ```
 118
 119 The format for the matrix position used in this array is `{row | (col << 4)}`. The `x` is between (inclusive) 0-224, and `y` is between (inclusive) 0-64. The easiest way to calculate these positions is:
 120
 121 ```C
 122 x = 224 / ( NUMBER_OF_COLS - 1 ) * ROW_POSITION
 123 y = 64 / (NUMBER_OF_ROWS - 1 ) * COL_POSITION
 124 ```
 125
 126 Where all variables are decimels/floats.
 127
 128 `modifier` is a boolean, whether or not a certain key is considered a modifier (used in some effects).
 129
 130 ## Keycodes
 131
 132 All RGB keycodes are currently shared with the RGBLIGHT system:
 133
 134 * `RGB_TOG` - toggle
 135 * `RGB_MOD` - cycle through modes
 136 * `RGB_HUI` - increase hue
 137 * `RGB_HUD` - decrease hue
 138 * `RGB_SAI` - increase saturation
 139 * `RGB_SAD` - decrease saturation
 140 * `RGB_VAI` - increase value
 141 * `RGB_VAD` - decrease value
 142 * `RGB_SPI` - increase speed effect (no EEPROM support)
 143 * `RGB_SPD` - decrease speed effect (no EEPROM support)
 144 * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system
 145
 146 ## RGB Matrix Effects
 147
 148 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:
 149
 150 ```C
 151 enum rgb_matrix_effects {
 152     RGB_MATRIX_NONE = 0,
 153     RGB_MATRIX_SOLID_COLOR = 1,     // Static single hue, no speed support
 154     RGB_MATRIX_ALPHAS_MODS,         // Static dual hue, speed is hue for secondary hue
 155     RGB_MATRIX_GRADIENT_UP_DOWN,    // Static gradient top to bottom, speed controls how much gradient changes
 156     RGB_MATRIX_BREATHING,           // Single hue brightness cycling animation
 157     RGB_MATRIX_CYCLE_ALL,           // Full keyboard solid hue cycling through full gradient
 158     RGB_MATRIX_CYCLE_LEFT_RIGHT,    // Full gradient scrolling left to right
 159     RGB_MATRIX_CYCLE_UP_DOWN,       // Full gradient scrolling top to bottom
 160     RGB_MATRIX_RAINBOW_MOVING_CHEVRON,  // Full gradent Chevron shapped scrolling left to right
 161     RGB_MATRIX_DUAL_BEACON,         // Full gradient spinning around center of keyboard
 162     RGB_MATRIX_RAINBOW_BEACON,      // Full tighter gradient spinning around center of keyboard
 163     RGB_MATRIX_RAINBOW_PINWHEELS,   // Full dual gradients spinning two halfs of keyboard
 164     RGB_MATRIX_RAINDROPS,           // Randomly changes a single key's hue
 165     RGB_MATRIX_JELLYBEAN_RAINDROPS, // Randomly changes a single key's hue and saturation
 166     RGB_MATRIX_DIGITAL_RAIN,        // That famous computer simulation
 167 #if defined(RGB_MATRIX_KEYPRESSES) || defined(RGB_MATRIX_KEYRELEASES)
 168     RGB_MATRIX_SOLID_REACTIVE_SIMPLE,   // Pulses keys hit to hue & value then fades value out
 169     RGB_MATRIX_SOLID_REACTIVE,      // Static single hue, pulses keys hit to shifted hue then fades to current hue
 170     RGB_MATRIX_SPLASH,              // Full gradient & value pulse away from a single key hit then fades value out
 171     RGB_MATRIX_MULTISPLASH,         // Full gradient & value pulse away from multiple key hits then fades value out
 172     RGB_MATRIX_SOLID_SPLASH,        // Hue & value pulse away from a single key hit then fades value out
 173     RGB_MATRIX_SOLID_MULTISPLASH,   // Hue & value pulse away from multiple key hits then fades value out
 174 #endif
 175     RGB_MATRIX_EFFECT_MAX
 176 };
 177 ```
 178
 179 You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`:
 180
 181
 182 |Define                                             |Description                                 |
 183 |---------------------------------------------------|--------------------------------------------|
 184 |`#define DISABLE_RGB_MATRIX_ALPHAS_MODS`           |Disables `RGB_MATRIX_ALPHAS_MODS`           |
 185 |`#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN`      |Disables `RGB_MATRIX_GRADIENT_UP_DOWN`      |
 186 |`#define DISABLE_RGB_MATRIX_BREATHING`             |Disables `RGB_MATRIX_BREATHING`             |
 187 |`#define DISABLE_RGB_MATRIX_CYCLE_ALL`             |Disables `RGB_MATRIX_CYCLE_ALL`             |
 188 |`#define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT`      |Disables `RGB_MATRIX_CYCLE_LEFT_RIGHT`      |
 189 |`#define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN`         |Disables `RGB_MATRIX_CYCLE_UP_DOWN`         |
 190 |`#define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`|Disables `RGB_MATRIX_RAINBOW_MOVING_CHEVRON`|
 191 |`#define DISABLE_RGB_MATRIX_DUAL_BEACON`           |Disables `RGB_MATRIX_DUAL_BEACON`           |
 192 |`#define DISABLE_RGB_MATRIX_RAINBOW_BEACON`        |Disables `RGB_MATRIX_RAINBOW_BEACON`        |
 193 |`#define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS`     |Disables `RGB_MATRIX_RAINBOW_PINWHEELS`     |
 194 |`#define DISABLE_RGB_MATRIX_RAINDROPS`             |Disables `RGB_MATRIX_RAINDROPS`             |
 195 |`#define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS`   |Disables `RGB_MATRIX_JELLYBEAN_RAINDROPS`   |
 196 |`#define DISABLE_RGB_MATRIX_DIGITAL_RAIN`          |Disables `RGB_MATRIX_DIGITAL_RAIN`          |
 197 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE`        |Disables `RGB_MATRIX_SOLID_REACTIVE`        |
 198 |`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE` |Disables `RGB_MATRIX_SOLID_REACTIVE_SIMPLEE`|
 199 |`#define DISABLE_RGB_MATRIX_SPLASH`                |Disables `RGB_MATRIX_SPLASH`                |
 200 |`#define DISABLE_RGB_MATRIX_MULTISPLASH`           |Disables `RGB_MATRIX_MULTISPLASH`           |
 201 |`#define DISABLE_RGB_MATRIX_SOLID_SPLASH`          |Disables `RGB_MATRIX_SOLID_SPLASH`          |
 202 |`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH`     |Disables `RGB_MATRIX_SOLID_MULTISPLASH`     |
 203
 204
 205 ## Custom layer effects
 206
 207 Custom layer effects can be done by defining this in your `<keyboard>.c`:
 208
 209 ```C
 210 void rgb_matrix_indicators_kb(void) {
 211     rgb_matrix_set_color(index, red, green, blue);
 212 }
 213 ```
 214
 215 A similar function works in the keymap as `rgb_matrix_indicators_user`.
 216
 217 ## Additional `config.h` Options
 218
 219 ```C
 220 #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
 221 #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
 222 #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
 223 #define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
 224 #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)
 225 #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)
 226 #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
 227 ```
 228
 229 ## EEPROM storage
 230
 231 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:
 232
 233 ```C
 234 #define EECONFIG_RGB_MATRIX (uint32_t *)16
 235 ```
 236
 237 Where `16` is an unused index from `eeconfig.h`.
 238
 239 ## Suspended state
 240
 241 To use the suspend feature, add this to your `<keyboard>.c`:
 242
 243 ```C
 244 void suspend_power_down_kb(void)
 245 {
 246     rgb_matrix_set_suspend_state(true);
 247 }
 248
 249 void suspend_wakeup_init_kb(void)
 250 {
 251     rgb_matrix_set_suspend_state(false);
 252 }
 253 ```