logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

battery.md (2560B)

    

  1. # Battery Driver
  3. This driver provides support for sampling battery level.
  5. ## Usage
  7. To use this driver, add the following to your `rules.mk`:
  9. ```make
  10. BATTERY_DRIVER_REQUIRED = yes
  11. ```
  13. ## Basic Configuration {#basic-configuration}
  15. Add the following to your `config.h`:
  17. |Define                    |Default |Description                                       |
  18. |--------------------------|--------|--------------------------------------------------|
  19. |`BATTERY_SAMPLE_INTERVAL` |`30000` |The time between battery samples in milliseconds. |
  21. ## Driver Configuration {#driver-configuration}
  23. Driver selection can be configured in `rules.mk` as `BATTERY_DRIVER`. Valid values are `adc` (default), `vendor`, or `custom`. See below for information on individual drivers.
  25. ### ADC Driver {#adc-driver}
  27. This is the default battery driver. The default configuration assumes the battery is connected to a ADC capable pin through a voltage divider.
  29. ```make
  30. BATTERY_DRIVER = adc
  31. ```
  33. The following `#define`s apply only to the `adc` driver:
  35. |Define                       |Default       |Description                                                   |
  36. |-----------------------------|--------------|--------------------------------------------------------------|
  37. |`BATTERY_PIN`                |*Not defined* |The GPIO pin connected to the voltage divider.                |
  38. |`BATTERY_REF_VOLTAGE_MV`     |`3300`        |The ADC reverence voltage, in millivolts.                     |
  39. |`BATTERY_VOLTAGE_DIVIDER_R1` |`100`         |The voltage divider resistance, in kOhm. Set to 0 to disable. |
  40. |`BATTERY_VOLTAGE_DIVIDER_R2` |`100`         |The voltage divider resistance, in kOhm. Set to 0 to disable. |
  41. |`BATTERY_ADC_RESOLUTION`     |`10`          |The ADC resolution configured for the ADC Driver.             |
  43. ## Functions
  45. ### `uint8_t battery_get_percent(void)` {#api-battery-get-percent}
  47. Sample battery level.
  49. #### Return Value {#api-battery-get-percent-return}
  51. The battery percentage, in the range 0-100.
  53. ## Callbacks
  55. ### `void battery_percent_changed_user(uint8_t level)` {#api-battery-percent-changed-user}
  57. User hook called when battery level changed.
  59. ### Arguments {#api-battery-percent-changed-user-arguments}
  61.  - `uint8_t level`  
  62.    The battery percentage, in the range 0-100.
  64. ---
  66. ### `void battery_percent_changed_kb(uint8_t level)` {#api-battery-percent-changed-kb}
  68. Keyboard hook called when battery level changed.
  70. ### Arguments {#api-battery-percent-changed-kb-arguments}
  72.  - `uint8_t level`  
  73.    The battery percentage, in the range 0-100.