Joshua Slater / BLE_API

Changed URIBeaconConfigService.h to work with ST board

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

BatteryService Class Reference
Public Member Functions

BatteryService Class Reference

BLE Battery Service. More...

#include <BatteryService.h>

Public Member Functions

 BatteryService (BLE &_ble, uint8_t level=100)
void updateBatteryLevel (uint8_t newLevel)
 Update the battery level with a new value.

Detailed Description

BLE Battery Service.

This service displays the battery level from 0->100% represented as a 8bit number.
Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml
Battery Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.battery_level.xml

Definition at line 28 of file BatteryService.h.

Constructor & Destructor Documentation

BatteryService ( BLE &  _ble,
uint8_t  level = 100 
)
Parameters:
ref]_ble BLE object for the underlying controller.
[in]level8bit batterly level. Usually used to represent percentage of batterly charge remaining.

Definition at line 36 of file BatteryService.h.

Member Function Documentation

void updateBatteryLevel ( uint8_t  newLevel )

Update the battery level with a new value.

Valid values range from 0..100. Anything outside this range will be ignored.

Parameters:
newLevelupdate to battery level.

Definition at line 54 of file BatteryService.h.

Generated on Tue Jul 12 2022 18:14:55 by  doxygen 1.7.2