summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-02-14 12:15:08 +1100
committerGitHub <noreply@github.com>2021-02-14 12:15:08 +1100
commit7ce5ba645abcbf3d859a418d4456a1cc80c73e64 (patch)
tree32de70337d61f36be88d142314a78ba6e8df6300 /docs
parentde8caf708c1a9a80527a04be620ed3969262e50b (diff)
LED Matrix: add led_matrix_types.h and implement g_led_config (#11741)
* LED Matrix: add led_matrix_types.h and implement g_led_config

* Set correct flags for non-"modifier" LEDs

* Clean up docs a little

* Add license headers for [led,rgb]_matrix_types.h
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_led_matrix.md85
1 files changed, 47 insertions, 38 deletions
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md
index 1383c97b49..6de01f31a1 100644
--- a/docs/feature_led_matrix.md
+++ b/docs/feature_led_matrix.md
@@ -10,9 +10,11 @@ If you want to use RGB LED's you should use the [RGB Matrix Subsystem](feature_r
 
 There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
 
-    LED_MATRIX_ENABLE = yes
-    LED_MATRIX_DRIVER = IS31FL3731
-    
+```make
+LED_MATRIX_ENABLE = yes
+LED_MATRIX_DRIVER = IS31FL3731
+```
+
 You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
 
 | Variable | Description | Default |
@@ -28,33 +30,38 @@ You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>
 
 Here is an example using 2 drivers.
 
-	// 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:
-	// 0b1110100 AD <-> GND
-	// 0b1110111 AD <-> VCC
-	// 0b1110101 AD <-> SCL
-	// 0b1110110 AD <-> SDA
-	#define LED_DRIVER_ADDR_1 0b1110100
-	#define LED_DRIVER_ADDR_2 0b1110110
-
-	#define LED_DRIVER_COUNT 2
-	#define LED_DRIVER_1_LED_COUNT 25
-	#define LED_DRIVER_2_LED_COUNT 24
-	#define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL
+```c
+// 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:
+// 0b1110100 AD <-> GND
+// 0b1110111 AD <-> VCC
+// 0b1110101 AD <-> SCL
+// 0b1110110 AD <-> SDA
+#define LED_DRIVER_ADDR_1 0b1110100
+#define LED_DRIVER_ADDR_2 0b1110110
+
+#define LED_DRIVER_COUNT 2
+#define LED_DRIVER_1_LED_COUNT 25
+#define LED_DRIVER_2_LED_COUNT 24
+#define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL
+```
 
 Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
 
 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
-	 *   |  LED address
-	 *   |  | */
-	    {0, C3_3},
-	    ....
-	}
+```c
+    const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
+    /* Refer to IS31 manual for these locations
+     *    driver
+     *    |  LED address
+     *    |  | */
+        { 0, C1_1  },
+        { 0, C1_15 },
+       // ...
+    }
+```
 
 Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/issi/is31fl3731-simple.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3` ).
 
@@ -66,26 +73,28 @@ All LED matrix keycodes are currently shared with the [backlight system](feature
 
 Currently no LED matrix effects have been created.
 
-## Custom layer effects
+## Custom Layer Effects
 
 Custom layer effects can be done by defining this in your `<keyboard>.c`:
 
-    void led_matrix_indicators_kb(void) {
-        led_matrix_set_index_value(index, value);
-    }
+```c
+void led_matrix_indicators_kb(void) {
+    led_matrix_set_index_value(index, value);
+}
+```
 
 A similar function works in the keymap as `led_matrix_indicators_user`.
 
-## Suspended state
+## Suspended State
 
 To use the suspend feature, add this to your `<keyboard>.c`:
 
-	void suspend_power_down_kb(void)
-	{
-	    led_matrix_set_suspend_state(true);
-	}
+```c
+void suspend_power_down_kb(void) {
+    led_matrix_set_suspend_state(true);
+}
 
-	void suspend_wakeup_init_kb(void)
-	{
-	    led_matrix_set_suspend_state(false);
-	}
+void suspend_wakeup_init_kb(void) {
+    led_matrix_set_suspend_state(false);
+}
+```
\ No newline at end of file