BatteryMonitor_NotifyObj Struct Reference

Battery Monitor notify object structure. More...

#include <BatteryMonitor.h>

Collaboration diagram for BatteryMonitor_NotifyObj:

Data Fields
List_Elem	link
BatteryMonitor_NotifyFxn	notifyFxn
uint16_t	thresholdHigh
uint16_t	thresholdLow
uintptr_t	clientArg
bool	isRegistered

Detailed Description

Battery Monitor notify object structure.

This structure specification is for internal use. Notification clients must pre-allocate a notify object when registering for a notification; BatteryMonitor_registerNotifyHigh(), BatteryMonitor_registerNotifyLow(), or BatteryMonitor_registerNotifyRange() will take care initializing the internal elements appropriately.

Field Documentation

link

List_Elem BatteryMonitor_NotifyObj::link

For placing on the notify list

notifyFxn

BatteryMonitor_NotifyFxn BatteryMonitor_NotifyObj::notifyFxn

Application callback function

Referenced by BatteryMonitor_getNotifyFxn().

thresholdHigh

uint16_t BatteryMonitor_NotifyObj::thresholdHigh

High threshold in millivolts

Referenced by BatteryMonitor_getThresholdHigh(), and BatteryMonitor_getThresholdRange().

thresholdLow

uint16_t BatteryMonitor_NotifyObj::thresholdLow

Low threshold in millivolts

Referenced by BatteryMonitor_getThresholdLow(), and BatteryMonitor_getThresholdRange().

clientArg

uintptr_t BatteryMonitor_NotifyObj::clientArg

Application provided arg

Referenced by BatteryMonitor_getClientArg().

isRegistered

bool BatteryMonitor_NotifyObj::isRegistered

Is the notification active

---

The documentation for this struct was generated from the following file:

• BatteryMonitor.h