diff options
Diffstat (limited to 'docs/drivers')
-rw-r--r-- | docs/drivers/aw20216s.md | 2 | ||||
-rw-r--r-- | docs/drivers/battery.md | 26 | ||||
-rw-r--r-- | docs/drivers/spi.md | 2 |
3 files changed, 25 insertions, 5 deletions
diff --git a/docs/drivers/aw20216s.md b/docs/drivers/aw20216s.md index 36a6d63c33..042c8df129 100644 --- a/docs/drivers/aw20216s.md +++ b/docs/drivers/aw20216s.md @@ -2,7 +2,7 @@ SPI 18x12 LED matrix driver by Awinic. Supports a maximum of four drivers, each controlling up to 216 single-color LEDs, or 72 RGB LEDs. -[AW20216S Datasheet](https://doc.awinic.com/doc/20230609wm/b6a9c70b-e1bd-495b-925f-bcbed3fc2620.pdf) +[AW20216S Datasheet](https://doc.awinic.com/doc/202412/a055779b-49c0-4d09-8f04-73029f44b72b.pdf) ## Usage {#usage} diff --git a/docs/drivers/battery.md b/docs/drivers/battery.md index b1f75c1156..e482ffc8b6 100644 --- a/docs/drivers/battery.md +++ b/docs/drivers/battery.md @@ -36,8 +36,8 @@ The following `#define`s apply only to the `adc` driver: |-----------------------------|--------------|--------------------------------------------------------------| |`BATTERY_PIN` |*Not defined* |The GPIO pin connected to the voltage divider. | |`BATTERY_REF_VOLTAGE_MV` |`3300` |The ADC reverence voltage, in millivolts. | -|`BATTERY_VOLTAGE_DIVIDER_R1` |`100000` |The voltage divider resistance, in kOhm. Set to 0 to disable. | -|`BATTERY_VOLTAGE_DIVIDER_R1` |`100000` |The voltage divider resistance, in kOhm. Set to 0 to disable. | +|`BATTERY_VOLTAGE_DIVIDER_R1` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. | +|`BATTERY_VOLTAGE_DIVIDER_R2` |`100` |The voltage divider resistance, in kOhm. Set to 0 to disable. | |`BATTERY_ADC_RESOLUTION` |`10` |The ADC resolution configured for the ADC Driver. | ## Functions @@ -49,3 +49,25 @@ Sample battery level. #### Return Value {#api-battery-get-percent-return} The battery percentage, in the range 0-100. + +## Callbacks + +### `void battery_percent_changed_user(uint8_t level)` {#api-battery-percent-changed-user} + +User hook called when battery level changed. + +### Arguments {#api-battery-percent-changed-user-arguments} + + - `uint8_t level` + The battery percentage, in the range 0-100. + +--- + +### `void battery_percent_changed_kb(uint8_t level)` {#api-battery-percent-changed-kb} + +Keyboard hook called when battery level changed. + +### Arguments {#api-battery-percent-changed-kb-arguments} + + - `uint8_t level` + The battery percentage, in the range 0-100. diff --git a/docs/drivers/spi.md b/docs/drivers/spi.md index 140b204945..56b294ad3a 100644 --- a/docs/drivers/spi.md +++ b/docs/drivers/spi.md @@ -39,8 +39,6 @@ To enable SPI, modify your board's `halconf.h` to enable SPI, then modify your b #pragma once #define HAL_USE_SPI TRUE // [!code focus] -#define SPI_USE_WAIT TRUE // [!code focus] -#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD // [!code focus] #include_next <halconf.h> ``` |