diff options
| author | Joel Challis <[email protected]> | 2023-11-01 01:26:24 +0000 | 
|---|---|---|
| committer | GitHub <[email protected]> | 2023-11-01 01:26:24 +0000 | 
| commit | fbbb221a31a4890a3302a4b169465d9efb0c59ed (patch) | |
| tree | 772837b094def311ed8bf7354c7b607373936733 /docs/reference_info_json.md | |
| parent | a19ae3d78466588caa9caf7c38d1617932255733 (diff) | |
| download | qmk_firmware-fbbb221a31a4890a3302a4b169465d9efb0c59ed.tar.gz qmk_firmware-fbbb221a31a4890a3302a4b169465d9efb0c59ed.zip | |
Implement data driven lighting defaults (#21825)
Diffstat (limited to 'docs/reference_info_json.md')
| -rw-r--r-- | docs/reference_info_json.md | 65 | 
1 files changed, 63 insertions, 2 deletions
| diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index d9336fa2bb..4a70a4bb6f 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -134,6 +134,16 @@ Configures the [Backlight](feature_backlight.md) feature.      * `breathing_period`          * The length of one backlight breathing cycle in seconds.          * Default: `6` (6 seconds) +    * `default` +        * `on` +            * The default backlight enabled state. +            * Default: `true` +        * `breathing` +            * The default backlight breathing state. +            * Default: `false` +        * `brightness` +            * The default brightness level. +            * Default: `max_brightness`      * `driver`          * The driver to use. Must be one of `custom`, `pwm`, `software`, `timer`.          * Default: `"pwm"` @@ -341,7 +351,7 @@ Configures the [LED Matrix](feature_led_matrix.md) feature.          * Example:          ```json          { -            "alpha_mods": true, +            "alphas_mods": true,              "breathing": true,              "cycle_left_right": false          } @@ -349,6 +359,19 @@ Configures the [LED Matrix](feature_led_matrix.md) feature.      * `center_point`          * The centroid (geometric center) of the LEDs. Used for certain effects.          * Default: `[112, 32]` +    * `default` +        * `animation` +            * The default effect. Must be one of `led_matrix.animations` +            * Default: `"solid"` +        * `on` +            * The default enabled state. +            * Default: `true` +        * `val` +            * The default brightness level. +            * Default: `max_brightness` +        * `speed` +            * The default animation speed. +            * Default: `128`      * `driver` (Required)          * The driver to use. Must be one of `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`.      * `layout` (Required) @@ -506,6 +529,25 @@ Configures the [RGB Lighting](feature_rgblight.md) feature.      * `brightness_steps`          * The number of brightness adjustment steps.          * Default: `17` +    * `default` +        * `animation` +            * The default effect. Must be one of `rgblight.animations` +            * Default: `"static_light"` +        * `on` +            * The default enabled state. +            * Default: `true` +        * `hue` +            * The default hue value. +            * Default: `0` +        * `sat` +            * The default saturation value. +            * Default: `255` +        * `val` +            * The default brightness level. +            * Default: `max_brightness` +        * `speed` +            * The default animation speed. +            * Default: `0`      * `driver`          * The driver to use. Must be one of `apa102`, `custom`, `ws2812`.          * Default: `"ws2812"` @@ -554,7 +596,7 @@ Configures the [RGB Matrix](feature_rgb_matrix.md) feature.          * Example:          ```json          { -            "alpha_mods": true, +            "alphas_mods": true,              "breathing": true,              "cycle_left_right": false          } @@ -562,6 +604,25 @@ Configures the [RGB Matrix](feature_rgb_matrix.md) feature.      * `center_point`          * The centroid (geometric center) of the LEDs. Used for certain effects.          * Default: `[112, 32]` +    * `default` +        * `animation` +            * The default effect. Must be one of `rgb_matrix.animations` +            * Default: `"solid_color"` +        * `on` +            * The default enabled state. +            * Default: `true` +        * `hue` +            * The default hue value. +            * Default: `0` +        * `sat` +            * The default saturation value. +            * Default: `255` +        * `val` +            * The default brightness level. +            * Default: `max_brightness` +        * `speed` +            * The default animation speed. +            * Default: `128`      * `driver` (Required)          * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`.      * `hue_steps` | 
