summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoryiancar <yiangosyiangou@cytanet.com.cy>2018-08-28 16:03:11 +0300
committerJack Humbert <jack.humb@gmail.com>2018-08-28 09:03:11 -0400
commitfdd0f915271f79b104aa5d216566bcc3fd134e85 (patch)
tree42656e9ebd132461b99d7b037563374e575053ae /docs
parent2410f023598af65a551b42f569a2703a5621bdca (diff)
downloadqmk_firmware-fdd0f915271f79b104aa5d216566bcc3fd134e85.tar.gz
qmk_firmware-fdd0f915271f79b104aa5d216566bcc3fd134e85.zip
ISSI31FL3733 driver (#3679)
* ISSI31FL3733 driver - Addapted IS31 driver for the above driver * fix my branch * ISSI31FL3733 driver - Inclusion of above ISSI led driver * IS31fl3733 driver - Added correct function for control registers * Finalized support for ISSI31fl3733 led driver - Finalized and tested driver. - Modified i2c_master for arm due to declaration mistake. - Fixed spaces/tabs in quantum.h file. - Fixed spaces/tabs in common_features.mk file. - Removed unnecessary includes from rgb_matrix.c file. - Added local definitions for MIN and MAX macros in rgb_matrix.c file. - Adjusted chevron effect. - Added necessary define (RGB_3733_MATRIX_ENABLE) for makefile. - Added necessary C define (ISSI3733) to aid with inclusion of the correct header file. - Added documentation for the new driver. * Driver structure update - Changed rule includes to be more condensed (RGB_MATRIX_ENABLE = IS31FL3731) and (RGB_MATRIX_ENABLE = IS31FL3733) - Updated documentation - Reverted to the use of differently named functions for each driver and selecting the needed ones within rgb_matrix.c * ISSI Drivers refractoring - Moved issi drivers in a dedicated folder - Updated documentation * I2C library fix I released the special pins incorrectly before. It is now fixed.
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgb_matrix.md52
-rw-r--r--docs/hardware_drivers.md6
2 files changed, 55 insertions, 3 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index ed33c7ea4e..4f827f8dc9 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -1,8 +1,12 @@
# RGB Matrix Lighting
+## Driver configuration
+
+### IS31FL3731
+
There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
- RGB_MATRIX_ENABLE = yes
+ RGB_MATRIX_ENABLE = IS31FL3731
Configure the hardware via your `config.h`:
@@ -36,7 +40,51 @@ Define these arrays listing all the LEDs in your `<keyboard>.c`:
....
}
-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).
+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).
+
+### IS31FL3733
+
+There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
+
+ RGB_MATRIX_ENABLE = IS31FL3733
+
+Configure the hardware via your `config.h`:
+
+ // This is a 7-bit address, that gets left-shifted and bit 0
+ // set to 0 for write, 1 for read (as per I2C protocol)
+ // The address will vary depending on your wiring:
+ // 00 <-> GND
+ // 01 <-> SCL
+ // 10 <-> SDA
+ // 11 <-> VCC
+ // ADDR1 represents A1:A0 of the 7-bit address.
+ // ADDR2 represents A3:A2 of the 7-bit address.
+ // The result is: 0b101(ADDR2)(ADDR1)
+ #define DRIVER_ADDR_1 0b1010000
+ #define DRIVER_ADDR_2 0b1010000 // this is here for compliancy reasons.
+
+ #define DRIVER_COUNT 1
+ #define DRIVER_1_LED_TOTAL 64
+ #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
+
+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`
+
+Define these arrays listing all the LEDs in your `<keyboard>.c`:
+
+ const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
+ /* Refer to IS31 manual for these locations
+ * driver
+ * | R location
+ * | | G location
+ * | | | B location
+ * | | | | */
+ {0, B_1, A_1, C_1},
+ ....
+ }
+
+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).
+
+From this point forward the configuration is the same for all the drivers.
const rgb_led g_rgb_leds[DRIVER_LED_TOTAL] = {
/* {row | col << 4}
diff --git a/docs/hardware_drivers.md b/docs/hardware_drivers.md
index 336bc908ef..4c1266f224 100644
--- a/docs/hardware_drivers.md
+++ b/docs/hardware_drivers.md
@@ -26,6 +26,10 @@ You can make use of uGFX within QMK to drive character and graphic LCD's, LED ar
Support for WS2811/WS2812{a,b,c} LED's. For more information see the [RGB Light](feature_rgblight.md) page.
-## IS31FL3731 (AVR Only)
+## IS31FL3731
Support for up to 2 drivers. Each driver impliments 2 charlieplex matrices to individually address LEDs using I2C. This allows up to 144 same color LEDs or 32 RGB LEDs. For more information on how to setup the driver see the [RGB Matrix](feature_rgb_matrix.md) page.
+
+## IS31FL3733
+
+Support for up to a single driver with room for expansion. Each driver can control 192 individual LEDs or 64 RGB LEDs. For more information on how to setup the driver see the [RGB Matrix](feature_rgb_matrix.md) page. \ No newline at end of file