mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-05-30 04:53:20 +00:00
[Docs] Unify lighting step descriptions (#25167)
unify lighting step descriptions and defaults across docs
This commit is contained in:
parent
e83b709169
commit
7641359240
@ -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_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_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_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_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.
|
#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
|
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
||||||
|
@ -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_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_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_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_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.
|
#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
|
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
||||||
|
@ -97,9 +97,9 @@ Your RGB lighting can be configured by placing these `#define`s in your `config.
|
|||||||
|
|
||||||
|Define |Default |Description |
|
|Define |Default |Description |
|
||||||
|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
||||||
|`RGBLIGHT_HUE_STEP` |`8` |The number of steps to cycle through the hue by |
|
|`RGBLIGHT_HUE_STEP` |`8` |The value by which to increment the hue per adjustment action |
|
||||||
|`RGBLIGHT_SAT_STEP` |`17` |The number of steps to increment the saturation by |
|
|`RGBLIGHT_SAT_STEP` |`17` |The value by which to increment the saturation per adjustment action |
|
||||||
|`RGBLIGHT_VAL_STEP` |`17` |The number of steps to increment the brightness by |
|
|`RGBLIGHT_VAL_STEP` |`17` |The value by which to increment the brightness per adjustment action |
|
||||||
|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level |
|
|`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_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 |
|
|`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added |
|
||||||
|
@ -413,7 +413,7 @@ Configures the [LED Matrix](features/led_matrix) feature.
|
|||||||
* Default: `16`
|
* Default: `16`
|
||||||
* `led_process_limit` <Badge type="info">Number</Badge>
|
* `led_process_limit` <Badge type="info">Number</Badge>
|
||||||
* Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).
|
* 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` <Badge type="info">Number</Badge>
|
* `max_brightness` <Badge type="info">Number</Badge>
|
||||||
* The maximum value which brightness is scaled to, from 0 to 255.
|
* The maximum value which brightness is scaled to, from 0 to 255.
|
||||||
* Default: `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.
|
* Turn off the LEDs when the host goes to sleep.
|
||||||
* Default: `false`
|
* Default: `false`
|
||||||
* `speed_steps` <Badge type="info">Number</Badge>
|
* `speed_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of speed adjustment steps.
|
* The value by which to increment the speed.
|
||||||
* Default: `16`
|
* Default: `16`
|
||||||
* `split_count` <Badge type="info">Array: Number</Badge>
|
* `split_count` <Badge type="info">Array: Number</Badge>
|
||||||
* For split keyboards, the number of LEDs on each half.
|
* 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.
|
* The LED activity timeout in milliseconds.
|
||||||
* Default: `0` (no timeout)
|
* Default: `0` (no timeout)
|
||||||
* `val_steps` <Badge type="info">Number</Badge>
|
* `val_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of brightness adjustment steps.
|
* The value by which to increment the brightness.
|
||||||
* Default: `8`
|
* Default: `8`
|
||||||
|
|
||||||
## Matrix {#matrix}
|
## Matrix {#matrix}
|
||||||
@ -549,7 +549,7 @@ Configures the [RGB Lighting](features/rgblight) feature.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
* `brightness_steps` <Badge type="info">Number</Badge>
|
* `brightness_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of brightness adjustment steps.
|
* The value by which to increment the brightness.
|
||||||
* Default: `17`
|
* Default: `17`
|
||||||
* `default`
|
* `default`
|
||||||
* `animation` <Badge type="info">String</Badge>
|
* `animation` <Badge type="info">String</Badge>
|
||||||
@ -574,7 +574,7 @@ Configures the [RGB Lighting](features/rgblight) feature.
|
|||||||
* The driver to use. Must be one of `apa102`, `custom`, `ws2812`.
|
* The driver to use. Must be one of `apa102`, `custom`, `ws2812`.
|
||||||
* Default: `"ws2812"`
|
* Default: `"ws2812"`
|
||||||
* `hue_steps` <Badge type="info">Number</Badge>
|
* `hue_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of hue adjustment steps.
|
* The value by which to increment the hue.
|
||||||
* Default: `8`
|
* Default: `8`
|
||||||
* `layers`
|
* `layers`
|
||||||
* `blink` <Badge type="info">Boolean</Badge>
|
* `blink` <Badge type="info">Boolean</Badge>
|
||||||
@ -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.
|
* The maximum value which the HSV "V" component is scaled to, from 0 to 255.
|
||||||
* Default: `255`
|
* Default: `255`
|
||||||
* `saturation_steps` <Badge type="info">Number</Badge>
|
* `saturation_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of saturation adjustment steps.
|
* The value by which to increment the suturation.
|
||||||
* Default: `17`
|
* Default: `17`
|
||||||
* `sleep` <Badge type="info">Boolean</Badge>
|
* `sleep` <Badge type="info">Boolean</Badge>
|
||||||
* Turn off the LEDs when the host goes to sleep.
|
* Turn off the LEDs when the host goes to sleep.
|
||||||
@ -645,7 +645,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
|
|||||||
* `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
|
* `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
|
||||||
* The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3236`, `is31fl3729`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`.
|
* 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` <Badge type="info">Number</Badge>
|
* `hue_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of hue adjustment steps.
|
* The value by which to increment the hue.
|
||||||
* Default: `8`
|
* Default: `8`
|
||||||
* `layout` <Badge type="info">Array: Object</Badge> <Badge>Required</Badge>
|
* `layout` <Badge type="info">Array: Object</Badge> <Badge>Required</Badge>
|
||||||
* List of LED configuration dictionaries. Each dictionary contains:
|
* List of LED configuration dictionaries. Each dictionary contains:
|
||||||
@ -664,7 +664,7 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
|
|||||||
* Default: `16`
|
* Default: `16`
|
||||||
* `led_process_limit` <Badge type="info">Number</Badge>
|
* `led_process_limit` <Badge type="info">Number</Badge>
|
||||||
* Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness).
|
* 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` <Badge type="info">Number</Badge>
|
* `max_brightness` <Badge type="info">Number</Badge>
|
||||||
* The maximum value which the HSV "V" component is scaled to, from 0 to 255.
|
* The maximum value which the HSV "V" component is scaled to, from 0 to 255.
|
||||||
* Default: `255`
|
* Default: `255`
|
||||||
@ -672,13 +672,13 @@ Configures the [RGB Matrix](features/rgb_matrix) feature.
|
|||||||
* Animations react to keyup instead of keydown.
|
* Animations react to keyup instead of keydown.
|
||||||
* Default: `false`
|
* Default: `false`
|
||||||
* `sat_steps` <Badge type="info">Number</Badge>
|
* `sat_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of saturation adjustment steps.
|
* The value by which to increment the saturation.
|
||||||
* Default: `16`
|
* Default: `16`
|
||||||
* `sleep` <Badge type="info">Boolean</Badge>
|
* `sleep` <Badge type="info">Boolean</Badge>
|
||||||
* Turn off the LEDs when the host goes to sleep.
|
* Turn off the LEDs when the host goes to sleep.
|
||||||
* Default: `false`
|
* Default: `false`
|
||||||
* `speed_steps` <Badge type="info">Number</Badge>
|
* `speed_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of speed adjustment steps.
|
* The value by which to increment the speed.
|
||||||
* Default: `16`
|
* Default: `16`
|
||||||
* `split_count` <Badge type="info">Array: Number</Badge>
|
* `split_count` <Badge type="info">Array: Number</Badge>
|
||||||
* For split keyboards, the number of LEDs on each half.
|
* 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.
|
* The LED activity timeout in milliseconds.
|
||||||
* Default: `0` (no timeout)
|
* Default: `0` (no timeout)
|
||||||
* `val_steps` <Badge type="info">Number</Badge>
|
* `val_steps` <Badge type="info">Number</Badge>
|
||||||
* The number of brightness adjustment steps.
|
* The value by which to increment the brightness.
|
||||||
* Default: `16`
|
* Default: `16`
|
||||||
|
|
||||||
## Secure {#secure}
|
## Secure {#secure}
|
||||||
|
Loading…
Reference in New Issue
Block a user