aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryiancar <yiangosyiangou@cytanet.com.cy>2018-08-10 03:41:48 +0300
committerDrashna Jaelre <drashna@live.com>2018-08-09 17:41:48 -0700
commit435e9b7bdb89043b3ce8b0cfc9b0f3ee4d298166 (patch)
tree0ffcf774d95f72057fdf08c3b7c04fc9f0eed948
parent925b65b7d0f6538d8ec410d9b1c285a178057bf1 (diff)
downloadqmk_firmware-435e9b7bdb89043b3ce8b0cfc9b0f3ee4d298166.tar.gz
qmk_firmware-435e9b7bdb89043b3ce8b0cfc9b0f3ee4d298166.zip
RGB Driver Documentation Update (#3601)
- Minor formating in rgb matrix page - Added a short discription for is31fl3731 in drivers page
-rw-r--r--docs/feature_rgb_matrix.md6
-rw-r--r--docs/hardware_drivers.md4
2 files changed, 7 insertions, 3 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index cb7aa666c..ed33c7ea4 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -80,7 +80,7 @@ All RGB keycodes are currently shared with the RGBLIGHT system:
80These are the effects that are currently available: 80These are the effects that are currently available:
81 81
82 enum rgb_matrix_effects { 82 enum rgb_matrix_effects {
83 RGB_MATRIX_SOLID_COLOR = 1, 83 RGB_MATRIX_SOLID_COLOR = 1,
84 RGB_MATRIX_ALPHAS_MODS, 84 RGB_MATRIX_ALPHAS_MODS,
85 RGB_MATRIX_DUAL_BEACON, 85 RGB_MATRIX_DUAL_BEACON,
86 RGB_MATRIX_GRADIENT_UP_DOWN, 86 RGB_MATRIX_GRADIENT_UP_DOWN,
@@ -93,7 +93,7 @@ These are the effects that are currently available:
93 RGB_MATRIX_RAINBOW_MOVING_CHEVRON, 93 RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
94 RGB_MATRIX_JELLYBEAN_RAINDROPS, 94 RGB_MATRIX_JELLYBEAN_RAINDROPS,
95 #ifdef RGB_MATRIX_KEYPRESSES 95 #ifdef RGB_MATRIX_KEYPRESSES
96 RGB_MATRIX_SOLID_REACTIVE, 96 RGB_MATRIX_SOLID_REACTIVE,
97 RGB_MATRIX_SPLASH, 97 RGB_MATRIX_SPLASH,
98 RGB_MATRIX_MULTISPLASH, 98 RGB_MATRIX_MULTISPLASH,
99 RGB_MATRIX_SOLID_SPLASH, 99 RGB_MATRIX_SOLID_SPLASH,
@@ -107,7 +107,7 @@ These are the effects that are currently available:
107Custom layer effects can be done by defining this in your `<keyboard>.c`: 107Custom layer effects can be done by defining this in your `<keyboard>.c`:
108 108
109 void rgb_matrix_indicators_kb(void) { 109 void rgb_matrix_indicators_kb(void) {
110 // rgb_matrix_set_color(index, red, green, blue); 110 rgb_matrix_set_color(index, red, green, blue);
111 } 111 }
112 112
113A similar function works in the keymap as `rgb_matrix_indicators_user`. 113A similar function works in the keymap as `rgb_matrix_indicators_user`.
diff --git a/docs/hardware_drivers.md b/docs/hardware_drivers.md
index 46e6a7101..336bc908e 100644
--- a/docs/hardware_drivers.md
+++ b/docs/hardware_drivers.md
@@ -25,3 +25,7 @@ You can make use of uGFX within QMK to drive character and graphic LCD's, LED ar
25## WS2812 (AVR Only) 25## WS2812 (AVR Only)
26 26
27Support for WS2811/WS2812{a,b,c} LED's. For more information see the [RGB Light](feature_rgblight.md) page. 27Support for WS2811/WS2812{a,b,c} LED's. For more information see the [RGB Light](feature_rgblight.md) page.
28
29## IS31FL3731 (AVR Only)
30
31Support for up to 2 drivers. Each driver impliments 2 charlieplex matrices to individually address LEDs using I2C. This allows up to 144 same color LEDs or 32 RGB LEDs. For more information on how to setup the driver see the [RGB Matrix](feature_rgb_matrix.md) page.