diff options
Diffstat (limited to 'docs/reference_info_json.md')
| -rw-r--r-- | docs/reference_info_json.md | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 59daafe3f9..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. @@ -480,6 +506,9 @@ Configures the [LED Matrix](features/led_matrix) feature. * `io_delay` <Badge type="info">Number</Badge> * The amount of time to wait between row/col selection and col/row pin reading, in microseconds. * Default: `30` (30 µs) + * `masked` <Badge type="info">Boolean</Badge> + * Whether configured intersections should be ignored. + * Default: `false` * `rows` <Badge type="info">Array: Pin</Badge> * A list of GPIO pins connected to the matrix rows. * Example: `["B0", "B1", "B2"]` @@ -750,9 +779,9 @@ Configures the [Split Keyboard](features/split_keyboard) feature. * Default: `"bitbang"` * `pin` <Badge type="info">Pin</Badge> * The GPIO pin to use for transmit and receive. - * `soft_serial_speed` <Badge type="info">Number</Badge> - * The protocol speed, from `0` to `5` (`serial` transport protocol only). - * Default: `1` + * `speed` <Badge type="info">Number</Badge> + * The protocol speed, from `0` to `5` (fastest to slowest). + * Default: `1` * `transport` * `protocol` <Badge type="info">String</Badge> * The split transport protocol to use. Must be one of `custom`, `i2c`, `serial`. |