diff options
Diffstat (limited to 'docs/feature_rgb_matrix.md')
| -rw-r--r-- | docs/feature_rgb_matrix.md | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index b2850c3cf..5695acc50 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
| @@ -107,7 +107,7 @@ Where `X_Y` is the location of the LED in the matrix defined by [the datasheet]( | |||
| 107 | 107 | ||
| 108 | --- | 108 | --- |
| 109 | 109 | ||
| 110 | ### WS2812 (AVR only) | 110 | ### WS2812 |
| 111 | 111 | ||
| 112 | There is basic support for addressable RGB matrix lighting with a WS2811/WS2812{a,b,c} addressable LED strand. To enable it, add this to your `rules.mk`: | 112 | There is basic support for addressable RGB matrix lighting with a WS2811/WS2812{a,b,c} addressable LED strand. To enable it, add this to your `rules.mk`: |
| 113 | 113 | ||
| @@ -173,16 +173,20 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{ | |||
| 173 | 173 | ||
| 174 | All RGB keycodes are currently shared with the RGBLIGHT system: | 174 | All RGB keycodes are currently shared with the RGBLIGHT system: |
| 175 | 175 | ||
| 176 | * `RGB_TOG` - toggle | 176 | |Key |Aliases |Description | |
| 177 | * `RGB_MOD` - cycle through modes | 177 | |-------------------|----------|--------------------------------------------------------------------------------------| |
| 178 | * `RGB_HUI` - increase hue | 178 | |`RGB_TOG` | |Toggle RGB lighting on or off | |
| 179 | * `RGB_HUD` - decrease hue | 179 | |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | |
| 180 | * `RGB_SAI` - increase saturation | 180 | |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held | |
| 181 | * `RGB_SAD` - decrease saturation | 181 | |`RGB_HUI` | |Increase hue, decrease hue when Shift is held | |
| 182 | * `RGB_VAI` - increase value | 182 | |`RGB_HUD` | |Decrease hue, increase hue when Shift is held | |
| 183 | * `RGB_VAD` - decrease value | 183 | |`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held | |
| 184 | * `RGB_SPI` - increase speed effect (no EEPROM support) | 184 | |`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held | |
| 185 | * `RGB_SPD` - decrease speed effect (no EEPROM support) | 185 | |`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held | |
| 186 | |`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held | | ||
| 187 | |`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held| | ||
| 188 | |`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held| | ||
| 189 | |||
| 186 | * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system | 190 | * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system |
| 187 | 191 | ||
| 188 | ## RGB Matrix Effects | 192 | ## RGB Matrix Effects |
| @@ -282,7 +286,7 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con | |||
| 282 | 286 | ||
| 283 | ## Custom RGB Matrix Effects | 287 | ## Custom RGB Matrix Effects |
| 284 | 288 | ||
| 285 | By setting `RGB_MATRIX_CUSTOM_USER` (and/or `RGB_MATRIX_CUSTOM_KB`) in `rule.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files. | 289 | By setting `RGB_MATRIX_CUSTOM_USER` (and/or `RGB_MATRIX_CUSTOM_KB`) in `rules.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files. |
| 286 | 290 | ||
| 287 | To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks something like this: | 291 | To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks something like this: |
| 288 | 292 | ||
