]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - docs/feature_rgb_matrix.md
fix rgblight_effect_breathing interval time (#5213)
[qmk_firmware.git] / docs / feature_rgb_matrix.md
index 0af1e4947960008f61ae69560af12e0f7e64e865..910a704691255aa94fbf6cc1d4471e4912059e76 100644 (file)
@@ -1,5 +1,9 @@
 # RGB Matrix Lighting
 
+This feature allows you to use RGB LED matrices driven by external drivers. It hooks into the RGBLIGHT system so you can use the same keycodes as RGBLIGHT to control it.
+
+If you want to use single color LED's you should use the [LED Matrix Subsystem](feature_led_matrix.md) instead.
+
 ## Driver configuration
 
 ### IS31FL3731
@@ -63,7 +67,7 @@ Configure the hardware via your `config.h`:
        #define DRIVER_ADDR_1 0b1010000
        #define DRIVER_ADDR_2 0b1010000 // this is here for compliancy reasons.
 
-       #define DRIVER_COUNT 1
+       #define DRIVER_COUNT 2
        #define DRIVER_1_LED_TOTAL 64
        #define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
 
@@ -98,8 +102,8 @@ From this point forward the configuration is the same for all the drivers.
 
 The format for the matrix position used in this array is `{row | (col << 4)}`. The `x` is between (inclusive) 0-224, and `y` is between (inclusive) 0-64. The easiest way to calculate these positions is:
 
-    x = 224 / ( NUMBER_OF_ROWS - 1 ) * ROW_POSITION
-    y = 64 / (NUMBER_OF_COLS - 1 ) * COL_POSITION
+    x = 224 / ( NUMBER_OF_COLS - 1 ) * ROW_POSITION
+    y = 64 / (NUMBER_OF_ROWS - 1 ) * COL_POSITION
 
 Where all variables are decimels/floats.