nRF Connect SDK API 2.8.99
Loading...
Searching...
No Matches
Modem battery

Public APIs for modem battery. More...

Typedefs

typedef void(* modem_battery_low_level_handler_t) (int battery_voltage)
 Type definition of event handler for battery voltage low level notifications.
 
typedef void(* modem_battery_pofwarn_handler_t) (void)
 Type definition of Event handler for power-off warnings.
 

Enumerations

enum  pofwarn_level { POFWARN_3000 = 30 , POFWARN_3100 = 31 , POFWARN_3200 = 32 , POFWARN_3300 = 33 }
 Battery voltage levels for power-off warnings. More...
 

Functions

int modem_battery_low_level_handler_set (modem_battery_low_level_handler_t handler)
 Function to set an event handler for battery voltage low level notifications.
 
int modem_battery_pofwarn_handler_set (modem_battery_pofwarn_handler_t handler)
 Function to set an event handler for power-off warnings.
 
int modem_battery_pofwarn_enable (enum pofwarn_level level)
 Configure power-off warnings from the modem.
 
int modem_battery_pofwarn_disable (void)
 Disable power-off warnings from the modem.
 
int modem_battery_low_level_enable (void)
 Subscribe unsolicited notifications of battery voltage low level.
 
int modem_battery_low_level_disable (void)
 Unsubscribe unsolicited notifications of battery voltage low level.
 
int modem_battery_low_level_set (int battery_level)
 Set the battery voltage low level for the modem.
 
int modem_battery_voltage_get (int *battery_voltage)
 Function for retrieving the latest voltage measured automatically during modem wakeup or reception. During modem inactivity, the modem measures battery voltage when this function is called.
 

Detailed Description

Public APIs for modem battery.