aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
authorTakeshi ISHII <2170248+mtei@users.noreply.github.com>2019-03-21 08:55:24 +0900
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-03-20 16:55:24 -0700
commitf7fd7f67bd1286a42326a6832627ef328252db0c (patch)
treeaf2be4e14b19d10ec58989fb3d46057009c79429 /docs/feature_rgblight.md
parentd5fd8c4f1cf79de17528f7f40948640fa8bb8d7a (diff)
downloadqmk_firmware-f7fd7f67bd1286a42326a6832627ef328252db0c.tar.gz
qmk_firmware-f7fd7f67bd1286a42326a6832627ef328252db0c.zip
rgblight.c: add remap feature (#5243)
* rgblight.c: add RGBLIGHT_LED_MAP support * add code to keyboards/helix/rev2/keymaps/five_rows/config.h to test rgblight.c:RGBLIGHT_LED_MAP * Test end. Revert "add code to keyboards/helix/rev2/keymaps/five_rows/config.h to test rgblight.c:RGBLIGHT_LED_MAP" This reverts commit e7488d6f7338460b533d7d19a09deccb011000bf. * update docs/feature_rgblight.md * led_map[] move to PROGMEM
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 23b6f1c94..800e59738 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -188,6 +188,53 @@ If you need to change your RGB lighting in code, for example in a macro to chang
188 188
189Additionally, [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h) defines several predefined shortcuts for various colors. Feel free to add to this list! 189Additionally, [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h) defines several predefined shortcuts for various colors. Feel free to add to this list!
190 190
191## Changing the order of the LEDs
192
193If you want to make the logical order of LEDs different from the electrical connection order, you can do this by defining the `RGBLIGHT_LED_MAP` macro in your `config.h`.
194
195By defining `RGBLIGHT_LED_MAP` as in the example below, you can specify the LED with addressing in reverse order of the electrical connection order.
196
197```c
198// config.h
199
200#define RGBLED_NUM 10
201#define RGBLIGHT_LED_MAP { 9, 8, 7, 6, 5, 4, 3, 2, 1, 0 }
202
203```
204
205For keyboards that use the RGB LEDs as a backlight for each key, you can also define it as in the example below.
206
207```c
208// config.h
209
210#define RGBLED_NUM 30
211
212/* RGB LED Conversion macro from physical array to electric array */
213#define LED_LAYOUT( \
214 L00, L01, L02, L03, L04, L05, \
215 L10, L11, L12, L13, L14, L15, \
216 L20, L21, L22, L23, L24, L25, \
217 L30, L31, L32, L33, L34, L35, \
218 L40, L41, L42, L43, L44, L45 ) \
219 { \
220 L05, L04, L03, L02, L01, L00, \
221 L10, L11, L12, L13, L14, L15, \
222 L25, L24, L23, L22, L21, L20, \
223 L30, L31, L32, L33, L34, L35, \
224 L46, L45, L44, L43, L42, L41 \
225 }
226
227/* RGB LED logical order map */
228/* Top->Bottom, Right->Left */
229#define RGBLIGHT_LED_MAP LED_LAYOUT( \
230 25, 20, 15, 10, 5, 0, \
231 26, 21, 16, 11, 6, 1, \
232 27, 22, 17, 12, 7, 2, \
233 28, 23, 18, 13, 8, 3, \
234 29, 24, 19, 14, 9, 4 )
235
236```
237
191## Hardware Modification 238## Hardware Modification
192 239
193If your keyboard lacks onboard underglow LEDs, you may often be able to solder on an RGB LED strip yourself. You will need to find an unused pin to wire to the data pin of your LED strip. Some keyboards may break out unused pins from the MCU to make soldering easier. The other two pins, VCC and GND, must also be connected to the appropriate power pins. 240If your keyboard lacks onboard underglow LEDs, you may often be able to solder on an RGB LED strip yourself. You will need to find an unused pin to wire to the data pin of your LED strip. Some keyboards may break out unused pins from the MCU to make soldering easier. The other two pins, VCC and GND, must also be connected to the appropriate power pins.