flipperzero-firmware/firmware/targets/api-hal-include/api-hal-power.h
gornekich 610f4f5d73
[FL-41] api-hal doxygen documentation (#387)
* targets/api-hal: rework documentation in doxygen style
* core/api-hal: rework documentation in doxygen style
* core/furi: rework documentation in doxygen style
* drivers: rework documentation in doxygen style

Co-authored-by: あく <alleteam@gmail.com>
2021-03-24 12:35:33 +03:00

99 lines
2.2 KiB
C

#pragma once
#include <stdint.h>
#include <stdbool.h>
#include <m-string.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Power IC type */
typedef enum {
ApiHalPowerICCharger,
ApiHalPowerICFuelGauge,
} ApiHalPowerIC;
/** Initialize drivers */
void api_hal_power_init();
/**
* Get current insomnia level
* @return insomnia level: 0 - no insomnia, >0 - insomnia, bearer count.
*/
uint16_t api_hal_power_insomnia_level();
/**
* Enter insomnia mode
* Prevents device from going to sleep
* @warning Internally increases insomnia level
* Must be paired with api_hal_power_insomnia_exit
*/
void api_hal_power_insomnia_enter();
/**
* Exit insomnia mode
* Allow device to go to sleep
* @warning Internally decreases insomnia level.
* Must be paired with api_hal_power_insomnia_enter
*/
void api_hal_power_insomnia_exit();
/** Check if deep sleep availble */
bool api_hal_power_deep_available();
/** Go to sleep */
void api_hal_power_sleep();
/** Get predicted remaining battery capacity in percents */
uint8_t api_hal_power_get_pct();
/** Get battery health state in percents */
uint8_t api_hal_power_get_bat_health_pct();
/** Get charging status */
bool api_hal_power_is_charging();
/** Poweroff system */
void api_hal_power_off();
/** OTG enable */
void api_hal_power_enable_otg();
/** OTG disable */
void api_hal_power_disable_otg();
/** Get remaining battery battery capacity in mAh */
uint32_t api_hal_power_get_battery_remaining_capacity();
/** Get full charge battery capacity in mAh */
uint32_t api_hal_power_get_battery_full_capacity();
/** Get battery voltage in V */
float api_hal_power_get_battery_voltage(ApiHalPowerIC ic);
/** Get battery current in A */
float api_hal_power_get_battery_current(ApiHalPowerIC ic);
/** Get temperature in C */
float api_hal_power_get_battery_temperature(ApiHalPowerIC ic);
/** Get System voltage in V */
float api_hal_power_get_system_voltage();
/** Get USB voltage in V */
float api_hal_power_get_usb_voltage();
/** Get power system component state */
void api_hal_power_dump_state(string_t buffer);
/** Enable 3.3v on external gpio and sd card */
void api_hal_power_enable_external_3_3v();
/** Disable 3.3v on external gpio and sd card */
void api_hal_power_disable_external_3_3v();
#ifdef __cplusplus
}
#endif