pebble
Privacy
Cookies
Publish

Pebble C API

BatteryStateService

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.

Function

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

void battery_state_service_unsubscribe(void)

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

BatteryChargeState battery_state_service_peek(void)

Peek at the last known battery state.

Returns

a BatteryChargeState containing the last known data

Data Structure

struct BatteryChargeState

Structure for retrieval of the battery charge state.

Data Fields

uint8_t charge_percent

A percentage (0-100) of how full the battery is.

bool is_charging

True if the battery is currently being charged. False if not.

bool is_plugged

True if the charger cable is connected. False if not.

Typedef

typedef void(* BatteryStateHandler)(BatteryChargeState charge)

Callback type for battery state change events.

Parameters

charge

the state of the battery BatteryChargeState