73193d0734
`CONFIG_ZMK_BATTERY_REPORTING` is currently undocumented, A new KConfig section for battery has been added in line with the other sections in the configuration section of the docs, `CONFIG_ZMK_BATTERY_REPORT_INTERVAL` has been moved from system to battery for consistency
2.3 KiB
| title | sidebar_label |
|---|---|
| Battery Level | Battery Level |
See the battery level feature page for more details on configuring a battery sensor.
See Configuration Overview for instructions on how to change these settings.
Kconfig
Definition file: zmk/app/Kconfig
| Config | Type | Description | Default |
|---|---|---|---|
CONFIG_ZMK_BATTERY_REPORTING |
bool | Enables/disables all battery level detection/reporting | n |
CONFIG_ZMK_BATTERY_REPORT_INTERVAL |
int | Battery level report interval in seconds | 60 |
:::note Default setting
Whilst this is disabled by default it is implied by CONFIG_ZMK_BLE, thus any board with BLE enabled will have this automatically enabled unless explicitly overriden.
:::
Devicetree
Applies to: /chosen node
| Property | Type | Description |
|---|---|---|
zmk,battery |
path | The node for the battery sensor driver to use |
Battery Voltage Divider Sensor
Driver for reading the voltage of a battery using an ADC connected to a voltage divider.
Devicetree
Applies to: compatible = "zmk,battery-voltage-divider"
See Zephyr's voltage divider documentation.
nRF VDDH Battery Sensor
Driver for reading the voltage of a battery using a Nordic nRF52's VDDH pin. This driver has no configuration except for the required label property.
Devicetree
Applies to: compatible = "zmk,battery-nrf-vddh"
Definition file: zmk/app/drivers/zephyr/dts/bindings/sensor/zmk,battery-nrf-vddh.yaml
| Property | Type | Description |
|---|---|---|
label |
string | Unique label for the node |