BatteryStateService

Determines when the battery state changes. More...

Collaboration diagram for BatteryStateService:

Classes
struct	BatteryChargeState
	Structure for retrieval of the battery charge state. More...

Typedefs
typedef void(*	BatteryStateHandler) (BatteryChargeState charge)
typedef void(*	BatteryStateHandler) (BatteryChargeState charge)

Functions
void	battery_state_service_subscribe (BatteryStateHandler handler)
void	battery_state_service_unsubscribe (void)
BatteryChargeState	battery_state_service_peek (void)

Detailed Description

Determines when the battery state changes.

The BatteryStateService API lets you know when the battery state changes, that is, its current charge level, whether it is plugged and charging. It uses the BatteryChargeState structure to describe the current power state of Pebble.

Refer to the classio-battery-connection example, which demonstrates using the battery state service in a watchface.

Typedef Documentation

BatteryStateHandler [1/2]

typedef void(* BatteryStateHandler) (BatteryChargeState charge)

Callback type for battery state change events

Parameters

charge

the state of the battery BatteryChargeState

BatteryStateHandler [2/2]

typedef void(* BatteryStateHandler) (BatteryChargeState charge)

Callback type for battery state change events

Parameters

charge

the state of the battery BatteryChargeState

Function Documentation

battery_state_service_peek()

BatteryChargeState battery_state_service_peek

(

void

)

Peek at the last known battery state.

Returns

a BatteryChargeState containing the last known data

battery_state_service_subscribe()

void battery_state_service_subscribe

(

BatteryStateHandler

handler

)

Subscribe to the battery state event service. Once subscribed, the handler gets called on every battery state change

Parameters

handler

A callback to be executed on battery state change event

battery_state_service_unsubscribe()

void battery_state_service_unsubscribe

(

void

)

Unsubscribe from the battery state event service. Once unsubscribed, the previously registered handler will no longer be called.