kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation for peripheral battery monitoring

Browse source 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

Added documentation for peripheral battery monitoring
This commit is contained in:
Dennis Orlando 2024-02-15 20:27:50 +01:00
parent 5826b80374
commit d15ccdc1ad
2 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/docs/config/battery.md
View file

@ -28,6 +28,17 @@ On macOS the BLE battery reporting packets can cause the computer to wakeup from
:::
### Peripheral battery monitoring
You can [configure ZMK to allow support for peripheral battery monitoring over BLE](system.md#split-keyboards) (e.g. when having a split keyboard with two independent and wirelessly connected sides).
If you want to report the battery levels of both sides of a split keyboard, you should have both `CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_PROXY` and `CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING` set to `y`.
:::note[Displaying both battery levels on your host]
Host support for multiple battery levels is undefined. It appears that in most of the cases only the main battery is being reported. In order to correctly display all the battery values, you probably need a special application or script.
:::
### Devicetree
Applies to: [`/chosen` node](https://docs.zephyrproject.org/latest/guides/dts/intro.html#aliases-and-chosen-nodes)

2
docs/docs/features/battery.md
View file

@ -5,7 +5,7 @@ sidebar_label: Battery Level
If your keyboard has a battery sensor, ZMK will report its battery level to the connected bluetooth host and show it on the keyboard's display, if it has one.
For split keyboards, only the battery level of the central (usually left) side is reported over bluetooth.
For split keyboards, only the battery level of the central (usually left) side is reported over bluetooth by default. ZMK can be [configured to report the battery levels for peripherals](../config/battery.md#peripheral-battery-monitoring), but not many host systems will display this information without additional configuration or the use of third party utilities.
:::note