diff options
| author | Joel Challis <git@zvecr.com> | 2025-05-05 03:28:33 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-05 03:28:33 +0100 |
| commit | 5611a4006493eb0ec7cf815d4a7a24a671a16df6 (patch) | |
| tree | d7c7c139c642c5b4c3f0de150dbaabc4bd751669 /docs/drivers | |
| parent | 11c8b2841e74c06b2bfe85a1684a61caf3bd948a (diff) | |
Add battery changed callbacks (#25207)
Diffstat (limited to 'docs/drivers')
| -rw-r--r-- | docs/drivers/battery.md | 22 |
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. | |||
| 49 | #### Return Value {#api-battery-get-percent-return} | 49 | #### Return Value {#api-battery-get-percent-return} |
| 50 | 50 | ||
| 51 | The battery percentage, in the range 0-100. | 51 | The battery percentage, in the range 0-100. |
| 52 | |||
| 53 | ## Callbacks | ||
| 54 | |||
| 55 | ### `void battery_percent_changed_user(uint8_t level)` {#api-battery-percent-changed-user} | ||
| 56 | |||
| 57 | User hook called when battery level changed. | ||
| 58 | |||
| 59 | ### Arguments {#api-battery-percent-changed-user-arguments} | ||
| 60 | |||
| 61 | - `uint8_t level` | ||
| 62 | The battery percentage, in the range 0-100. | ||
| 63 | |||
| 64 | --- | ||
| 65 | |||
| 66 | ### `void battery_percent_changed_kb(uint8_t level)` {#api-battery-percent-changed-kb} | ||
| 67 | |||
| 68 | Keyboard hook called when battery level changed. | ||
| 69 | |||
| 70 | ### Arguments {#api-battery-percent-changed-kb-arguments} | ||
| 71 | |||
| 72 | - `uint8_t level` | ||
| 73 | The battery percentage, in the range 0-100. | ||
