summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2022-11-06 08:11:59 +1100
committerGitHub <noreply@github.com>2022-11-06 08:11:59 +1100
commit219afaba42e6b4384f578977eadbb71a03383ecc (patch)
tree78f7c30b94d9ade9fb84821ed3a3ce463a3afa19 /docs
parent352beeac2f62edf1f3288a2a7aa0f1e3bafa7dfd (diff)
Reworked backlight keycodes. (#18961)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_backlight.md18
-rw-r--r--docs/feature_led_matrix.md20
-rw-r--r--docs/keycodes.md18
3 files changed, 28 insertions, 28 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index 79782cf564..24057c608f 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -16,15 +16,15 @@ BACKLIGHT_ENABLE = yes
Once enabled, the following keycodes below can be used to change the backlight level.
-|Key |Description |
-|---------|-----------------------------------|
-|`BL_TOGG`|Turn the backlight on or off |
-|`BL_STEP`|Cycle through backlight levels |
-|`BL_ON` |Set the backlight to max brightness|
-|`BL_OFF` |Turn the backlight off |
-|`BL_INC` |Increase the backlight level |
-|`BL_DEC` |Decrease the backlight level |
-|`BL_BRTG`|Toggle backlight breathing |
+| Key | Aliases | Description |
+|---------------------------------|-----------|-------------------------------------|
+| `QK_BACKLIGHT_TOGGLE` | `BL_TOGG` | Turn the backlight on or off |
+| `QK_BACKLIGHT_STEP` | `BL_STEP` | Cycle through backlight levels |
+| `QK_BACKLIGHT_ON` | `BL_ON` | Set the backlight to max brightness |
+| `QK_BACKLIGHT_OFF` | `BL_OFF` | Turn the backlight off |
+| `QK_BACKLIGHT_UP` | `BL_UP` | Increase the backlight level |
+| `QK_BACKLIGHT_DOWN` | `BL_DOWN` | Decrease the backlight level |
+| `QK_BACKLIGHT_TOGGLE_BREATHING` | `BL_BRTG` | Toggle backlight breathing |
## Functions :id=functions
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md
index 280db2a383..b468507424 100644
--- a/docs/feature_led_matrix.md
+++ b/docs/feature_led_matrix.md
@@ -199,7 +199,7 @@ x = 224 / (NUMBER_OF_COLS - 1) * COL_POSITION
y = 64 / (NUMBER_OF_ROWS - 1) * ROW_POSITION
```
-Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.
+Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.
As mentioned earlier, the center of the keyboard by default is expected to be `{ 112, 32 }`, but this can be changed if you want to more accurately calculate the LED's physical `{ x, y }` positions. Keyboard designers can implement `#define LED_MATRIX_CENTER { 112, 32 }` in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the `{ x, y }` values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.
@@ -221,14 +221,14 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
All LED matrix keycodes are currently shared with the [Backlight feature](feature_backlight.md).
-|Key |Description |
-|---------|-----------------------------|
-|`BL_TOGG`|Toggle LED Matrix on or off |
-|`BL_STEP`|Cycle through modes |
-|`BL_ON` |Turn on LED Matrix |
-|`BL_OFF` |Turn off LED Matrix |
-|`BL_INC` |Increase the brightness level|
-|`BL_DEC` |Decrease the brightness level|
+| 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 |
## LED Matrix Effects :id=led-matrix-effects
@@ -439,7 +439,7 @@ Where `28` is an unused index from `eeconfig.h`.
### Indicators :id=indicators
-If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, you can use the `led_matrix_indicators_kb` or `led_matrix_indicators_user` function for that:
+If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, you can use the `led_matrix_indicators_kb` or `led_matrix_indicators_user` function for that:
```c
bool led_matrix_indicators_kb(void) {
if (!led_matrix_indicators_user()) {
diff --git a/docs/keycodes.md b/docs/keycodes.md
index d185fe38c0..03ac181a44 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -278,15 +278,15 @@ See also: [Autocorrect](feature_autocorrect.md)
See also: [Backlighting](feature_backlight.md)
-|Key |Description |
-|---------|------------------------------------------|
-|`BL_TOGG`|Turn the backlight on or off |
-|`BL_STEP`|Cycle through backlight levels |
-|`BL_ON` |Set the backlight to max brightness |
-|`BL_OFF` |Turn the backlight off |
-|`BL_INC` |Increase the backlight level |
-|`BL_DEC` |Decrease the backlight level |
-|`BL_BRTG`|Toggle backlight breathing |
+| Key | Aliases | Description |
+|---------------------------------|-----------|-------------------------------------|
+| `QK_BACKLIGHT_TOGGLE` | `BL_TOGG` | Turn the backlight on or off |
+| `QK_BACKLIGHT_STEP` | `BL_STEP` | Cycle through backlight levels |
+| `QK_BACKLIGHT_ON` | `BL_ON` | Set the backlight to max brightness |
+| `QK_BACKLIGHT_OFF` | `BL_OFF` | Turn the backlight off |
+| `QK_BACKLIGHT_UP` | `BL_UP` | Increase the backlight level |
+| `QK_BACKLIGHT_DOWN` | `BL_DOWN` | Decrease the backlight level |
+| `QK_BACKLIGHT_TOGGLE_BREATHING` | `BL_BRTG` | Toggle backlight breathing |
## Bluetooth :id=bluetooth