mirror of
https://github.com/google/pebble.git
synced 2025-05-04 08:51:41 -04:00
60 lines
2.2 KiB
C
60 lines
2.2 KiB
C
/*
|
|
* Copyright 2024 Google LLC
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "services/common/battery/battery_monitor.h"
|
|
|
|
//! @addtogroup Foundation
|
|
//! @{
|
|
//! @addtogroup EventService
|
|
//! @{
|
|
//! @addtogroup BatteryStateService
|
|
//!
|
|
//! \brief 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 <a href="https://github.com/pebble-examples/classio-battery-connection">
|
|
//! classio-battery-connection</a> example, which demonstrates using the battery state service
|
|
//! in a watchface.
|
|
//! @{
|
|
|
|
//! Callback type for battery state change events
|
|
//! @param charge the state of the battery \ref BatteryChargeState
|
|
typedef void (*BatteryStateHandler)(BatteryChargeState charge);
|
|
|
|
|
|
//! Subscribe to the battery state event service. Once subscribed, the handler gets called
|
|
//! on every battery state change
|
|
//! @param handler A callback to be executed on battery state change event
|
|
void battery_state_service_subscribe(BatteryStateHandler handler);
|
|
|
|
//! Unsubscribe from the battery state event service. Once unsubscribed, the previously registered
|
|
//! handler will no longer be called.
|
|
void battery_state_service_unsubscribe(void);
|
|
|
|
//! Peek at the last known battery state.
|
|
//! @return a \ref BatteryChargeState containing the last known data
|
|
BatteryChargeState battery_state_service_peek(void);
|
|
|
|
//! @} // end addtogroup PEBBLE_BATTERY_STATE_CHANGE_EVENT
|
|
//! @} // end addtogroup EventService
|
|
//! @} // end addtogroup Foundation
|
|
|
|
|