diff options
Diffstat (limited to 'docs/feature_led_matrix.md')
| -rw-r--r-- | docs/feature_led_matrix.md | 85 |
1 files changed, 47 insertions, 38 deletions
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md index 1383c97b4..6de01f31a 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 | |||
| 10 | 10 | ||
| 11 | There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`: | 11 | There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`: |
| 12 | 12 | ||
| 13 | LED_MATRIX_ENABLE = yes | 13 | ```make |
| 14 | LED_MATRIX_DRIVER = IS31FL3731 | 14 | LED_MATRIX_ENABLE = yes |
| 15 | 15 | LED_MATRIX_DRIVER = IS31FL3731 | |
| 16 | ``` | ||
| 17 | |||
| 16 | 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`: | 18 | 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`: |
| 17 | 19 | ||
| 18 | | Variable | Description | Default | | 20 | | Variable | Description | Default | |
| @@ -28,33 +30,38 @@ You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N> | |||
| 28 | 30 | ||
| 29 | Here is an example using 2 drivers. | 31 | Here is an example using 2 drivers. |
| 30 | 32 | ||
| 31 | // This is a 7-bit address, that gets left-shifted and bit 0 | 33 | ```c |
| 32 | // set to 0 for write, 1 for read (as per I2C protocol) | 34 | // This is a 7-bit address, that gets left-shifted and bit 0 |
| 33 | // The address will vary depending on your wiring: | 35 | // set to 0 for write, 1 for read (as per I2C protocol) |
| 34 | // 0b1110100 AD <-> GND | 36 | // The address will vary depending on your wiring: |
| 35 | // 0b1110111 AD <-> VCC | 37 | // 0b1110100 AD <-> GND |
| 36 | // 0b1110101 AD <-> SCL | 38 | // 0b1110111 AD <-> VCC |
| 37 | // 0b1110110 AD <-> SDA | 39 | // 0b1110101 AD <-> SCL |
| 38 | #define LED_DRIVER_ADDR_1 0b1110100 | 40 | // 0b1110110 AD <-> SDA |
| 39 | #define LED_DRIVER_ADDR_2 0b1110110 | 41 | #define LED_DRIVER_ADDR_1 0b1110100 |
| 40 | 42 | #define LED_DRIVER_ADDR_2 0b1110110 | |
| 41 | #define LED_DRIVER_COUNT 2 | 43 | |
| 42 | #define LED_DRIVER_1_LED_COUNT 25 | 44 | #define LED_DRIVER_COUNT 2 |
| 43 | #define LED_DRIVER_2_LED_COUNT 24 | 45 | #define LED_DRIVER_1_LED_COUNT 25 |
| 44 | #define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL | 46 | #define LED_DRIVER_2_LED_COUNT 24 |
| 47 | #define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL | ||
| 48 | ``` | ||
| 45 | 49 | ||
| 46 | Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations. | 50 | Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations. |
| 47 | 51 | ||
| 48 | Define these arrays listing all the LEDs in your `<keyboard>.c`: | 52 | Define these arrays listing all the LEDs in your `<keyboard>.c`: |
| 49 | 53 | ||
| 50 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { | 54 | ```c |
| 51 | /* Refer to IS31 manual for these locations | 55 | const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { |
| 52 | * driver | 56 | /* Refer to IS31 manual for these locations |
| 53 | * | LED address | 57 | * driver |
| 54 | * | | */ | 58 | * | LED address |
| 55 | {0, C3_3}, | 59 | * | | */ |
| 56 | .... | 60 | { 0, C1_1 }, |
| 57 | } | 61 | { 0, C1_15 }, |
| 62 | // ... | ||
| 63 | } | ||
| 64 | ``` | ||
| 58 | 65 | ||
| 59 | 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 | 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` ). |
| 60 | 67 | ||
| @@ -66,26 +73,28 @@ All LED matrix keycodes are currently shared with the [backlight system](feature | |||
| 66 | 73 | ||
| 67 | Currently no LED matrix effects have been created. | 74 | Currently no LED matrix effects have been created. |
| 68 | 75 | ||
| 69 | ## Custom layer effects | 76 | ## Custom Layer Effects |
| 70 | 77 | ||
| 71 | Custom layer effects can be done by defining this in your `<keyboard>.c`: | 78 | Custom layer effects can be done by defining this in your `<keyboard>.c`: |
| 72 | 79 | ||
| 73 | void led_matrix_indicators_kb(void) { | 80 | ```c |
| 74 | led_matrix_set_index_value(index, value); | 81 | void led_matrix_indicators_kb(void) { |
| 75 | } | 82 | led_matrix_set_index_value(index, value); |
| 83 | } | ||
| 84 | ``` | ||
| 76 | 85 | ||
| 77 | A similar function works in the keymap as `led_matrix_indicators_user`. | 86 | A similar function works in the keymap as `led_matrix_indicators_user`. |
| 78 | 87 | ||
| 79 | ## Suspended state | 88 | ## Suspended State |
| 80 | 89 | ||
| 81 | To use the suspend feature, add this to your `<keyboard>.c`: | 90 | To use the suspend feature, add this to your `<keyboard>.c`: |
| 82 | 91 | ||
| 83 | void suspend_power_down_kb(void) | 92 | ```c |
| 84 | { | 93 | void suspend_power_down_kb(void) { |
| 85 | led_matrix_set_suspend_state(true); | 94 | led_matrix_set_suspend_state(true); |
| 86 | } | 95 | } |
| 87 | 96 | ||
| 88 | void suspend_wakeup_init_kb(void) | 97 | void suspend_wakeup_init_kb(void) { |
| 89 | { | 98 | led_matrix_set_suspend_state(false); |
| 90 | led_matrix_set_suspend_state(false); | 99 | } |
| 91 | } | 100 | ``` \ No newline at end of file |
