summaryrefslogtreecommitdiffstats
path: root/docs/feature_led_indicators.md
diff options
context:
space:
mode:
authorThomas Weißschuh <thomas@t-8ch.de>2022-10-06 12:24:41 +0200
committerGitHub <noreply@github.com>2022-10-06 21:24:41 +1100
commitcbe1c22d468d64d7a3274061ce9c2073ecb208a4 (patch)
tree00fea20653a9bb57af68c9a5c873f3c4a1874ecd /docs/feature_led_indicators.md
parentc255174cf3e55483f14351a69689e24e849445a0 (diff)
quantum: led: split out led_update_ports() for customization of led behaviour (#14452)
Diffstat (limited to 'docs/feature_led_indicators.md')
-rw-r--r--docs/feature_led_indicators.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/feature_led_indicators.md b/docs/feature_led_indicators.md
index a2a2e17c6f..d89562a377 100644
--- a/docs/feature_led_indicators.md
+++ b/docs/feature_led_indicators.md
@@ -101,6 +101,13 @@ The `host_keyboard_led_state()` function will report the LED state returned from
bool caps = host_keyboard_led_state().caps_lock;
```
+## `led_update_ports()`
+
+This function writes the LED state to the actual hardware. Call it manually
+from your `led_update_*()` callbacks to modify the handling of the standard
+keyboard LEDs.
+For example when repurposing a standard LED indicator as layer indicator.
+
## Setting Physical LED State
Some keyboard implementations provide convenient methods for setting the state of the physical LEDs.