Keymap: Changed to use LAYOUT_kc() macro instead of LAYOUT() macro for easy maintenan...

[qmk_firmware.git] / docs / feature_rgb_matrix.md

diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index ed33c7ea4ee912826bc3c1f1441f4d3576826d29..0af1e4947960008f61ae69560af12e0f7e64e865 100644 (file)
--- 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}
@@ -92,6 +140,7 @@ These are the effects that are currently available:
            RGB_MATRIX_RAINBOW_PINWHEELS,
            RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
            RGB_MATRIX_JELLYBEAN_RAINDROPS,
+           RGB_MATRIX_DIGITAL_RAIN,
        #ifdef RGB_MATRIX_KEYPRESSES
            RGB_MATRIX_SOLID_REACTIVE,
            RGB_MATRIX_SPLASH,
@@ -101,6 +150,30 @@ These are the effects that are currently available:
        #endif
            RGB_MATRIX_EFFECT_MAX
        };
+    
+You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`:
+
+
+|Define                                             |Description                                 |
+|---------------------------------------------------|--------------------------------------------|
+|`#define DISABLE_RGB_MATRIX_ALPHAS_MODS`           |Disables `RGB_MATRIX_ALPHAS_MODS`           |
+|`#define DISABLE_RGB_MATRIX_DUAL_BEACON`           |Disables `RGB_MATRIX_DUAL_BEACON`           |
+|`#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN`      |Disables `RGB_MATRIX_GRADIENT_UP_DOWN`      |
+|`#define DISABLE_RGB_MATRIX_RAINDROPS`             |Disables `RGB_MATRIX_RAINDROPS`             |
+|`#define DISABLE_RGB_MATRIX_CYCLE_ALL`             |Disables `RGB_MATRIX_CYCLE_ALL`             |
+|`#define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT`      |Disables `RGB_MATRIX_CYCLE_LEFT_RIGHT`      |
+|`#define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN`         |Disables `RGB_MATRIX_CYCLE_UP_DOWN`         |
+|`#define DISABLE_RGB_MATRIX_RAINBOW_BEACON`        |Disables `RGB_MATRIX_RAINBOW_BEACON`        |
+|`#define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS`     |Disables `RGB_MATRIX_RAINBOW_PINWHEELS`     |
+|`#define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`|Disables `RGB_MATRIX_RAINBOW_MOVING_CHEVRON`|
+|`#define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS`   |Disables `RGB_MATRIX_JELLYBEAN_RAINDROPS`   |
+|`#define DISABLE_RGB_MATRIX_DIGITAL_RAIN`          |Disables `RGB_MATRIX_DIGITAL_RAIN`          |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE`        |Disables `RGB_MATRIX_SOLID_REACTIVE`        |
+|`#define DISABLE_RGB_MATRIX_SPLASH`                |Disables `RGB_MATRIX_SPLASH`                |
+|`#define DISABLE_RGB_MATRIX_MULTISPLASH`           |Disables `RGB_MATRIX_MULTISPLASH`           |
+|`#define DISABLE_RGB_MATRIX_SOLID_SPLASH`          |Disables `RGB_MATRIX_SOLID_SPLASH`          |
+|`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH`     |Disables `RGB_MATRIX_SOLID_MULTISPLASH`     |
+
 
 ## Custom layer effects