zmk/docs/docs/config/battery.md
Joel Spadin ae78aa247a feat(docs): Update power and lighting config pages
Moved battery configuration to its own page to match the feature page.

Documented that external power is disabled when in sleep mode.

Clarified that the *_START configs apply on first boot, and any changes
after that are persisted.
2022-07-03 18:55:54 +01:00

1.5 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.

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