1 files changed, 78 insertions, 5 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index cb7aa666c..0af1e4947 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}
@@ -80,7 +128,7 @@ All RGB keycodes are currently shared with the RGBLIGHT system:
 These are the effects that are currently available:
        enum rgb_matrix_effects {
-                RGB_MATRIX_SOLID_COLOR = 1,
+            RGB_MATRIX_SOLID_COLOR = 1,
            RGB_MATRIX_ALPHAS_MODS,
            RGB_MATRIX_DUAL_BEACON,
            RGB_MATRIX_GRADIENT_UP_DOWN,
@@ -92,8 +140,9 @@ 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_SOLID_REACTIVE,
            RGB_MATRIX_SPLASH,
            RGB_MATRIX_MULTISPLASH,
            RGB_MATRIX_SOLID_SPLASH,
@@ -101,13 +150,37 @@ 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
 Custom layer effects can be done by defining this in your `<keyboard>.c`:
    void rgb_matrix_indicators_kb(void) {
-        // rgb_matrix_set_color(index, red, green, blue);
+        rgb_matrix_set_color(index, red, green, blue);
    }
 A similar function works in the keymap as `rgb_matrix_indicators_user`.

diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index cb7aa666c..0af1e4947 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
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`:	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`:
4		8
5	RGB_MATRIX_ENABLE = yes	9	RGB_MATRIX_ENABLE = IS31FL3731
6		10
7	Configure the hardware via your `config.h`:	11	Configure 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
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).	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).
		44
		45	### IS31FL3733
		46
		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`:
		48
		49	RGB_MATRIX_ENABLE = IS31FL3733
		50
		51	Configure 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
		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`
		71
		72	Define 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
		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).
		86
		87	From 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}
@@ -80,7 +128,7 @@ All RGB keycodes are currently shared with the RGBLIGHT system:
80	These are the effects that are currently available:	128	These are the effects that are currently available:
81		129
82	enum rgb_matrix_effects {	130	enum rgb_matrix_effects {
83	RGB_MATRIX_SOLID_COLOR = 1,	131	RGB_MATRIX_SOLID_COLOR = 1,
84	RGB_MATRIX_ALPHAS_MODS,	132	RGB_MATRIX_ALPHAS_MODS,
85	RGB_MATRIX_DUAL_BEACON,	133	RGB_MATRIX_DUAL_BEACON,
86	RGB_MATRIX_GRADIENT_UP_DOWN,	134	RGB_MATRIX_GRADIENT_UP_DOWN,
@@ -92,8 +140,9 @@ These are the effects that are currently available:
92	RGB_MATRIX_RAINBOW_PINWHEELS,	140	RGB_MATRIX_RAINBOW_PINWHEELS,
93	RGB_MATRIX_RAINBOW_MOVING_CHEVRON,	141	RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
94	RGB_MATRIX_JELLYBEAN_RAINDROPS,	142	RGB_MATRIX_JELLYBEAN_RAINDROPS,
		143	RGB_MATRIX_DIGITAL_RAIN,
95	#ifdef RGB_MATRIX_KEYPRESSES	144	#ifdef RGB_MATRIX_KEYPRESSES
96	RGB_MATRIX_SOLID_REACTIVE,	145	RGB_MATRIX_SOLID_REACTIVE,
97	RGB_MATRIX_SPLASH,	146	RGB_MATRIX_SPLASH,
98	RGB_MATRIX_MULTISPLASH,	147	RGB_MATRIX_MULTISPLASH,
99	RGB_MATRIX_SOLID_SPLASH,	148	RGB_MATRIX_SOLID_SPLASH,
@@ -101,13 +150,37 @@ These are the effects that are currently available:
101	#endif	150	#endif
102	RGB_MATRIX_EFFECT_MAX	151	RGB_MATRIX_EFFECT_MAX
103	};	152	};
		153
		154	You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`:
		155
		156
		157	\|Define \|Description \|
		158	\|---------------------------------------------------\|--------------------------------------------\|
		159	\|`#define DISABLE_RGB_MATRIX_ALPHAS_MODS` \|Disables `RGB_MATRIX_ALPHAS_MODS` \|
		160	\|`#define DISABLE_RGB_MATRIX_DUAL_BEACON` \|Disables `RGB_MATRIX_DUAL_BEACON` \|
		161	\|`#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN` \|Disables `RGB_MATRIX_GRADIENT_UP_DOWN` \|
		162	\|`#define DISABLE_RGB_MATRIX_RAINDROPS` \|Disables `RGB_MATRIX_RAINDROPS` \|
		163	\|`#define DISABLE_RGB_MATRIX_CYCLE_ALL` \|Disables `RGB_MATRIX_CYCLE_ALL` \|
		164	\|`#define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT` \|Disables `RGB_MATRIX_CYCLE_LEFT_RIGHT` \|
		165	\|`#define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN` \|Disables `RGB_MATRIX_CYCLE_UP_DOWN` \|
		166	\|`#define DISABLE_RGB_MATRIX_RAINBOW_BEACON` \|Disables `RGB_MATRIX_RAINBOW_BEACON` \|
		167	\|`#define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS` \|Disables `RGB_MATRIX_RAINBOW_PINWHEELS` \|
		168	\|`#define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`\|Disables `RGB_MATRIX_RAINBOW_MOVING_CHEVRON`\|
		169	\|`#define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS` \|Disables `RGB_MATRIX_JELLYBEAN_RAINDROPS` \|
		170	\|`#define DISABLE_RGB_MATRIX_DIGITAL_RAIN` \|Disables `RGB_MATRIX_DIGITAL_RAIN` \|
		171	\|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE` \|Disables `RGB_MATRIX_SOLID_REACTIVE` \|
		172	\|`#define DISABLE_RGB_MATRIX_SPLASH` \|Disables `RGB_MATRIX_SPLASH` \|
		173	\|`#define DISABLE_RGB_MATRIX_MULTISPLASH` \|Disables `RGB_MATRIX_MULTISPLASH` \|
		174	\|`#define DISABLE_RGB_MATRIX_SOLID_SPLASH` \|Disables `RGB_MATRIX_SOLID_SPLASH` \|
		175	\|`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH` \|Disables `RGB_MATRIX_SOLID_MULTISPLASH` \|
		176
104		177
105	## Custom layer effects	178	## Custom layer effects
106		179
107	Custom layer effects can be done by defining this in your `<keyboard>.c`:	180	Custom layer effects can be done by defining this in your `<keyboard>.c`:
108		181
109	void rgb_matrix_indicators_kb(void) {	182	void rgb_matrix_indicators_kb(void) {
110	// rgb_matrix_set_color(index, red, green, blue);	183	rgb_matrix_set_color(index, red, green, blue);
111	}	184	}
112		185
113	A similar function works in the keymap as `rgb_matrix_indicators_user`.	186	A similar function works in the keymap as `rgb_matrix_indicators_user`.