aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/feature_rgblight.md32
1 files changed, 29 insertions, 3 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index c9323deb5..cba97cb41 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -188,6 +188,7 @@ If you need to change your RGB lighting in code, for example in a macro to chang
188|`rgblight_increase_val_noeeprom()` |Increase the value for all LEDs. This wraps around at maximum value (not written to EEPROM) | 188|`rgblight_increase_val_noeeprom()` |Increase the value for all LEDs. This wraps around at maximum value (not written to EEPROM) |
189|`rgblight_decrease_val()` |Decrease the value for all LEDs. This wraps around at minimum value | 189|`rgblight_decrease_val()` |Decrease the value for all LEDs. This wraps around at minimum value |
190|`rgblight_decrease_val_noeeprom()` |Decrease the value for all LEDs. This wraps around at minimum value (not written to EEPROM) | 190|`rgblight_decrease_val_noeeprom()` |Decrease the value for all LEDs. This wraps around at minimum value (not written to EEPROM) |
191|`rgblight_set_clipping_range(pos, num)` |Set clipping Range |
191 192
192Additionally, [`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! 193Additionally, [`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!
193 194
@@ -195,15 +196,19 @@ Additionally, [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/maste
195 196
196If 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`. 197If 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`.
197 198
199Normally, the contents of the LED buffer are output to the LEDs in the same order.
200<img src="https://user-images.githubusercontent.com/2170248/55743718-01866c80-5a6e-11e9-8134-25419928327a.JPG" alt="simple dicrect" width="50%"/>
201
198By defining `RGBLIGHT_LED_MAP` as in the example below, you can specify the LED with addressing in reverse order of the electrical connection order. 202By defining `RGBLIGHT_LED_MAP` as in the example below, you can specify the LED with addressing in reverse order of the electrical connection order.
199 203
200```c 204```c
201// config.h 205// config.h
202 206
203#define RGBLED_NUM 10 207#define RGBLED_NUM 4
204#define RGBLIGHT_LED_MAP { 9, 8, 7, 6, 5, 4, 3, 2, 1, 0 } 208#define RGBLIGHT_LED_MAP { 3, 2, 1, 0 }
205 209
206``` 210```
211<img src="https://user-images.githubusercontent.com/2170248/55743725-08ad7a80-5a6e-11e9-83ed-126a2b0209fc.JPG" alt="simple mapped" width="50%"/>
207 212
208For keyboards that use the RGB LEDs as a backlight for each key, you can also define it as in the example below. 213For keyboards that use the RGB LEDs as a backlight for each key, you can also define it as in the example below.
209 214
@@ -237,7 +242,28 @@ For keyboards that use the RGB LEDs as a backlight for each key, you can also de
237 29, 24, 19, 14, 9, 4 ) 242 29, 24, 19, 14, 9, 4 )
238 243
239``` 244```
245## Clipping Range
246
247Using the `rgblight_set_clipping_range()` function, you can prepare more buffers than the actual number of LEDs, and output some of the buffers to the LEDs. This is useful if you want the split keyboard to treat left and right LEDs as logically contiguous.
248
249You can set the Clipping Range by executing the following code.
250
251```c
252// some soruce
253 rgblight_set_clipping_range(3, 4);
254```
255<img src="https://user-images.githubusercontent.com/2170248/55743785-2bd82a00-5a6e-11e9-9d4b-1b4ffaf4932b.JPG" alt="clip direct" width="70%"/>
240 256
241## Hardware Modification 257In addition to setting the Clipping Range, you can use `RGBLIGHT_LED_MAP` together.
258
259```c
260// config.h
261#define RGBLED_NUM 8
262#define RGBLIGHT_LED_MAP { 7, 6, 5, 4, 3, 2, 1, 0 }
263
264// some soruce
265 rgblight_set_clipping_range(3, 4);
266```
267<img src="https://user-images.githubusercontent.com/2170248/55743747-119e4c00-5a6e-11e9-91e5-013203ffae8a.JPG" alt="clip mapped" width="70%"/>
242 268
243If 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. 269If 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.