From cc696a2ae838a9639335ca8eb3cb3b794c06bc33 Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Sun, 17 Aug 2025 01:14:48 +0100
Subject: Refactor battery driver (#25550)
---
docs/reference_info_json.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
(limited to 'docs/reference_info_json.md')
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index cf22317613..84377ef36c 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -179,6 +179,32 @@ Configures the [Backlight](features/backlight) feature.
* `pins` Array: Pin
* A list of GPIO pins connected to the backlight LEDs (`software` and `timer` drivers only).
+## Battery
+
+Configures the [Battery](features/battery) feature.
+
+* `battery`
+ * `adc`
+ * `pin` Pin Required
+ * The GPIO pin connected to the voltage divider.
+ * `reference_voltage` Number
+ * The ADC reverence voltage, in millivolts.
+ * Default: `3300`
+ * `divider_r1` Number
+ * The voltage divider resistance, in kOhm. Set to 0 to disable.
+ * Default: `100`
+ * `divider_r2` Number
+ * The voltage divider resistance, in kOhm. Set to 0 to disable.
+ * Default: `100`
+ * `resolution` Number
+ * The ADC resolution configured for the ADC Driver.
+ * Default: `10`
+ * `driver` String Required
+ * The driver to use. Must be one of `adc`, `custom`, `vendor`.
+ * `sample_interval` Number
+ * The delay between sampling the battery in milliseconds.
+ * Default: `30000` (30 s)
+
## Wireless/Bluetooth {#bluetooth}
Configures the [Wireless](features/wireless) feature.
--
cgit v1.2.3