From 0456bd668de37f118e717aabf00a132756ea619c Mon Sep 17 00:00:00 2001
From: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Date: Tue, 9 Apr 2019 02:55:00 +0900
Subject: [PATCH] [Docs] update feature_rgblight.md: add some figures (#5578)
* Added diagrams to illustrate the RGBLIGHT_LED_MAP macro and the `rgblight_set_clipping_range()` function.
* change fig size
* change fig size
* update figs
---
docs/feature_rgblight.md | 32 +++++++++++++++++++++++++++++---
1 file changed, 29 insertions(+), 3 deletions(-)
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index c9323deb5e..cba97cb417 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
|`rgblight_increase_val_noeeprom()` |Increase the value for all LEDs. This wraps around at maximum value (not written to EEPROM) |
|`rgblight_decrease_val()` |Decrease the value for all LEDs. This wraps around at minimum value |
|`rgblight_decrease_val_noeeprom()` |Decrease the value for all LEDs. This wraps around at minimum value (not written to EEPROM) |
+|`rgblight_set_clipping_range(pos, num)` |Set clipping Range |
Additionally, [`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!
@@ -195,15 +196,19 @@ Additionally, [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/maste
If 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`.
+Normally, the contents of the LED buffer are output to the LEDs in the same order.
+
+
By defining `RGBLIGHT_LED_MAP` as in the example below, you can specify the LED with addressing in reverse order of the electrical connection order.
```c
// config.h
-#define RGBLED_NUM 10
-#define RGBLIGHT_LED_MAP { 9, 8, 7, 6, 5, 4, 3, 2, 1, 0 }
+#define RGBLED_NUM 4
+#define RGBLIGHT_LED_MAP { 3, 2, 1, 0 }
```
+
For keyboards that use the RGB LEDs as a backlight for each key, you can also define it as in the example below.
@@ -237,7 +242,28 @@ For keyboards that use the RGB LEDs as a backlight for each key, you can also de
29, 24, 19, 14, 9, 4 )
```
+## Clipping Range
+
+Using 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.
+
+You can set the Clipping Range by executing the following code.
+
+```c
+// some soruce
+ rgblight_set_clipping_range(3, 4);
+```
+
-## Hardware Modification
+In addition to setting the Clipping Range, you can use `RGBLIGHT_LED_MAP` together.
+
+```c
+// config.h
+#define RGBLED_NUM 8
+#define RGBLIGHT_LED_MAP { 7, 6, 5, 4, 3, 2, 1, 0 }
+
+// some soruce
+ rgblight_set_clipping_range(3, 4);
+```
+
If 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.