openwrt/upstream - upstream openwrt

diff options

author	Felix Fietkau <nbd@openwrt.org>	2010-02-15 17:29:07 +0000
committer	Felix Fietkau <nbd@openwrt.org>	2010-02-15 17:29:07 +0000
commit	edc6ce204847182dcf2fb2122a99a0de4f5dbc4f (patch)
tree	7261e3c5abe0ad6cceae39a56f0f71baad2cbca4 /package/swconfig/src/cli.c
parent	9a4f0bc43b5d848861582bf88f3d8cb524262c38 (diff)
download	upstream-edc6ce204847182dcf2fb2122a99a0de4f5dbc4f.tar.gz upstream-edc6ce204847182dcf2fb2122a99a0de4f5dbc4f.tar.bz2 upstream-edc6ce204847182dcf2fb2122a99a0de4f5dbc4f.zip

swconfig: add copyright for Martin Mares

Signed-off-by: Martin Mares <mj@ucw.cz> git-svn-id: svn://svn.openwrt.org/openwrt/trunk@19642 3c298f89-4303-0410-b956-a3cf2f4a3e73

Diffstat (limited to 'package/swconfig/src/cli.c')

-rw-r--r--

package/swconfig/src/cli.c

1 files changed, 1 insertions, 0 deletions

# RGB Lighting QMK has the ability to control RGB LEDs attached to your keyboard. This is commonly called *underglow*, due to the LEDs often being mounted on the bottom of the keyboard, producing a nice diffused effect when combined with a translucent case. ![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/3774a7fcdab5544fc787f4c200be05fcd417e31f/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg) Some keyboards come with RGB LEDs preinstalled. Others must have them installed after the fact. See the [Hardware Modification](#hardware-modification) section for information on adding RGB lighting to your keyboard. Currently QMK supports the following addressable LEDs on AVR microcontrollers (however, the white LED in RGBW variants is not supported): * WS2811, WS2812, WS2812B, WS2812C, etc. * SK6812, SK6812MINI, SK6805 These LEDs are called "addressable" because instead of using a wire per color, each LED contains a small microchip that understands a special protocol sent over a single wire. The chip passes on the remaining data to the next LED, allowing them to be chained together. In this way, you can easily control the color of the individual LEDs. ## Usage On keyboards with onboard RGB LEDs, it is usually enabled by default. If it is not working for you, check that your `rules.mk` includes the following: ```make RGBLIGHT_ENABLE = yes ``` At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these. |Define |Description | |------------|---------------------------------------------| |`RGB_DI_PIN`|The pin connected to the data pin of the LEDs| |`RGBLED_NUM`|The number of LEDs connected | Then you should be able to use the keycodes below to change the RGB lighting to your liking. ### Color Selection QMK uses [Hue, Saturation, and Value](https://en.wikipedia.org/wiki/HSL_and_HSV) to select colors rather than RGB. The color wheel below demonstrates how this works. <img src="gitbook/images/color-wheel.svg" alt="HSV Color Wheel" width="250"/> Changing the **Hue** cycles around the circle. Changing the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color. Changing the **Value** sets the overall brightness. ## Keycodes |Key |Aliases |Description | |-------------------|----------|--------------------------------------------------------------------| |`RGB_TOG` | |Toggle RGB lighting on or off | |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| |`RGB_HUI` | |Increase hue | |`RGB_HUD` | |Decrease hue | |`RGB_SAI` | |Increase saturation | |`RGB_SAD` | |Decrease saturation | |`RGB_VAI` | |Increase value (brightness) | |`RGB_VAD` | |Decrease value (brightness) | |`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode | |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode | |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode | |`RGB_MODE_SWIRL` |`RGB_M_SW`|Swirl animation mode | |`RGB_MODE_SNAKE` |`RGB_M_SN`|Snake animation mode | |`RGB_MODE_KNIGHT` |`RGB_M_K` |"Knight Rider" animation mode | |`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode | |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode | ?> For backwards compatibility, `RGB_SMOD` is another alias of `RGB_MOD`. ## Configuration Your RGB lighting can be configured by placing these `#define`s in your `config.h`: |Define |Default |Description | |---------------------|-------------|-----------------------------------------------------------------------------| |`RGBLIGHT_HUE_STEP` |`10` |The number of steps to cycle through the hue by | |`RGBLIGHT_SAT_STEP` |`17` |The number of steps to increment the saturation by | |`RGBLIGHT_VAL_STEP` |`17` |The number of steps to increment the brightness by | |`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level | |`RGBLIGHT_SLEEP` |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep| ## Animations Not only can this lighting be whatever color you want, if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal: |Mode number symbol |Additional number |Description | |-----------------------------|-------------------|---------------------------------------| |`RGBLIGHT_MODE_STATIC_LIGHT` | *None* |Solid color (this mode is always enabled) | |`RGBLIGHT_MODE_BREATHING` | 0,1,2,3 |Solid color breathing | |`RGBLIGHT_MODE_RAINBOW_MOOD` | 0,1,2 |Cycling rainbow | |`RGBLIGHT_MODE_RAINBOW_SWIRL`| 0,1,2,3,4,5 |Swirling rainbow | |`RGBLIGHT_MODE_SNAKE` | 0,1,2,3,4,5 |Snake | |`RGBLIGHT_MODE_KNIGHT` | 0,1,2 |Knight | |`RGBLIGHT_MODE_CHRISTMAS` | *None* |Christmas | |`RGBLIGHT_MODE_STATIC_GRADIENT`| 0,1,..,9 |Static gradient | |`RGBLIGHT_MODE_RGB_TEST` | *None* |RGB Test | |`RGBLIGHT_MODE_ALTERNATING` | *None* |Alternating | Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration. Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol. The following options can be used to tweak the various animations: |Define |Default |Description | |------------------------------------|-------------|-------------------------------------------------------------------------------------| |`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|If defined, enable breathing animation mode. | |`RGBLIGHT_EFFECT_RAINBOW_MOOD` |*Not defined*|If defined, enable rainbow mood animation mode. | |`RGBLIGHT_EFFECT_RAINBOW_SWIRL` |*Not defined*|If defined, enable rainbow swirl animation mode. | |`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|If defined, enable snake animation mode. | |`RGBLIGHT_EFFECT_KNIGHT` |*Not defined*|If defined, enable knight animation mode. | |`RGBLIGHT_EFFECT_CHRISTMAS` |*Not defined*|If defined, enable christmas animation mode. | |`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|If defined, enable static gradient mode. | |`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|If defined, enable RGB test animation mode. | |`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|If defined, enable alternating animation mode. | |`RGBLIGHT_ANIMATIONS` |*Not defined*|If defined, enables all additional animation modes |


context:
space:
mode: