Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

features/FEATURE_BLE/ble/services/BatteryService.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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