3 ## Driver configuration
7 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
9 RGB_MATRIX_ENABLE = IS31FL3731
11 Configure the hardware via your `config.h`:
13 // This is a 7-bit address, that gets left-shifted and bit 0
14 // set to 0 for write, 1 for read (as per I2C protocol)
15 // The address will vary depending on your wiring:
16 // 0b1110100 AD <-> GND
17 // 0b1110111 AD <-> VCC
18 // 0b1110101 AD <-> SCL
19 // 0b1110110 AD <-> SDA
20 #define DRIVER_ADDR_1 0b1110100
21 #define DRIVER_ADDR_2 0b1110110
23 #define DRIVER_COUNT 2
24 #define DRIVER_1_LED_TOTAL 25
25 #define DRIVER_2_LED_TOTAL 24
26 #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL
28 Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
30 Define these arrays listing all the LEDs in your `<keyboard>.c`:
32 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
33 /* Refer to IS31 manual for these locations
39 {0, C1_3, C2_3, C3_3},
43 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).
47 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
49 RGB_MATRIX_ENABLE = IS31FL3733
51 Configure the hardware via your `config.h`:
53 // This is a 7-bit address, that gets left-shifted and bit 0
54 // set to 0 for write, 1 for read (as per I2C protocol)
55 // The address will vary depending on your wiring:
60 // ADDR1 represents A1:A0 of the 7-bit address.
61 // ADDR2 represents A3:A2 of the 7-bit address.
62 // The result is: 0b101(ADDR2)(ADDR1)
63 #define DRIVER_ADDR_1 0b1010000
64 #define DRIVER_ADDR_2 0b1010000 // this is here for compliancy reasons.
66 #define DRIVER_COUNT 1
67 #define DRIVER_1_LED_TOTAL 64
68 #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
70 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`
72 Define these arrays listing all the LEDs in your `<keyboard>.c`:
74 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
75 /* Refer to IS31 manual for these locations
85 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).
87 From this point forward the configuration is the same for all the drivers.
89 const rgb_led g_rgb_leds[DRIVER_LED_TOTAL] = {
91 * | {x=0..224, y=0..64}
94 {{0|(0<<4)}, {20.36*0, 21.33*0}, 1},
95 {{0|(1<<4)}, {20.36*1, 21.33*0}, 1},
99 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:
101 x = 224 / ( NUMBER_OF_ROWS - 1 ) * ROW_POSITION
102 y = 64 / (NUMBER_OF_COLS - 1 ) * COL_POSITION
104 Where all variables are decimels/floats.
106 `modifier` is a boolean, whether or not a certain key is considered a modifier (used in some effects).
110 All RGB keycodes are currently shared with the RGBLIGHT system:
113 * `RGB_MOD` - cycle through modes
114 * `RGB_HUI` - increase hue
115 * `RGB_HUD` - decrease hue
116 * `RGB_SAI` - increase saturation
117 * `RGB_SAD` - decrease saturation
118 * `RGB_VAI` - increase value
119 * `RGB_VAD` - decrease value
120 * `RGB_SPI` - increase speed effect (no EEPROM support)
121 * `RGB_SPD` - decrease speed effect (no EEPROM support)
124 * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system
126 ## RGB Matrix Effects
128 These are the effects that are currently available:
130 enum rgb_matrix_effects {
131 RGB_MATRIX_SOLID_COLOR = 1,
132 RGB_MATRIX_ALPHAS_MODS,
133 RGB_MATRIX_DUAL_BEACON,
134 RGB_MATRIX_GRADIENT_UP_DOWN,
135 RGB_MATRIX_RAINDROPS,
136 RGB_MATRIX_CYCLE_ALL,
137 RGB_MATRIX_CYCLE_LEFT_RIGHT,
138 RGB_MATRIX_CYCLE_UP_DOWN,
139 RGB_MATRIX_RAINBOW_BEACON,
140 RGB_MATRIX_RAINBOW_PINWHEELS,
141 RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
142 RGB_MATRIX_JELLYBEAN_RAINDROPS,
143 RGB_MATRIX_DIGITAL_RAIN,
144 #ifdef RGB_MATRIX_KEYPRESSES
145 RGB_MATRIX_SOLID_REACTIVE,
147 RGB_MATRIX_MULTISPLASH,
148 RGB_MATRIX_SOLID_SPLASH,
149 RGB_MATRIX_SOLID_MULTISPLASH,
151 RGB_MATRIX_EFFECT_MAX
154 ## Custom layer effects
156 Custom layer effects can be done by defining this in your `<keyboard>.c`:
158 void rgb_matrix_indicators_kb(void) {
159 rgb_matrix_set_color(index, red, green, blue);
162 A similar function works in the keymap as `rgb_matrix_indicators_user`.
164 ## Additional `config.h` Options
166 #define RGB_MATRIX_KEYPRESSES // reacts to keypresses (will slow down matrix scan by a lot)
167 #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (not recommened)
168 #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
169 #define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
170 #define RGB_MATRIX_SKIP_FRAMES 1 // number of frames to skip when displaying animations (0 is full effect) if not defined defaults to 1
171 #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
175 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:
177 #define EECONFIG_RGB_MATRIX (uint32_t *)16
179 Where `16` is an unused index from `eeconfig.h`.
183 To use the suspend feature, add this to your `<keyboard>.c`:
185 void suspend_power_down_kb(void)
187 rgb_matrix_set_suspend_state(true);
190 void suspend_wakeup_init_kb(void)
192 rgb_matrix_set_suspend_state(false);