3 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
5 RGB_MATRIX_ENABLE = yes
7 Configure the hardware via your `config.h`:
9 // This is a 7-bit address, that gets left-shifted and bit 0
10 // set to 0 for write, 1 for read (as per I2C protocol)
11 // The address will vary depending on your wiring:
12 // 0b1110100 AD <-> GND
13 // 0b1110111 AD <-> VCC
14 // 0b1110101 AD <-> SCL
15 // 0b1110110 AD <-> SDA
16 #define DRIVER_ADDR_1 0b1110100
17 #define DRIVER_ADDR_2 0b1110110
19 #define DRIVER_COUNT 2
20 #define DRIVER_1_LED_TOTAL 25
21 #define DRIVER_2_LED_TOTAL 24
22 #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL
24 Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
26 Define these arrays listing all the LEDs in your `<keyboard>.c`:
28 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
29 /* Refer to IS31 manual for these locations
35 {0, C1_3, C2_3, C3_3},
39 Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](http://www.issi.com/WW/pdf/31FL3731.pdf). The `driver` is the index of the driver you defined in your `config.h` (`0` or `1` right now).
41 const rgb_led g_rgb_leds[DRIVER_LED_TOTAL] = {
43 * | {x=0..224, y=0..64}
46 {{0|(0<<4)}, {20.36*0, 21.33*0}, 1},
47 {{0|(1<<4)}, {20.36*1, 21.33*0}, 1},
51 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:
53 x = 224 / ( NUMBER_OF_ROWS - 1 ) * ROW_POSITION
54 y = 64 / (NUMBER_OF_COLS - 1 ) * COL_POSITION
56 Where all variables are decimels/floats.
58 `modifier` is a boolean, whether or not a certain key is considered a modifier (used in some effects).
62 All RGB keycodes are currently shared with the RGBLIGHT system:
65 * `RGB_MOD` - cycle through modes
66 * `RGB_HUI` - increase hue
67 * `RGB_HUD` - decrease hue
68 * `RGB_SAI` - increase saturation
69 * `RGB_SAD` - decrease saturation
70 * `RGB_VAI` - increase value
71 * `RGB_VAD` - decrease value
72 * `RGB_SPI` - increase speed effect (no EEPROM support)
73 * `RGB_SPD` - decrease speed effect (no EEPROM support)
76 * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system
80 These are the effects that are currently available:
82 enum rgb_matrix_effects {
83 RGB_MATRIX_SOLID_COLOR = 1,
84 RGB_MATRIX_ALPHAS_MODS,
85 RGB_MATRIX_DUAL_BEACON,
86 RGB_MATRIX_GRADIENT_UP_DOWN,
89 RGB_MATRIX_CYCLE_LEFT_RIGHT,
90 RGB_MATRIX_CYCLE_UP_DOWN,
91 RGB_MATRIX_RAINBOW_BEACON,
92 RGB_MATRIX_RAINBOW_PINWHEELS,
93 RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
94 RGB_MATRIX_JELLYBEAN_RAINDROPS,
95 #ifdef RGB_MATRIX_KEYPRESSES
96 RGB_MATRIX_SOLID_REACTIVE,
98 RGB_MATRIX_MULTISPLASH,
99 RGB_MATRIX_SOLID_SPLASH,
100 RGB_MATRIX_SOLID_MULTISPLASH,
102 RGB_MATRIX_EFFECT_MAX
105 ## Custom layer effects
107 Custom layer effects can be done by defining this in your `<keyboard>.c`:
109 void rgb_matrix_indicators_kb(void) {
110 // rgb_matrix_set_color(index, red, green, blue);
113 A similar function works in the keymap as `rgb_matrix_indicators_user`.
115 ## Additional `config.h` Options
117 #define RGB_MATRIX_KEYPRESSES // reacts to keypresses (will slow down matrix scan by a lot)
118 #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (not recommened)
119 #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
120 #define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
121 #define RGB_MATRIX_SKIP_FRAMES 1 // number of frames to skip when displaying animations (0 is full effect) if not defined defaults to 1
122 #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
126 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:
128 #define EECONFIG_RGB_MATRIX (uint32_t *)16
130 Where `16` is an unused index from `eeconfig.h`.
134 To use the suspend feature, add this to your `<keyboard>.c`:
136 void suspend_power_down_kb(void)
138 rgb_matrix_set_suspend_state(true);
141 void suspend_wakeup_init_kb(void)
143 rgb_matrix_set_suspend_state(false);