diff options
Diffstat (limited to 'docs/feature_rgb_matrix.md')
-rw-r--r-- | docs/feature_rgb_matrix.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index bfb3688b6..25ba3ffe3 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
@@ -228,6 +228,74 @@ Configure the hardware via your `config.h`: | |||
228 | ``` | 228 | ``` |
229 | 229 | ||
230 | --- | 230 | --- |
231 | ### AW20216 :id=aw20216 | ||
232 | There is basic support for addressable RGB matrix lighting with the SPI AW20216 RGB controller. To enable it, add this to your `rules.mk`: | ||
233 | |||
234 | ```makefile | ||
235 | RGB_MATRIX_ENABLE = yes | ||
236 | RGB_MATRIX_DRIVER = AW20216 | ||
237 | ``` | ||
238 | |||
239 | You can use up to 2 AW20216 IC's. Do not specify `DRIVER_<N>_xxx` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`: | ||
240 | |||
241 | | Variable | Description | Default | | ||
242 | |----------|-------------|---------| | ||
243 | | `DRIVER_1_CS` | (Required) MCU pin connected to first RGB driver chip select line | B13 | | ||
244 | | `DRIVER_2_CS` | (Optional) MCU pin connected to second RGB driver chip select line | | | ||
245 | | `DRIVER_1_EN` | (Required) MCU pin connected to first RGB driver hardware enable line | C13 | | ||
246 | | `DRIVER_2_EN` | (Optional) MCU pin connected to second RGB driver hardware enable line | | | ||
247 | | `DRIVER_1_LED_TOTAL` | (Required) How many RGB lights are connected to first RGB driver | | | ||
248 | | `DRIVER_2_LED_TOTAL` | (Optional) How many RGB lights are connected to second RGB driver | | | ||
249 | | `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | | | ||
250 | | `DRIVER_LED_TOTAL` | (Required) How many RGB lights are present across all drivers | | | ||
251 | | `AW_SCALING_MAX` | (Optional) LED current scaling value (0-255, higher values mean LED is brighter at full PWM) | 150 | | ||
252 | | `AW_GLOBAL_CURRENT_MAX` | (Optional) Driver global current limit (0-255, higher values means the driver may consume more power) | 150 | | ||
253 | |||
254 | Here is an example using 2 drivers. | ||
255 | |||
256 | ```c | ||
257 | #define DRIVER_1_CS B13 | ||
258 | #define DRIVER_2_CS B14 | ||
259 | // Hardware enable lines may be connected to the same pin | ||
260 | #define DRIVER_1_EN C13 | ||
261 | #define DRIVER_2_EN C13 | ||
262 | |||
263 | #define DRIVER_COUNT 2 | ||
264 | #define DRIVER_1_LED_TOTAL 66 | ||
265 | #define DRIVER_2_LED_TOTAL 32 | ||
266 | #define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL) | ||
267 | ``` | ||
268 | |||
269 | !> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`. | ||
270 | |||
271 | Define these arrays listing all the LEDs in your `<keyboard>.c`: | ||
272 | |||
273 | ```c | ||
274 | const aw_led g_aw_leds[DRIVER_LED_TOTAL] = { | ||
275 | /* Each AW20216 channel is controlled by a register at some offset between 0x00 | ||
276 | * and 0xD7 inclusive. | ||
277 | * See drivers/awinic/aw20216.h for the mapping between register offsets and | ||
278 | * driver pin locations. | ||
279 | * driver | ||
280 | * | R location | ||
281 | * | | G location | ||
282 | * | | | B location | ||
283 | * | | | | */ | ||
284 | { 0, CS1_SW1, CS2_SW1, CS3_SW1 }, | ||
285 | { 0, CS4_SW1, CS5_SW1, CS6_SW1 }, | ||
286 | { 0, CS7_SW1, CS8_SW1, CS9_SW1 }, | ||
287 | { 0, CS10_SW1, CS11_SW1, CS12_SW1 }, | ||
288 | { 0, CS13_SW1, CS14_SW1, CS15_SW1 }, | ||
289 | ... | ||
290 | { 1, CS1_SW1, CS2_SW1, CS3_SW1 }, | ||
291 | { 1, CS13_SW1, CS14_SW1, CS15_SW1 }, | ||
292 | { 1, CS16_SW1, CS17_SW1, CS18_SW1 }, | ||
293 | { 1, CS4_SW2, CS5_SW2, CS6_SW2 }, | ||
294 | ... | ||
295 | }; | ||
296 | ``` | ||
297 | |||
298 | --- | ||
231 | 299 | ||
232 | ## Common Configuration :id=common-configuration | 300 | ## Common Configuration :id=common-configuration |
233 | 301 | ||