Lee Kai Xuan / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-os by erkin yucel

features/FEATURE_BLE/ble/services/BatteryService.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 #ifndef __BLE_BATTERY_SERVICE_H__
elessair 0:f269e3021894 18 #define __BLE_BATTERY_SERVICE_H__
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 #include "ble/BLE.h"
elessair 0:f269e3021894 21
elessair 0:f269e3021894 22 /**
elessair 0:f269e3021894 23 * @class BatteryService
elessair 0:f269e3021894 24 * @brief BLE Battery Service. This service displays the battery level from 0% to 100%, represented as an 8bit number.
elessair 0:f269e3021894 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml
elessair 0:f269e3021894 26 * Battery Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.battery_level.xml
elessair 0:f269e3021894 27 */
elessair 0:f269e3021894 28 class BatteryService {
elessair 0:f269e3021894 29 public:
elessair 0:f269e3021894 30 /**
elessair 0:f269e3021894 31 * @param[in] _ble
elessair 0:f269e3021894 32 * BLE object for the underlying controller.
elessair 0:f269e3021894 33 * @param[in] level
elessair 0:f269e3021894 34 * 8bit batterly level. Usually used to represent percentage of batterly charge remaining.
elessair 0:f269e3021894 35 */
elessair 0:f269e3021894 36 BatteryService(BLE &_ble, uint8_t level = 100) :
elessair 0:f269e3021894 37 ble(_ble),
elessair 0:f269e3021894 38 batteryLevel(level),
elessair 0:f269e3021894 39 batteryLevelCharacteristic(GattCharacteristic::UUID_BATTERY_LEVEL_CHAR, &batteryLevel, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY) {
elessair 0:f269e3021894 40
elessair 0:f269e3021894 41 GattCharacteristic *charTable[] = {&batteryLevelCharacteristic};
elessair 0:f269e3021894 42 GattService batteryService(GattService::UUID_BATTERY_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44 ble.addService(batteryService);
elessair 0:f269e3021894 45 }
elessair 0:f269e3021894 46
elessair 0:f269e3021894 47 /**
elessair 0:f269e3021894 48 * @brief Update the battery level with a new value. Valid values lie between 0 and 100,
elessair 0:f269e3021894 49 * anything outside this range will be ignored.
elessair 0:f269e3021894 50 *
elessair 0:f269e3021894 51 * @param newLevel
elessair 0:f269e3021894 52 * Update to battery level.
elessair 0:f269e3021894 53 */
elessair 0:f269e3021894 54 void updateBatteryLevel(uint8_t newLevel) {
elessair 0:f269e3021894 55 batteryLevel = newLevel;
elessair 0:f269e3021894 56 ble.gattServer().write(batteryLevelCharacteristic.getValueHandle(), &batteryLevel, 1);
elessair 0:f269e3021894 57 }
elessair 0:f269e3021894 58
elessair 0:f269e3021894 59 protected:
elessair 0:f269e3021894 60 /**
elessair 0:f269e3021894 61 * A reference to the underlying BLE instance that this object is attached to.
elessair 0:f269e3021894 62 * The services and characteristics will be registered in this BLE instance.
elessair 0:f269e3021894 63 */
elessair 0:f269e3021894 64 BLE &ble;
elessair 0:f269e3021894 65
elessair 0:f269e3021894 66 /**
elessair 0:f269e3021894 67 * The current battery level represented as an integer from 0% to 100%.
elessair 0:f269e3021894 68 */
elessair 0:f269e3021894 69 uint8_t batteryLevel;
elessair 0:f269e3021894 70 /**
elessair 0:f269e3021894 71 * A ReadOnlyGattCharacteristic that allows access to the peer device to the
elessair 0:f269e3021894 72 * batteryLevel value through BLE.
elessair 0:f269e3021894 73 */
elessair 0:f269e3021894 74 ReadOnlyGattCharacteristic<uint8_t> batteryLevelCharacteristic;
elessair 0:f269e3021894 75 };
elessair 0:f269e3021894 76
elessair 0:f269e3021894 77 #endif /* #ifndef __BLE_BATTERY_SERVICE_H__*/