aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <[email protected]>2024-04-11 14:14:02 +1000
committerGitHub <[email protected]>2024-04-11 14:14:02 +1000
commit52d3ef0fe4bd860420893e364be36c155f4ba300 (patch)
treee7f809d9a44d5bacd85af3ed25fbafcc4aaf34f6 /docs
parent25f608c1b437060e8c9b451ed81c7e37a2531284 (diff)
downloadqmk_firmware-52d3ef0fe4bd860420893e364be36c155f4ba300.tar.gz
qmk_firmware-52d3ef0fe4bd860420893e364be36c155f4ba300.zip
Add new set of keycodes for LED Matrix (#23432)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_led_matrix.md21
-rw-r--r--docs/keycodes.md16
2 files changed, 27 insertions, 10 deletions
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md
index 3a3a9dbf84..83357ab14e 100644
--- a/docs/feature_led_matrix.md
+++ b/docs/feature_led_matrix.md
@@ -217,16 +217,17 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
## Keycodes :id=keycodes
-All LED matrix keycodes are currently shared with the [Backlight feature](feature_backlight.md).
-
-| Key | Aliases | Description |
-|-------------------------|-----------|-------------------------------|
-| `QK_BACKLIGHT_TOGGLE` | `BL_TOGG` | Toggle LED Matrix on or off |
-| `QK_BACKLIGHT_STEP` | `BL_STEP` | Cycle through modes |
-| `QK_BACKLIGHT_ON` | `BL_ON` | Turn on LED Matrix |
-| `QK_BACKLIGHT_OFF` | `BL_OFF` | Turn off LED Matrix |
-| `QK_BACKLIGHT_UP` | `BL_UP` | Increase the brightness level |
-| `QK_BACKLIGHT_DOWN` | `BL_DOWN` | Decrease the brightness level |
+|Key |Aliases |Description |
+|-------------------------------|---------|-----------------------------------|
+|`QK_LED_MATRIX_ON` |`LM_ON` |Turn on LED Matrix |
+|`QK_LED_MATRIX_OFF` |`LM_OFF` |Turn off LED Matrix |
+|`QK_LED_MATRIX_TOGGLE` |`LM_TOGG`|Toggle LED Matrix on or off |
+|`QK_LED_MATRIX_MODE_NEXT` |`LM_NEXT`|Cycle through animations |
+|`QK_LED_MATRIX_MODE_PREVIOUS` |`LM_PREV`|Cycle through animations in reverse|
+|`QK_LED_MATRIX_BRIGHTNESS_UP` |`LM_BRIU`|Increase the brightness level |
+|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |
+|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |
+|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |
## LED Matrix Effects :id=led-matrix-effects
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 65762234a4..9d722216a9 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -398,6 +398,22 @@ See also: [Leader Key](feature_leader_key.md)
|---------|------------------------|
|`QK_LEAD`|Begins a leader sequence|
+## LED Matrix :id=led-matrix
+
+See also: [LED Matrix](feature_led_matrix.md)
+
+|Key |Aliases |Description |
+|-------------------------------|---------|-----------------------------------|
+|`QK_LED_MATRIX_ON` |`LM_ON` |Turn on LED Matrix |
+|`QK_LED_MATRIX_OFF` |`LM_OFF` |Turn off LED Matrix |
+|`QK_LED_MATRIX_TOGGLE` |`LM_TOGG`|Toggle LED Matrix on or off |
+|`QK_LED_MATRIX_MODE_NEXT` |`LM_NEXT`|Cycle through animations |
+|`QK_LED_MATRIX_MODE_PREVIOUS` |`LM_PREV`|Cycle through animations in reverse|
+|`QK_LED_MATRIX_BRIGHTNESS_UP` |`LM_BRIU`|Increase the brightness level |
+|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |
+|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |
+|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |
+
## Magic Keycodes :id=magic-keycodes
See also: [Magic Keycodes](keycodes_magic.md)