drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Remove deprecated led_set_user (#23979)

Browse source
This commit is contained in:
Joel Challis 2024-06-22 09:10:58 +01:00 • committed by GitHub
parent 99aa4f5191
commit cb39df273d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 4 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/features/led_indicators.md
View file

@ -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: