aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgb_matrix.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_rgb_matrix.md')
-rw-r--r--docs/feature_rgb_matrix.md52
1 files changed, 50 insertions, 2 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index ed33c7ea4..4f827f8dc 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -1,8 +1,12 @@
1# RGB Matrix Lighting 1# RGB Matrix Lighting
2 2
3## Driver configuration
4
5### IS31FL3731
6
3There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`: 7There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
4 8
5 RGB_MATRIX_ENABLE = yes 9 RGB_MATRIX_ENABLE = IS31FL3731
6 10
7Configure the hardware via your `config.h`: 11Configure the hardware via your `config.h`:
8 12
@@ -36,7 +40,51 @@ Define these arrays listing all the LEDs in your `<keyboard>.c`:
36 .... 40 ....
37 } 41 }
38 42
39Where `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). 43Where `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).
44
45### IS31FL3733
46
47There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
48
49 RGB_MATRIX_ENABLE = IS31FL3733
50
51Configure the hardware via your `config.h`:
52
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:
56 // 00 <-> GND
57 // 01 <-> SCL
58 // 10 <-> SDA
59 // 11 <-> VCC
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.
65
66 #define DRIVER_COUNT 1
67 #define DRIVER_1_LED_TOTAL 64
68 #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
69
70Currently 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`
71
72Define these arrays listing all the LEDs in your `<keyboard>.c`:
73
74 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
75 /* Refer to IS31 manual for these locations
76 * driver
77 * | R location
78 * | | G location
79 * | | | B location
80 * | | | | */
81 {0, B_1, A_1, C_1},
82 ....
83 }
84
85Where `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).
86
87From this point forward the configuration is the same for all the drivers.
40 88
41 const rgb_led g_rgb_leds[DRIVER_LED_TOTAL] = { 89 const rgb_led g_rgb_leds[DRIVER_LED_TOTAL] = {
42 /* {row | col << 4} 90 /* {row | col << 4}