diff options
| author | XScorpion2 <rcalt2vt@gmail.com> | 2019-04-14 20:50:35 -0400 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-04-14 17:50:35 -0700 |
| commit | 5fcd744ddba591829a129560992b2e43fb615d4d (patch) | |
| tree | 33b78133af1563f5dfa1e125a37f86e30a7df1cb /docs/feature_rgb_matrix.md | |
| parent | d7ba190cd9b90bce3a00dfa2a9afe4b3bf0a1dbb (diff) | |
| download | qmk_firmware-5fcd744ddba591829a129560992b2e43fb615d4d.tar.gz qmk_firmware-5fcd744ddba591829a129560992b2e43fb615d4d.zip | |
Features/ws2812 matrix driver (#5418)
* WS2812 driver implementation for RGB Matrix
* Added driver configuration docs
Diffstat (limited to 'docs/feature_rgb_matrix.md')
| -rw-r--r-- | docs/feature_rgb_matrix.md | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index 36d9d0113..e744ecc49 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
| @@ -5,7 +5,7 @@ This feature allows you to use RGB LED matrices driven by external drivers. It h | |||
| 5 | If you want to use single color LED's you should use the [LED Matrix Subsystem](feature_led_matrix.md) instead. | 5 | If you want to use single color LED's you should use the [LED Matrix Subsystem](feature_led_matrix.md) instead. |
| 6 | 6 | ||
| 7 | ## Driver configuration | 7 | ## Driver configuration |
| 8 | 8 | --- | |
| 9 | ### IS31FL3731 | 9 | ### IS31FL3731 |
| 10 | 10 | ||
| 11 | There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`: | 11 | There is basic support for addressable RGB matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`: |
| @@ -52,6 +52,7 @@ const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { | |||
| 52 | 52 | ||
| 53 | 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). | 53 | 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). |
| 54 | 54 | ||
| 55 | --- | ||
| 55 | ### IS31FL3733/IS31FL3737 | 56 | ### IS31FL3733/IS31FL3737 |
| 56 | 57 | ||
| 57 | !> For the IS31FL3737, replace all instances of `IS31FL3733` below with `IS31FL3737`. | 58 | !> For the IS31FL3737, replace all instances of `IS31FL3733` below with `IS31FL3737`. |
| @@ -102,6 +103,27 @@ const is31_led g_is31_leds[DRIVER_LED_TOTAL] = { | |||
| 102 | 103 | ||
| 103 | 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). | 104 | 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). |
| 104 | 105 | ||
| 106 | --- | ||
| 107 | |||
| 108 | ### WS2812 (AVR only) | ||
| 109 | |||
| 110 | There is basic support for addressable RGB matrix lighting with a WS2811/WS2812{a,b,c} addressable LED strand. To enable it, add this to your `rules.mk`: | ||
| 111 | |||
| 112 | ```C | ||
| 113 | RGB_MATRIX_ENABLE = WS2812 | ||
| 114 | ``` | ||
| 115 | |||
| 116 | Configure the hardware via your `config.h`: | ||
| 117 | |||
| 118 | ```C | ||
| 119 | // The pin connected to the data pin of the LEDs | ||
| 120 | #define RGB_DI_PIN D7 | ||
| 121 | // The number of LEDs connected | ||
| 122 | #define DRIVER_LED_TOTAL 70 | ||
| 123 | ``` | ||
| 124 | |||
| 125 | --- | ||
| 126 | |||
| 105 | From this point forward the configuration is the same for all the drivers. | 127 | From this point forward the configuration is the same for all the drivers. |
| 106 | 128 | ||
| 107 | ```C | 129 | ```C |
