qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

battery.h (732B)

      1 // Copyright 2025 QMK
      2 // SPDX-License-Identifier: GPL-2.0-or-later
      3 
      4 #pragma once
      5 
      6 #include <stdint.h>
      7 
      8 /**
      9  * \file
     10  *
     11  * \defgroup battery Battery API
     12  *
     13  * \brief API to query battery status.
     14  * \{
     15  */
     16 
     17 /**
     18  * \brief Initialize the battery driver.
     19  */
     20 void battery_init(void);
     21 
     22 /**
     23  * \brief Perform housekeeping tasks.
     24  */
     25 void battery_task(void);
     26 
     27 /**
     28  * \brief Sample battery level.
     29  *
     30  * \return The battery percentage, in the range 0-100.
     31  */
     32 uint8_t battery_get_percent(void);
     33 
     34 /**
     35  * \brief user hook called when battery level changed.
     36  *
     37  */
     38 void battery_percent_changed_user(uint8_t level);
     39 
     40 /**
     41  * \brief keyboard hook called when battery level changed.
     42  *
     43  */
     44 void battery_percent_changed_kb(uint8_t level);
     45 
     46 /** \} */