aboutsummaryrefslogtreecommitdiffstats
path: root/docs/reference_info_json.md
diff options
context:
space:
mode:
authorJoel Challis2025-08-17 02:14:48 +0200
committerGitHub2025-08-17 02:14:48 +0200
commitcc696a2ae838a9639335ca8eb3cb3b794c06bc33 (patch)
tree901b54bda536acb5503c6cf924b0f30bca1a174e /docs/reference_info_json.md
parentf29d8117bf877a4df1f88f40e0131f4465748540 (diff)
Refactor battery driver (#25550)
Diffstat (limited to 'docs/reference_info_json.md')
-rw-r--r--docs/reference_info_json.md26
1 files changed, 26 insertions, 0 deletions
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` <Badge type="info">Array: Pin</Badge>
* 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` <Badge type="info">Pin</Badge> <Badge>Required</Badge>
+ * The GPIO pin connected to the voltage divider.
+ * `reference_voltage` <Badge type="info">Number</Badge>
+ * The ADC reverence voltage, in millivolts.
+ * Default: `3300`
+ * `divider_r1` <Badge type="info">Number</Badge>
+ * The voltage divider resistance, in kOhm. Set to 0 to disable.
+ * Default: `100`
+ * `divider_r2` <Badge type="info">Number</Badge>
+ * The voltage divider resistance, in kOhm. Set to 0 to disable.
+ * Default: `100`
+ * `resolution` <Badge type="info">Number</Badge>
+ * The ADC resolution configured for the ADC Driver.
+ * Default: `10`
+ * `driver` <Badge type="info">String</Badge> <Badge>Required</Badge>
+ * The driver to use. Must be one of `adc`, `custom`, `vendor`.
+ * `sample_interval` <Badge type="info">Number</Badge>
+ * The delay between sampling the battery in milliseconds.
+ * Default: `30000` (30 s)
+
## Wireless/Bluetooth {#bluetooth}
Configures the [Wireless](features/wireless) feature.