summaryrefslogtreecommitdiff
path: root/docs/reference_info_json.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2023-11-01 01:26:24 +0000
committerGitHub <noreply@github.com>2023-11-01 01:26:24 +0000
commitfbbb221a31a4890a3302a4b169465d9efb0c59ed (patch)
tree772837b094def311ed8bf7354c7b607373936733 /docs/reference_info_json.md
parenta19ae3d78466588caa9caf7c38d1617932255733 (diff)
Implement data driven lighting defaults (#21825)
Diffstat (limited to 'docs/reference_info_json.md')
-rw-r--r--docs/reference_info_json.md65
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.
134 * `breathing_period` 134 * `breathing_period`
135 * The length of one backlight breathing cycle in seconds. 135 * The length of one backlight breathing cycle in seconds.
136 * Default: `6` (6 seconds) 136 * Default: `6` (6 seconds)
137 * `default`
138 * `on`
139 * The default backlight enabled state.
140 * Default: `true`
141 * `breathing`
142 * The default backlight breathing state.
143 * Default: `false`
144 * `brightness`
145 * The default brightness level.
146 * Default: `max_brightness`
137 * `driver` 147 * `driver`
138 * The driver to use. Must be one of `custom`, `pwm`, `software`, `timer`. 148 * The driver to use. Must be one of `custom`, `pwm`, `software`, `timer`.
139 * Default: `"pwm"` 149 * Default: `"pwm"`
@@ -341,7 +351,7 @@ Configures the [LED Matrix](feature_led_matrix.md) feature.
341 * Example: 351 * Example:
342 ```json 352 ```json
343 { 353 {
344 "alpha_mods": true, 354 "alphas_mods": true,
345 "breathing": true, 355 "breathing": true,
346 "cycle_left_right": false 356 "cycle_left_right": false
347 } 357 }
@@ -349,6 +359,19 @@ Configures the [LED Matrix](feature_led_matrix.md) feature.
349 * `center_point` 359 * `center_point`
350 * The centroid (geometric center) of the LEDs. Used for certain effects. 360 * The centroid (geometric center) of the LEDs. Used for certain effects.
351 * Default: `[112, 32]` 361 * Default: `[112, 32]`
362 * `default`
363 * `animation`
364 * The default effect. Must be one of `led_matrix.animations`
365 * Default: `"solid"`
366 * `on`
367 * The default enabled state.
368 * Default: `true`
369 * `val`
370 * The default brightness level.
371 * Default: `max_brightness`
372 * `speed`
373 * The default animation speed.
374 * Default: `128`
352 * `driver` (Required) 375 * `driver` (Required)
353 * The driver to use. Must be one of `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`. 376 * The driver to use. Must be one of `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`.
354 * `layout` (Required) 377 * `layout` (Required)
@@ -506,6 +529,25 @@ Configures the [RGB Lighting](feature_rgblight.md) feature.
506 * `brightness_steps` 529 * `brightness_steps`
507 * The number of brightness adjustment steps. 530 * The number of brightness adjustment steps.
508 * Default: `17` 531 * Default: `17`
532 * `default`
533 * `animation`
534 * The default effect. Must be one of `rgblight.animations`
535 * Default: `"static_light"`
536 * `on`
537 * The default enabled state.
538 * Default: `true`
539 * `hue`
540 * The default hue value.
541 * Default: `0`
542 * `sat`
543 * The default saturation value.
544 * Default: `255`
545 * `val`
546 * The default brightness level.
547 * Default: `max_brightness`
548 * `speed`
549 * The default animation speed.
550 * Default: `0`
509 * `driver` 551 * `driver`
510 * The driver to use. Must be one of `apa102`, `custom`, `ws2812`. 552 * The driver to use. Must be one of `apa102`, `custom`, `ws2812`.
511 * Default: `"ws2812"` 553 * Default: `"ws2812"`
@@ -554,7 +596,7 @@ Configures the [RGB Matrix](feature_rgb_matrix.md) feature.
554 * Example: 596 * Example:
555 ```json 597 ```json
556 { 598 {
557 "alpha_mods": true, 599 "alphas_mods": true,
558 "breathing": true, 600 "breathing": true,
559 "cycle_left_right": false 601 "cycle_left_right": false
560 } 602 }
@@ -562,6 +604,25 @@ Configures the [RGB Matrix](feature_rgb_matrix.md) feature.
562 * `center_point` 604 * `center_point`
563 * The centroid (geometric center) of the LEDs. Used for certain effects. 605 * The centroid (geometric center) of the LEDs. Used for certain effects.
564 * Default: `[112, 32]` 606 * Default: `[112, 32]`
607 * `default`
608 * `animation`
609 * The default effect. Must be one of `rgb_matrix.animations`
610 * Default: `"solid_color"`
611 * `on`
612 * The default enabled state.
613 * Default: `true`
614 * `hue`
615 * The default hue value.
616 * Default: `0`
617 * `sat`
618 * The default saturation value.
619 * Default: `255`
620 * `val`
621 * The default brightness level.
622 * Default: `max_brightness`
623 * `speed`
624 * The default animation speed.
625 * Default: `128`
565 * `driver` (Required) 626 * `driver` (Required)
566 * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`. 627 * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`.
567 * `hue_steps` 628 * `hue_steps`