Sam Musso / BLE_API

I don't know why this is happening.

Fork of BLE_API by Bluetooth Low Energy

services/BatteryService.h@238:905d6fc17fda, 2014-12-08 (annotated)

Committer:
mbedAustin
Date:
Mon Dec 08 20:24:12 2014 +0000
Revision:
238:905d6fc17fda
Parent:
118:620d28e7a1ba
Child:
242:0e9201b67e2f
Added doxygen fixes to show BatteryService.h documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 118:620d28e7a1ba 1 /* mbed Microcontroller Library
Rohit Grover 118:620d28e7a1ba 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 118:620d28e7a1ba 3 *
Rohit Grover 118:620d28e7a1ba 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 118:620d28e7a1ba 5 * you may not use this file except in compliance with the License.
Rohit Grover 118:620d28e7a1ba 6 * You may obtain a copy of the License at
Rohit Grover 118:620d28e7a1ba 7 *
Rohit Grover 118:620d28e7a1ba 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 118:620d28e7a1ba 9 *
Rohit Grover 118:620d28e7a1ba 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 118:620d28e7a1ba 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 118:620d28e7a1ba 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 118:620d28e7a1ba 13 * See the License for the specific language governing permissions and
Rohit Grover 118:620d28e7a1ba 14 * limitations under the License.
Rohit Grover 118:620d28e7a1ba 15 */
Rohit Grover 118:620d28e7a1ba 16
Rohit Grover 118:620d28e7a1ba 17 #ifndef __BLE_BATTERY_SERVICE_H__
Rohit Grover 118:620d28e7a1ba 18 #define __BLE_BATTERY_SERVICE_H__
Rohit Grover 118:620d28e7a1ba 19
Rohit Grover 118:620d28e7a1ba 20 #include "BLEDevice.h"
Rohit Grover 118:620d28e7a1ba 21
mbedAustin 238:905d6fc17fda 22 /**
mbedAustin 238:905d6fc17fda 23 * @class BatteryService
mbedAustin 238:905d6fc17fda 24 * @breif BLE Battery Service. This service displays the battery level from 0%->100% represented as a 8bit number.<br>
mbedAustin 238:905d6fc17fda 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml <br>
mbedAustin 238:905d6fc17fda 26 * Battery Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.battery_level.xml
mbedAustin 238:905d6fc17fda 27 */
Rohit Grover 118:620d28e7a1ba 28 class BatteryService {
Rohit Grover 118:620d28e7a1ba 29 public:
mbedAustin 238:905d6fc17fda 30 /**
mbedAustin 238:905d6fc17fda 31 * @param[ref] _ble
mbedAustin 238:905d6fc17fda 32 * BLEDevice object for the underlying controller.
mbedAustin 238:905d6fc17fda 33 * @param[in] level
mbedAustin 238:905d6fc17fda 34 * 8bit batterly level. Usually used to represent percentage of batterly charge remaining.
mbedAustin 238:905d6fc17fda 35 */
Rohit Grover 118:620d28e7a1ba 36 BatteryService(BLEDevice &_ble, uint8_t level = 100) :
Rohit Grover 118:620d28e7a1ba 37 ble(_ble),
Rohit Grover 118:620d28e7a1ba 38 batteryLevel(level),
Rohit Grover 118:620d28e7a1ba 39 batteryLevelCharacteristic(GattCharacteristic::UUID_BATTERY_LEVEL_CHAR, &batteryLevel, sizeof(batteryLevel), sizeof(batteryLevel),
Rohit Grover 118:620d28e7a1ba 40 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY) {
Rohit Grover 118:620d28e7a1ba 41
Rohit Grover 118:620d28e7a1ba 42 static bool serviceAdded = false; /* We should only ever need to add the heart rate service once. */
Rohit Grover 118:620d28e7a1ba 43 if (serviceAdded) {
Rohit Grover 118:620d28e7a1ba 44 return;
Rohit Grover 118:620d28e7a1ba 45 }
Rohit Grover 118:620d28e7a1ba 46
Rohit Grover 118:620d28e7a1ba 47 GattCharacteristic *charTable[] = {&batteryLevelCharacteristic};
Rohit Grover 118:620d28e7a1ba 48 GattService batteryService(GattService::UUID_BATTERY_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
Rohit Grover 118:620d28e7a1ba 49
Rohit Grover 118:620d28e7a1ba 50 ble.addService(batteryService);
Rohit Grover 118:620d28e7a1ba 51 serviceAdded = true;
Rohit Grover 118:620d28e7a1ba 52 }
Rohit Grover 118:620d28e7a1ba 53
Rohit Grover 118:620d28e7a1ba 54 /**
mbedAustin 238:905d6fc17fda 55 * @breif Update the battery level with a new value. Valid values range from
Rohit Grover 118:620d28e7a1ba 56 * 0..100. Anything outside this range will be ignored.
mbedAustin 238:905d6fc17fda 57 *
mbedAustin 238:905d6fc17fda 58 * @param newLevel
mbedAustin 238:905d6fc17fda 59 * update to battery level.
Rohit Grover 118:620d28e7a1ba 60 */
Rohit Grover 118:620d28e7a1ba 61 void updateBatteryLevel(uint8_t newLevel) {
Rohit Grover 118:620d28e7a1ba 62 batteryLevel = newLevel;
Rohit Grover 118:620d28e7a1ba 63 ble.updateCharacteristicValue(batteryLevelCharacteristic.getValueAttribute().getHandle(), &batteryLevel, 1);
Rohit Grover 118:620d28e7a1ba 64 }
Rohit Grover 118:620d28e7a1ba 65
Rohit Grover 118:620d28e7a1ba 66 private:
Rohit Grover 118:620d28e7a1ba 67 BLEDevice &ble;
Rohit Grover 118:620d28e7a1ba 68 uint8_t batteryLevel;
Rohit Grover 118:620d28e7a1ba 69 GattCharacteristic batteryLevelCharacteristic;
Rohit Grover 118:620d28e7a1ba 70 };
Rohit Grover 118:620d28e7a1ba 71
Rohit Grover 118:620d28e7a1ba 72 #endif /* #ifndef __BLE_BATTERY_SERVICE_H__*/