diff options
| author | Joel Challis <git@zvecr.com> | 2023-09-27 00:41:13 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-27 00:41:13 +0100 |
| commit | 80ccbdfd86b75689561c43d9344ccb3f15e4d094 (patch) | |
| tree | 15f3cb5a564f9dd40faece9d28e418d5c3fa6e69 /docs | |
| parent | d202355f752b9fd851f54ffe17dc7b0556b79dba (diff) | |
More data driven RGB/LED Matrix config (#21939)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference_info_json.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 323db18664..001d80ddab 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -342,9 +342,21 @@ Configures the [LED Matrix](feature_led_matrix.md) feature. * The key matrix position associated with the LED. * Example: `[0, 2]` * Example: `{"matrix": [2, 1], "x": 20, "y": 48, "flags": 2}` + * `led_flush_limit` + * Limits in milliseconds how frequently an animation will update the LEDs. + * Default: `16` + * `led_process_limit` + * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness). + * Default: `led_count / 5` * `max_brightness` * The maximum value which brightness is scaled to, from 0 to 255. * Default: `255` + * `react_on_keyup` + * Animations react to keyup instead of keydown. + * Default: `false` + * `sleep` + * Turn off the LEDs when the host goes to sleep. + * Default: `false` * `speed_steps` * The number of speed adjustment steps. * Default: `16` @@ -546,12 +558,24 @@ Configures the [RGB Matrix](feature_rgb_matrix.md) feature. * The key matrix position associated with the LED. * Example: `[0, 2]` * Example: `{"matrix": [2, 1], "x": 20, "y": 48, "flags": 2}` + * `led_flush_limit` + * Limits in milliseconds how frequently an animation will update the LEDs. + * Default: `16` + * `led_process_limit` + * Limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness). + * Default: `led_count / 5` * `max_brightness` * The maximum value which the HSV "V" component is scaled to, from 0 to 255. * Default: `255` + * `react_on_keyup` + * Animations react to keyup instead of keydown. + * Default: `false` * `sat_steps` * The number of saturation adjustment steps. * Default: `16` + * `sleep` + * Turn off the LEDs when the host goes to sleep. + * Default: `false` * `speed_steps` * The number of speed adjustment steps. * Default: `16` |