diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_led_matrix.md | 29 | ||||
| -rw-r--r-- | docs/feature_rgb_matrix.md | 27 |
2 files changed, 1 insertions, 55 deletions
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md index 5134ab6ef..018da43dd 100644 --- a/docs/feature_led_matrix.md +++ b/docs/feature_led_matrix.md | |||
| @@ -262,7 +262,7 @@ For inspiration and examples, check out the built-in effects under `quantum/led_ | |||
| 262 | #define LED_MATRIX_FRAMEBUFFER_EFFECTS // enable framebuffer effects | 262 | #define LED_MATRIX_FRAMEBUFFER_EFFECTS // enable framebuffer effects |
| 263 | #define LED_DISABLE_TIMEOUT 0 // number of milliseconds to wait until led automatically turns off | 263 | #define LED_DISABLE_TIMEOUT 0 // number of milliseconds to wait until led automatically turns off |
| 264 | #define LED_DISABLE_AFTER_TIMEOUT 0 // OBSOLETE: number of ticks to wait until disabling effects | 264 | #define LED_DISABLE_AFTER_TIMEOUT 0 // OBSOLETE: number of ticks to wait until disabling effects |
| 265 | #define LED_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended | 265 | #define LED_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended |
| 266 | #define LED_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness) | 266 | #define LED_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness) |
| 267 | #define LED_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness) | 267 | #define LED_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness) |
| 268 | #define LED_MATRIX_MAXIMUM_BRIGHTNESS 255 // limits maximum brightness of LEDs | 268 | #define LED_MATRIX_MAXIMUM_BRIGHTNESS 255 // limits maximum brightness of LEDs |
| @@ -350,30 +350,3 @@ void led_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { | |||
| 350 | LED_MATRIX_INDICATOR_SET_VALUE(index, value); | 350 | LED_MATRIX_INDICATOR_SET_VALUE(index, value); |
| 351 | } | 351 | } |
| 352 | ``` | 352 | ``` |
| 353 | |||
| 354 | ## Suspended State :id=suspended-state | ||
| 355 | To use the suspend feature, make sure that `#define LED_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file. | ||
| 356 | |||
| 357 | Additionally add this to your `<keyboard>.c`: | ||
| 358 | |||
| 359 | ```c | ||
| 360 | void suspend_power_down_kb(void) { | ||
| 361 | led_matrix_set_suspend_state(true); | ||
| 362 | suspend_power_down_user(); | ||
| 363 | } | ||
| 364 | |||
| 365 | void suspend_wakeup_init_kb(void) { | ||
| 366 | led_matrix_set_suspend_state(false); | ||
| 367 | suspend_wakeup_init_user(); | ||
| 368 | } | ||
| 369 | ``` | ||
| 370 | or add this to your `keymap.c`: | ||
| 371 | ```c | ||
| 372 | void suspend_power_down_user(void) { | ||
| 373 | led_matrix_set_suspend_state(true); | ||
| 374 | } | ||
| 375 | |||
| 376 | void suspend_wakeup_init_user(void) { | ||
| 377 | led_matrix_set_suspend_state(false); | ||
| 378 | } | ||
| 379 | ``` | ||
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index f3e25f2f1..bd47fb6d3 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
| @@ -741,30 +741,3 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { | |||
| 741 | } | 741 | } |
| 742 | } | 742 | } |
| 743 | ``` | 743 | ``` |
| 744 | |||
| 745 | ### Suspended state :id=suspended-state | ||
| 746 | To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file. | ||
| 747 | |||
| 748 | Additionally add this to your `<keyboard>.c`: | ||
| 749 | |||
| 750 | ```c | ||
| 751 | void suspend_power_down_kb(void) { | ||
| 752 | rgb_matrix_set_suspend_state(true); | ||
| 753 | suspend_power_down_user(); | ||
| 754 | } | ||
| 755 | |||
| 756 | void suspend_wakeup_init_kb(void) { | ||
| 757 | rgb_matrix_set_suspend_state(false); | ||
| 758 | suspend_wakeup_init_user(); | ||
| 759 | } | ||
| 760 | ``` | ||
| 761 | or add this to your `keymap.c`: | ||
| 762 | ```c | ||
| 763 | void suspend_power_down_user(void) { | ||
| 764 | rgb_matrix_set_suspend_state(true); | ||
| 765 | } | ||
| 766 | |||
| 767 | void suspend_wakeup_init_user(void) { | ||
| 768 | rgb_matrix_set_suspend_state(false); | ||
| 769 | } | ||
| 770 | ``` | ||
