aboutsummaryrefslogtreecommitdiffstats
path: root/docs/drivers
diff options
context:
space:
mode:
authorJoel Challis2025-05-05 04:28:33 +0200
committerGitHub2025-05-05 04:28:33 +0200
commit5611a4006493eb0ec7cf815d4a7a24a671a16df6 (patch)
treed7c7c139c642c5b4c3f0de150dbaabc4bd751669 /docs/drivers
parent11c8b2841e74c06b2bfe85a1684a61caf3bd948a (diff)
Add battery changed callbacks (#25207)
Diffstat (limited to 'docs/drivers')
-rw-r--r--docs/drivers/battery.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/drivers/battery.md b/docs/drivers/battery.md
index b1f75c1156..0bc8e5aec9 100644
--- a/docs/drivers/battery.md
+++ b/docs/drivers/battery.md
@@ -49,3 +49,25 @@ Sample battery level.
#### Return Value {#api-battery-get-percent-return}
The battery percentage, in the range 0-100.
+
+## Callbacks
+
+### `void battery_percent_changed_user(uint8_t level)` {#api-battery-percent-changed-user}
+
+User hook called when battery level changed.
+
+### Arguments {#api-battery-percent-changed-user-arguments}
+
+ - `uint8_t level`
+ The battery percentage, in the range 0-100.
+
+---
+
+### `void battery_percent_changed_kb(uint8_t level)` {#api-battery-percent-changed-kb}
+
+Keyboard hook called when battery level changed.
+
+### Arguments {#api-battery-percent-changed-kb-arguments}
+
+ - `uint8_t level`
+ The battery percentage, in the range 0-100.