summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorClownFish <177758267+clownfish-og@users.noreply.github.com>2025-04-17 12:23:16 -0400
committerGitHub <noreply@github.com>2025-04-17 10:23:16 -0600
commit76413592402ae2ede4d9deef0f7d91bf73026d33 (patch)
treeee604da38e3a6d2c582cf3f3ef30c95111f37b7c /docs
parente83b709169e7f19cd79f44066ba7faf17ecdd952 (diff)
[Docs] Unify lighting step descriptions (#25167)
unify lighting step descriptions and defaults across docs
Diffstat (limited to 'docs')
-rw-r--r--docs/features/led_matrix.md2
-rw-r--r--docs/features/rgb_matrix.md4
-rw-r--r--docs/features/rgblight.md6
-rw-r--r--docs/reference_info_json.md22
4 files changed, 20 insertions, 14 deletions
diff --git a/docs/features/led_matrix.md b/docs/features/led_matrix.md
index 756cc11e2b..113b13f03b 100644
--- a/docs/features/led_matrix.md
+++ b/docs/features/led_matrix.md
@@ -227,6 +227,8 @@ For inspiration and examples, check out the built-in effects under `quantum/led_
227#define LED_MATRIX_DEFAULT_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set 227#define LED_MATRIX_DEFAULT_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set
228#define LED_MATRIX_DEFAULT_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set 228#define LED_MATRIX_DEFAULT_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
229#define LED_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set 229#define LED_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set
230#define LED_MATRIX_VAL_STEP 8 // The value by which to increment the brightness per adjustment action
231#define LED_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action
230#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set 232#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
231#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right. 233#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
232 // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR 234 // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
diff --git a/docs/features/rgb_matrix.md b/docs/features/rgb_matrix.md
index 0e53ce9c35..a22f931f1b 100644
--- a/docs/features/rgb_matrix.md
+++ b/docs/features/rgb_matrix.md
@@ -378,6 +378,10 @@ These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master
378#define RGB_MATRIX_DEFAULT_SAT 255 // Sets the default saturation value, if none has been set 378#define RGB_MATRIX_DEFAULT_SAT 255 // Sets the default saturation value, if none has been set
379#define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set 379#define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
380#define RGB_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set 380#define RGB_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set
381#define RGB_MATRIX_HUE_STEP 8 // The value by which to increment the hue per adjustment action
382#define RGB_MATRIX_SAT_STEP 16 // The value by which to increment the saturation per adjustment action
383#define RGB_MATRIX_VAL_STEP 16 // The value by which to increment the brightness per adjustment action
384#define RGB_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action
381#define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set 385#define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
382#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right. 386#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
383 // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR 387 // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
diff --git a/docs/features/rgblight.md b/docs/features/rgblight.md
index 4322fe796e..43e3781f8d 100644
--- a/docs/features/rgblight.md
+++ b/docs/features/rgblight.md
@@ -97,9 +97,9 @@ Your RGB lighting can be configured by placing these `#define`s in your `config.
97 97
98|Define |Default |Description | 98|Define |Default |Description |
99|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------| 99|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|
100|`RGBLIGHT_HUE_STEP` |`8` |The number of steps to cycle through the hue by | 100|`RGBLIGHT_HUE_STEP` |`8` |The value by which to increment the hue per adjustment action |
101|`RGBLIGHT_SAT_STEP` |`17` |The number of steps to increment the saturation by | 101|`RGBLIGHT_SAT_STEP` |`17` |The value by which to increment the saturation per adjustment action |
102|`RGBLIGHT_VAL_STEP` |`17` |The number of steps to increment the brightness by | 102|`RGBLIGHT_VAL_STEP` |`17` |The value by which to increment the brightness per adjustment action |
103|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level | 103|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level |
104|`RGBLIGHT_SLEEP` |*Not defined* |If defined, the RGB lighting will be switched off when the host goes to sleep | 104|`RGBLIGHT_SLEEP` |*Not defined* |If defined, the RGB lighting will be switched off when the host goes to sleep |
105|`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added | 105|`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added |
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index 29b999c32e..0f8f680b55 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -413,7 +413,7 @@ Configures the [LED Matrix](features/led_matrix) feature.
413 * Default: `16` 413 * Default: `16`
414 * `led_process_limit` <Badge type="info">Number</Badge> 414 * `led_process_limit` <Badge type="info">Number</Badge>
415 * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness). 415 * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).
416 * Default: `led_count / 5` 416 * Default: `(led_count + 4) / 5`
417 * `max_brightness` <Badge type="info">Number</Badge> 417 * `max_brightness` <Badge type="info">Number</Badge>
418 * The maximum value which brightness is scaled to, from 0 to 255. 418 * The maximum value which brightness is scaled to, from 0 to 255.
419 * Default: `255` 419 * Default: `255`
@@ -424,7 +424,7 @@ Configures the [LED Matrix](features/led_matrix) feature.
424 * Turn off the LEDs when the host goes to sleep. 424 * Turn off the LEDs when the host goes to sleep.
425 * Default: `false` 425 * Default: `false`
426 * `speed_steps` <Badge type="info">Number</Badge> 426 * `speed_steps` <Badge type="info">Number</Badge>
427 * The number of speed adjustment steps. 427 * The value by which to increment the speed.
428 * Default: `16` 428 * Default: `16`
429 * `split_count` <Badge type="info">Array: Number</Badge> 429 * `split_count` <Badge type="info">Array: Number</Badge>
430 * For split keyboards, the number of LEDs on each half. 430 * For split keyboards, the number of LEDs on each half.
@@ -433,7 +433,7 @@ Configures the [LED Matrix](features/led_matrix) feature.
433 * The LED activity timeout in milliseconds. 433 * The LED activity timeout in milliseconds.
434 * Default: `0` (no timeout) 434 * Default: `0` (no timeout)
435 * `val_steps` <Badge type="info">Number</Badge> 435 * `val_steps` <Badge type="info">Number</Badge>
436 * The number of brightness adjustment steps. 436 * The value by which to increment the brightness.
437 * Default: `8` 437 * Default: `8`
438 438
439## Matrix {#matrix} 439## Matrix {#matrix}
@@ -549,7 +549,7 @@ Configures the [RGB Lighting](features/rgblight) feature.
549 } 549 }
550 ``` 550 ```
551 * `brightness_steps` <Badge type="info">Number</Badge> 551 * `brightness_steps` <Badge type="info">Number</Badge>
552 * The number of brightness adjustment steps. 552 * The value by which to increment the brightness.
553 * Default: `17` 553 * Default: `17`
554 * `default` 554 * `default`
555 * `animation` <Badge type="info">String</Badge> 555 * `animation` <Badge type="info">String</Badge>
@@ -574,7 +574,7 @@ Configures the [RGB Lighting](features/rgblight) feature.
574 * The driver to use. Must be one of `apa102`, `custom`, `ws2812`. 574 * The driver to use. Must be one of `apa102`, `custom`, `ws2812`.
575 * Default: `"ws2812"` 575 * Default: `"ws2812"`
576 * `hue_steps` <Badge type="info">Number</Badge> 576 * `hue_steps` <Badge type="info">Number</Badge>
577 * The number of hue adjustment steps. 577 * The value by which to increment the hue.
578 * Default: `8` 578 * Default: `8`
579 * `layers` 579 * `layers`
580 * `blink` <Badge type="info">Boolean</Badge> 580 * `blink` <Badge type="info">Boolean</Badge>
@@ -593,7 +593,7 @@ Configures the [RGB Lighting](features/rgblight) feature.
593 * The maximum value which the HSV "V" component is scaled to, from 0 to 255. 593 * The maximum value which the HSV "V" component is scaled to, from 0 to 255.
594 * Default: `255` 594 * Default: `255`
595 * `saturation_steps` <Badge type="info">Number</Badge> 595 * `saturation_steps` <Badge type="info">Number</Badge>
596 * The number of saturation adjustment steps. 596 * The value by which to increment the suturation.
597 * Default: `17` 597 * Default: `17`
598 * `sleep` <Badge type="info">Boolean</Badge> 598 * `sleep` <Badge type="info">Boolean</Badge>
599 * Turn off the LEDs when the host goes to sleep. 599 * Turn off the LEDs when the host goes to sleep.
@@ -645,7 +645,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
645 * `driver` <Badge type="info">String</Badge> <Badge>Required</Badge> 645 * `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
646 * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3236`, `is31fl3729`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`. 646 * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3236`, `is31fl3729`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`.
647 * `hue_steps` <Badge type="info">Number</Badge> 647 * `hue_steps` <Badge type="info">Number</Badge>
648 * The number of hue adjustment steps. 648 * The value by which to increment the hue.
649 * Default: `8` 649 * Default: `8`
650 * `layout` <Badge type="info">Array: Object</Badge> <Badge>Required</Badge> 650 * `layout` <Badge type="info">Array: Object</Badge> <Badge>Required</Badge>
651 * List of LED configuration dictionaries. Each dictionary contains: 651 * List of LED configuration dictionaries. Each dictionary contains:
@@ -664,7 +664,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
664 * Default: `16` 664 * Default: `16`
665 * `led_process_limit` <Badge type="info">Number</Badge> 665 * `led_process_limit` <Badge type="info">Number</Badge>
666 * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness). 666 * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).
667 * Default: `led_count / 5` 667 * Default: `(led_count + 4) / 5`
668 * `max_brightness` <Badge type="info">Number</Badge> 668 * `max_brightness` <Badge type="info">Number</Badge>
669 * The maximum value which the HSV "V" component is scaled to, from 0 to 255. 669 * The maximum value which the HSV "V" component is scaled to, from 0 to 255.
670 * Default: `255` 670 * Default: `255`
@@ -672,13 +672,13 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
672 * Animations react to keyup instead of keydown. 672 * Animations react to keyup instead of keydown.
673 * Default: `false` 673 * Default: `false`
674 * `sat_steps` <Badge type="info">Number</Badge> 674 * `sat_steps` <Badge type="info">Number</Badge>
675 * The number of saturation adjustment steps. 675 * The value by which to increment the saturation.
676 * Default: `16` 676 * Default: `16`
677 * `sleep` <Badge type="info">Boolean</Badge> 677 * `sleep` <Badge type="info">Boolean</Badge>
678 * Turn off the LEDs when the host goes to sleep. 678 * Turn off the LEDs when the host goes to sleep.
679 * Default: `false` 679 * Default: `false`
680 * `speed_steps` <Badge type="info">Number</Badge> 680 * `speed_steps` <Badge type="info">Number</Badge>
681 * The number of speed adjustment steps. 681 * The value by which to increment the speed.
682 * Default: `16` 682 * Default: `16`
683 * `split_count` <Badge type="info">Array: Number</Badge> 683 * `split_count` <Badge type="info">Array: Number</Badge>
684 * For split keyboards, the number of LEDs on each half. 684 * For split keyboards, the number of LEDs on each half.
@@ -687,7 +687,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
687 * The LED activity timeout in milliseconds. 687 * The LED activity timeout in milliseconds.
688 * Default: `0` (no timeout) 688 * Default: `0` (no timeout)
689 * `val_steps` <Badge type="info">Number</Badge> 689 * `val_steps` <Badge type="info">Number</Badge>
690 * The number of brightness adjustment steps. 690 * The value by which to increment the brightness.
691 * Default: `16` 691 * Default: `16`
692 692
693## Secure {#secure} 693## Secure {#secure}