diff options
author | Nick Brassel <[email protected]> | 2024-08-26 10:01:57 +1000 |
---|---|---|
committer | Nick Brassel <[email protected]> | 2024-08-26 10:01:57 +1000 |
commit | 5d76c5280dc0aff398cdce19fa54d0e0725c418d (patch) | |
tree | 40026340f0d524a6006f18f01ef988e15d271075 /docs/features/led_indicators.md | |
parent | e6a898e3eea3521d3f0497ee26937d5269d78fb7 (diff) | |
parent | 81dcf2b547bacc42bd9cf8ccaccd3d7164e69926 (diff) | |
download | qmk_firmware-5d76c5280dc0aff398cdce19fa54d0e0725c418d.tar.gz qmk_firmware-5d76c5280dc0aff398cdce19fa54d0e0725c418d.zip |
Merge branch 'develop'0.26.0
Diffstat (limited to 'docs/features/led_indicators.md')
-rw-r--r-- | docs/features/led_indicators.md | 7 |
1 files changed, 1 insertions, 6 deletions
diff --git a/docs/features/led_indicators.md b/docs/features/led_indicators.md index 8435c69a55..211fda2581 100644 --- a/docs/features/led_indicators.md +++ b/docs/features/led_indicators.md @@ -21,9 +21,8 @@ There are three ways to get the lock LED state: The `host_keyboard_led_state()` may reflect an updated state before `led_update_user()` is called. ::: -Two deprecated functions that provide the LED state as `uint8_t`: +Deprecated functions that provide the LED state as `uint8_t`: -* `uint8_t led_set_user(uint8_t usb_led)` * `uint8_t host_keyboard_leds()` ## Configuration Options @@ -50,10 +49,6 @@ When the configuration options do not provide enough flexibility, the following Both receives LED state as a struct parameter. Returning `true` in `led_update_user()` will allow the keyboard level code in `led_update_kb()` to run as well. Returning `false` will override the keyboard level code, depending on how the keyboard level function is set up. -::: tip -This boolean return type of `led_update_user` allows for overriding keyboard LED controls, and is thus recommended over the void `led_set_user` function. -::: - ### Example of keyboard LED update implementation This is a template indicator function that can be implemented on keyboard level code: |