wiced_hal_batmon.h File Reference

List of parameters and defined functions needed to access the Battery Monitor. More...

Data Structures
struct	_wiced_hal_batmon_observer

Typedefs
typedef void(	wiced_hal_batmon_observer_fp )(uint32_t)
	Supported ADC input channel selection for battery connection. More...
typedef struct _wiced_hal_batmon_observer	wiced_hal_batmon_observer_t

Functions
wiced_bool_t	wiced_hal_batmon_config (uint8_t adcInputConnected, uint32_t measurementInterval, uint8_t numMeasurementsToAvg, uint16_t fullVoltage, uint16_t emptyVoltage, uint16_t shutdownVoltage, uint8_t maxLevel, uint8_t reportID, uint8_t reportLength, uint8_t reportOnConnect)
	Sets the configuration parameters of the Battery Monitor. More...
void	wiced_hal_batmon_init (void)
	Initialize and then start the Battery Monitor. More...
uint8_t	wiced_hal_batmon_get_battery_level (void)
	Get battery level (0-max level). More...
uint32_t	wiced_hal_batmon_get_battery_raw_vol (void)
	Get the current running average raw voltage. More...
void	wiced_hal_batmon_add_battery_observer (wiced_hal_batmon_observer_fp *observer)
	add observer for battery level changed More...
void	wiced_hal_batmon_register_low_battery_shutdown_cb (void(*func_CB)(void))
	register application callback handler for low battery shut down More...
wiced_bool_t	wiced_hal_batmon_is_low_battery_shutdown (void)
	Check if low battery shutdown is on-going. More...
void	wiced_hal_batmon_poll_monitor (void)
	Polls the battery by monitoring the voltage via the ADC. More...
void	wiced_hal_batmon_set_battery_report_sent_flag (wiced_bool_t flag)
	set flag to indicate if battery report is ever sent out once More...

Detailed Description

List of parameters and defined functions needed to access the Battery Monitor.