From 76413592402ae2ede4d9deef0f7d91bf73026d33 Mon Sep 17 00:00:00 2001 From: ClownFish <177758267+clownfish-og@users.noreply.github.com> Date: Thu, 17 Apr 2025 12:23:16 -0400 Subject: [PATCH] [Docs] Unify lighting step descriptions (#25167) unify lighting step descriptions and defaults across docs --- docs/features/led_matrix.md | 2 ++ docs/features/rgb_matrix.md | 4 ++++ docs/features/rgblight.md | 6 +++--- docs/reference_info_json.md | 22 +++++++++++----------- 4 files changed, 20 insertions(+), 14 deletions(-) diff --git a/docs/features/led_matrix.md b/docs/features/led_matrix.md index 756cc11e2be..113b13f03b6 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_ #define LED_MATRIX_DEFAULT_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set #define LED_MATRIX_DEFAULT_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set #define LED_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set +#define LED_MATRIX_VAL_STEP 8 // The value by which to increment the brightness per adjustment action +#define LED_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action #define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set #define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right. // 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 0e53ce9c35a..a22f931f1be 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 #define RGB_MATRIX_DEFAULT_SAT 255 // Sets the default saturation value, if none has been set #define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set #define RGB_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set +#define RGB_MATRIX_HUE_STEP 8 // The value by which to increment the hue per adjustment action +#define RGB_MATRIX_SAT_STEP 16 // The value by which to increment the saturation per adjustment action +#define RGB_MATRIX_VAL_STEP 16 // The value by which to increment the brightness per adjustment action +#define RGB_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action #define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set #define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right. // 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 4322fe796e7..43e3781f8d4 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. |Define |Default |Description | |---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------| -|`RGBLIGHT_HUE_STEP` |`8` |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_HUE_STEP` |`8` |The value by which to increment the hue per adjustment action | +|`RGBLIGHT_SAT_STEP` |`17` |The value by which to increment the saturation per adjustment action | +|`RGBLIGHT_VAL_STEP` |`17` |The value by which to increment the brightness per adjustment action | |`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 | |`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 29b999c32e8..0f8f680b551 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. * Default: `16` * `led_process_limit` Number * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness). - * Default: `led_count / 5` + * Default: `(led_count + 4) / 5` * `max_brightness` Number * The maximum value which brightness is scaled to, from 0 to 255. * Default: `255` @@ -424,7 +424,7 @@ Configures the [LED Matrix](features/led_matrix) feature. * Turn off the LEDs when the host goes to sleep. * Default: `false` * `speed_steps` Number - * The number of speed adjustment steps. + * The value by which to increment the speed. * Default: `16` * `split_count` Array: Number * For split keyboards, the number of LEDs on each half. @@ -433,7 +433,7 @@ Configures the [LED Matrix](features/led_matrix) feature. * The LED activity timeout in milliseconds. * Default: `0` (no timeout) * `val_steps` Number - * The number of brightness adjustment steps. + * The value by which to increment the brightness. * Default: `8` ## Matrix {#matrix} @@ -549,7 +549,7 @@ Configures the [RGB Lighting](features/rgblight) feature. } ``` * `brightness_steps` Number - * The number of brightness adjustment steps. + * The value by which to increment the brightness. * Default: `17` * `default` * `animation` String @@ -574,7 +574,7 @@ Configures the [RGB Lighting](features/rgblight) feature. * The driver to use. Must be one of `apa102`, `custom`, `ws2812`. * Default: `"ws2812"` * `hue_steps` Number - * The number of hue adjustment steps. + * The value by which to increment the hue. * Default: `8` * `layers` * `blink` Boolean @@ -593,7 +593,7 @@ Configures the [RGB Lighting](features/rgblight) feature. * The maximum value which the HSV "V" component is scaled to, from 0 to 255. * Default: `255` * `saturation_steps` Number - * The number of saturation adjustment steps. + * The value by which to increment the suturation. * Default: `17` * `sleep` Boolean * Turn off the LEDs when the host goes to sleep. @@ -645,7 +645,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature. * `driver` String Required * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3236`, `is31fl3729`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`. * `hue_steps` Number - * The number of hue adjustment steps. + * The value by which to increment the hue. * Default: `8` * `layout` Array: Object Required * List of LED configuration dictionaries. Each dictionary contains: @@ -664,7 +664,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature. * Default: `16` * `led_process_limit` Number * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness). - * Default: `led_count / 5` + * Default: `(led_count + 4) / 5` * `max_brightness` Number * The maximum value which the HSV "V" component is scaled to, from 0 to 255. * Default: `255` @@ -672,13 +672,13 @@ Configures the [RGB Matrix](features/rgb_matrix) feature. * Animations react to keyup instead of keydown. * Default: `false` * `sat_steps` Number - * The number of saturation adjustment steps. + * The value by which to increment the saturation. * Default: `16` * `sleep` Boolean * Turn off the LEDs when the host goes to sleep. * Default: `false` * `speed_steps` Number - * The number of speed adjustment steps. + * The value by which to increment the speed. * Default: `16` * `split_count` Array: Number * For split keyboards, the number of LEDs on each half. @@ -687,7 +687,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature. * The LED activity timeout in milliseconds. * Default: `0` (no timeout) * `val_steps` Number - * The number of brightness adjustment steps. + * The value by which to increment the brightness. * Default: `16` ## Secure {#secure}