diff options
| author | Dennis <[email protected]> | 2024-02-18 06:51:09 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-02-17 21:51:09 -0800 |
| commit | 604af2ebd318a2b8865f98db55b411a8e07f24c2 (patch) | |
| tree | 3ea90c97a67983a72bae3e15f1d1f52a4c20c1bc | |
| parent | 0f49fa9ae49b3373ea701c3ecd9da3e149ca8d64 (diff) | |
| download | zmk-604af2ebd318a2b8865f98db55b411a8e07f24c2.tar.gz zmk-604af2ebd318a2b8865f98db55b411a8e07f24c2.zip | |
feat(docs): Add pointers for peripheral battery monitoring (#2177)
Co-authored-by: Cem Aksoylar <[email protected]>
Fixes #2166
| -rw-r--r-- | docs/docs/config/battery.md | 11 | ||||
| -rw-r--r-- | docs/docs/features/battery.md | 2 |
2 files changed, 12 insertions, 1 deletions
diff --git a/docs/docs/config/battery.md b/docs/docs/config/battery.md index 68de8fb825..463dc087b6 100644 --- a/docs/docs/config/battery.md +++ b/docs/docs/config/battery.md @@ -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/3.5.0/build/dts/intro-syntax-structure.html#aliases-and-chosen-nodes) diff --git a/docs/docs/features/battery.md b/docs/docs/features/battery.md index 4bfeb12999..29142eedc0 100644 --- a/docs/docs/features/battery.md +++ b/docs/docs/features/battery.md @@ -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 |