long dao / BLE_API

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 BLE_API by Bluetooth Low Energy

services/HeartRateService.h@242:0e9201b67e2f, 2014-12-09 (annotated)

Committer:
rgrover1
Date:
Tue Dec 09 08:18:11 2014 +0000
Revision:
242:0e9201b67e2f
Parent:
234:aac647674384
Child:
243:98f930d14515
Synchronized with git rev c7eb83db

Author: Rohit Grover

minor white space diffs and fixes for typos.

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_HEART_RATE_SERVICE_H__
Rohit Grover 118:620d28e7a1ba 18 #define __BLE_HEART_RATE_SERVICE_H__
Rohit Grover 118:620d28e7a1ba 19
Rohit Grover 118:620d28e7a1ba 20 #include "BLEDevice.h"
Rohit Grover 118:620d28e7a1ba 21
rgrover1 242:0e9201b67e2f 22 /**
mbedAustin 234:aac647674384 23 * @class HeartRateService
rgrover1 242:0e9201b67e2f 24 * @brief BLE Service for HeartRate. This BLE Service contains the location of the sensor, the heartrate in beats per minute. <br>
mbedAustin 234:aac647674384 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.heart_rate.xml <br>
mbedAustin 234:aac647674384 26 * HRM Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml <br>
rgrover1 242:0e9201b67e2f 27 * Location: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.body_sensor_location.xml
mbedAustin 234:aac647674384 28 */
Rohit Grover 118:620d28e7a1ba 29 class HeartRateService {
Rohit Grover 118:620d28e7a1ba 30 public:
mbedAustin 234:aac647674384 31 /**
mbedAustin 234:aac647674384 32 * @enum SensorLocation
rgrover1 242:0e9201b67e2f 33 * @brief Location of HeartRate sensor on body.
mbedAustin 234:aac647674384 34 */
Rohit Grover 118:620d28e7a1ba 35 enum {
mbedAustin 234:aac647674384 36 LOCATION_OTHER = 0, /*!< Other Location */
mbedAustin 234:aac647674384 37 LOCATION_CHEST, /*!< Chest */
mbedAustin 234:aac647674384 38 LOCATION_WRIST, /*!< Wrist */
mbedAustin 234:aac647674384 39 LOCATION_FINGER, /*!< Finger */
mbedAustin 234:aac647674384 40 LOCATION_HAND, /*!< Hand */
mbedAustin 234:aac647674384 41 LOCATION_EAR_LOBE, /*!< Earlobe */
mbedAustin 234:aac647674384 42 LOCATION_FOOT, /*!< Foot */
Rohit Grover 118:620d28e7a1ba 43 };
Rohit Grover 118:620d28e7a1ba 44
Rohit Grover 118:620d28e7a1ba 45 public:
Rohit Grover 118:620d28e7a1ba 46 /**
rgrover1 242:0e9201b67e2f 47 * @brief Constructor with 8bit HRM Counter value.
Rohit Grover 118:620d28e7a1ba 48 *
mbedAustin 234:aac647674384 49 * @param[ref] _ble
Rohit Grover 118:620d28e7a1ba 50 * Reference to the underlying BLEDevice.
mbedAustin 234:aac647674384 51 * @param[in] hrmCounter (8-bit)
Rohit Grover 118:620d28e7a1ba 52 * initial value for the hrm counter.
mbedAustin 234:aac647674384 53 * @param[in] location
Rohit Grover 118:620d28e7a1ba 54 * Sensor's location.
Rohit Grover 118:620d28e7a1ba 55 */
Rohit Grover 118:620d28e7a1ba 56 HeartRateService(BLEDevice &_ble, uint8_t hrmCounter, uint8_t location) :
Rohit Grover 118:620d28e7a1ba 57 ble(_ble),
Rohit Grover 118:620d28e7a1ba 58 valueBytes(hrmCounter),
Rohit Grover 118:620d28e7a1ba 59 hrmRate(GattCharacteristic::UUID_HEART_RATE_MEASUREMENT_CHAR, valueBytes.getPointer(),
Rohit Grover 118:620d28e7a1ba 60 valueBytes.getNumValueBytes(), HeartRateValueBytes::MAX_VALUE_BYTES,
Rohit Grover 118:620d28e7a1ba 61 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
Rohit Grover 118:620d28e7a1ba 62 hrmLocation(GattCharacteristic::UUID_BODY_SENSOR_LOCATION_CHAR, (uint8_t *)&location, sizeof(location), sizeof(location),
Rohit Grover 118:620d28e7a1ba 63 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
Rohit Grover 118:620d28e7a1ba 64 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, (uint8_t *)&controlPointValue,
Rohit Grover 118:620d28e7a1ba 65 sizeof(controlPointValue), sizeof(controlPointValue), GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE) {
Rohit Grover 118:620d28e7a1ba 66 setupService();
Rohit Grover 118:620d28e7a1ba 67 }
Rohit Grover 118:620d28e7a1ba 68
Rohit Grover 118:620d28e7a1ba 69 /**
rgrover1 242:0e9201b67e2f 70 * @brief Constructor with a 16-bit HRM Counter value.
mbedAustin 234:aac647674384 71 *
mbedAustin 234:aac647674384 72 * @param[in] _ble
mbedAustin 234:aac647674384 73 * Reference to the underlying BLEDevice.
mbedAustin 234:aac647674384 74 * @param[in] hrmCounter (8-bit)
mbedAustin 234:aac647674384 75 * initial value for the hrm counter.
mbedAustin 234:aac647674384 76 * @param[in] location
mbedAustin 234:aac647674384 77 * Sensor's location.
Rohit Grover 118:620d28e7a1ba 78 */
Rohit Grover 118:620d28e7a1ba 79 HeartRateService(BLEDevice &_ble, uint16_t hrmCounter, uint8_t location) :
Rohit Grover 118:620d28e7a1ba 80 ble(_ble),
Rohit Grover 118:620d28e7a1ba 81 valueBytes(hrmCounter),
Rohit Grover 118:620d28e7a1ba 82 hrmRate(GattCharacteristic::UUID_HEART_RATE_MEASUREMENT_CHAR, valueBytes.getPointer(),
Rohit Grover 118:620d28e7a1ba 83 valueBytes.getNumValueBytes(), HeartRateValueBytes::MAX_VALUE_BYTES,
Rohit Grover 118:620d28e7a1ba 84 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
Rohit Grover 118:620d28e7a1ba 85 hrmLocation(GattCharacteristic::UUID_BODY_SENSOR_LOCATION_CHAR, (uint8_t *)&location, sizeof(location), sizeof(location),
Rohit Grover 118:620d28e7a1ba 86 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
Rohit Grover 118:620d28e7a1ba 87 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, (uint8_t *)&controlPointValue,
Rohit Grover 118:620d28e7a1ba 88 sizeof(controlPointValue), sizeof(controlPointValue), GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE) {
Rohit Grover 118:620d28e7a1ba 89 setupService();
Rohit Grover 118:620d28e7a1ba 90 }
Rohit Grover 118:620d28e7a1ba 91
Rohit Grover 118:620d28e7a1ba 92 /**
rgrover1 242:0e9201b67e2f 93 * @brief Set a new 8-bit value for heart rate.
mbedAustin 234:aac647674384 94 *
mbedAustin 234:aac647674384 95 * @param[in] hrmCounter
rgrover1 242:0e9201b67e2f 96 * HeartRate in bpm.
Rohit Grover 118:620d28e7a1ba 97 */
Rohit Grover 118:620d28e7a1ba 98 void updateHeartRate(uint8_t hrmCounter) {
Rohit Grover 118:620d28e7a1ba 99 valueBytes.updateHeartRate(hrmCounter);
Rohit Grover 118:620d28e7a1ba 100 ble.updateCharacteristicValue(hrmRate.getValueAttribute().getHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
Rohit Grover 118:620d28e7a1ba 101 }
Rohit Grover 118:620d28e7a1ba 102
Rohit Grover 118:620d28e7a1ba 103 /**
Rohit Grover 118:620d28e7a1ba 104 * Set a new 16-bit value for heart rate.
mbedAustin 234:aac647674384 105 *
mbedAustin 234:aac647674384 106 * @param[in] hrmCounter
rgrover1 242:0e9201b67e2f 107 * HeartRate in bpm.
Rohit Grover 118:620d28e7a1ba 108 */
Rohit Grover 118:620d28e7a1ba 109 void updateHeartRate(uint16_t hrmCounter) {
Rohit Grover 118:620d28e7a1ba 110 valueBytes.updateHeartRate(hrmCounter);
Rohit Grover 118:620d28e7a1ba 111 ble.updateCharacteristicValue(hrmRate.getValueAttribute().getHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
Rohit Grover 118:620d28e7a1ba 112 }
Rohit Grover 118:620d28e7a1ba 113
Rohit Grover 118:620d28e7a1ba 114 /**
Rohit Grover 123:fede41ce9407 115 * This callback allows the HeartRateService to receive updates to the
Rohit Grover 123:fede41ce9407 116 * controlPoint Characteristic.
rgrover1 242:0e9201b67e2f 117 *
Rohit Grover 118:620d28e7a1ba 118 */
Rohit Grover 118:620d28e7a1ba 119 virtual void onDataWritten(const GattCharacteristicWriteCBParams *params) {
Rohit Grover 118:620d28e7a1ba 120 if (params->charHandle == controlPoint.getValueAttribute().getHandle()) {
Rohit Grover 118:620d28e7a1ba 121 /* Do something here if the new value is 1; else you can override this method by
Rohit Grover 118:620d28e7a1ba 122 * extending this class.
Rohit Grover 118:620d28e7a1ba 123 * @NOTE: if you are extending this class, be sure to also call
Rohit Grover 118:620d28e7a1ba 124 * ble.onDataWritten(this, &ExtendedHRService::onDataWritten); in
Rohit Grover 118:620d28e7a1ba 125 * your constructor.
Rohit Grover 118:620d28e7a1ba 126 */
Rohit Grover 118:620d28e7a1ba 127 }
Rohit Grover 118:620d28e7a1ba 128 }
Rohit Grover 118:620d28e7a1ba 129
Rohit Grover 118:620d28e7a1ba 130 private:
Rohit Grover 118:620d28e7a1ba 131 void setupService(void) {
Rohit Grover 118:620d28e7a1ba 132 static bool serviceAdded = false; /* We should only ever need to add the heart rate service once. */
Rohit Grover 118:620d28e7a1ba 133 if (serviceAdded) {
Rohit Grover 118:620d28e7a1ba 134 return;
Rohit Grover 118:620d28e7a1ba 135 }
Rohit Grover 118:620d28e7a1ba 136
Rohit Grover 118:620d28e7a1ba 137 GattCharacteristic *charTable[] = {&hrmRate, &hrmLocation, &controlPoint};
Rohit Grover 118:620d28e7a1ba 138 GattService hrmService(GattService::UUID_HEART_RATE_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
Rohit Grover 118:620d28e7a1ba 139
Rohit Grover 118:620d28e7a1ba 140 ble.addService(hrmService);
Rohit Grover 118:620d28e7a1ba 141 serviceAdded = true;
Rohit Grover 118:620d28e7a1ba 142
Rohit Grover 118:620d28e7a1ba 143 ble.onDataWritten(this, &HeartRateService::onDataWritten);
Rohit Grover 118:620d28e7a1ba 144 }
Rohit Grover 118:620d28e7a1ba 145
Rohit Grover 118:620d28e7a1ba 146 private:
Rohit Grover 118:620d28e7a1ba 147 /* Private internal representation for the bytes used to work with the vaulue of the heart-rate characteristic. */
Rohit Grover 118:620d28e7a1ba 148 struct HeartRateValueBytes {
Rohit Grover 118:620d28e7a1ba 149 static const unsigned MAX_VALUE_BYTES = 3; /* FLAGS + up to two bytes for heart-rate */
Rohit Grover 118:620d28e7a1ba 150 static const unsigned FLAGS_BYTE_INDEX = 0;
Rohit Grover 118:620d28e7a1ba 151
Rohit Grover 118:620d28e7a1ba 152 static const unsigned VALUE_FORMAT_BITNUM = 0;
Rohit Grover 118:620d28e7a1ba 153 static const uint8_t VALUE_FORMAT_FLAG = (1 << VALUE_FORMAT_BITNUM);
Rohit Grover 118:620d28e7a1ba 154
Rohit Grover 118:620d28e7a1ba 155 HeartRateValueBytes(uint8_t hrmCounter) : valueBytes() {
Rohit Grover 118:620d28e7a1ba 156 updateHeartRate(hrmCounter);
Rohit Grover 118:620d28e7a1ba 157 }
Rohit Grover 118:620d28e7a1ba 158
Rohit Grover 118:620d28e7a1ba 159 HeartRateValueBytes(uint16_t hrmCounter) : valueBytes() {
Rohit Grover 118:620d28e7a1ba 160 updateHeartRate(hrmCounter);
Rohit Grover 118:620d28e7a1ba 161 }
Rohit Grover 118:620d28e7a1ba 162
Rohit Grover 118:620d28e7a1ba 163 void updateHeartRate(uint8_t hrmCounter) {
rgrover1 242:0e9201b67e2f 164 valueBytes[FLAGS_BYTE_INDEX] &= ~VALUE_FORMAT_FLAG;
Rohit Grover 118:620d28e7a1ba 165 valueBytes[FLAGS_BYTE_INDEX + 1] = hrmCounter;
Rohit Grover 118:620d28e7a1ba 166 }
Rohit Grover 118:620d28e7a1ba 167
Rohit Grover 118:620d28e7a1ba 168 void updateHeartRate(uint16_t hrmCounter) {
rgrover1 242:0e9201b67e2f 169 valueBytes[FLAGS_BYTE_INDEX] |= VALUE_FORMAT_FLAG;
Rohit Grover 118:620d28e7a1ba 170 valueBytes[FLAGS_BYTE_INDEX + 1] = (uint8_t)(hrmCounter & 0xFF);
Rohit Grover 118:620d28e7a1ba 171 valueBytes[FLAGS_BYTE_INDEX + 2] = (uint8_t)(hrmCounter >> 8);
Rohit Grover 118:620d28e7a1ba 172 }
Rohit Grover 118:620d28e7a1ba 173
rgrover1 242:0e9201b67e2f 174 uint8_t *getPointer(void) {
Rohit Grover 118:620d28e7a1ba 175 return valueBytes;
Rohit Grover 118:620d28e7a1ba 176 }
Rohit Grover 118:620d28e7a1ba 177
Rohit Grover 118:620d28e7a1ba 178 const uint8_t *getPointer(void) const {
Rohit Grover 118:620d28e7a1ba 179 return valueBytes;
Rohit Grover 118:620d28e7a1ba 180 }
Rohit Grover 118:620d28e7a1ba 181
rgrover1 242:0e9201b67e2f 182 unsigned getNumValueBytes(void) const {
Rohit Grover 118:620d28e7a1ba 183 return 1 + ((valueBytes[FLAGS_BYTE_INDEX] & VALUE_FORMAT_FLAG) ? sizeof(uint16_t) : sizeof(uint8_t));
Rohit Grover 118:620d28e7a1ba 184 }
Rohit Grover 118:620d28e7a1ba 185
rgrover1 242:0e9201b67e2f 186 private:
Rohit Grover 118:620d28e7a1ba 187 /* First byte = 8-bit values, no extra info, Second byte = uint8_t HRM value */
Rohit Grover 118:620d28e7a1ba 188 /* See --> https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml */
Rohit Grover 118:620d28e7a1ba 189 uint8_t valueBytes[MAX_VALUE_BYTES];
Rohit Grover 118:620d28e7a1ba 190 };
Rohit Grover 118:620d28e7a1ba 191
Rohit Grover 118:620d28e7a1ba 192 private:
Rohit Grover 118:620d28e7a1ba 193 BLEDevice &ble;
Rohit Grover 118:620d28e7a1ba 194 HeartRateValueBytes valueBytes;
Rohit Grover 118:620d28e7a1ba 195 uint8_t controlPointValue;
Rohit Grover 118:620d28e7a1ba 196 GattCharacteristic hrmRate;
Rohit Grover 118:620d28e7a1ba 197 GattCharacteristic hrmLocation;
Rohit Grover 118:620d28e7a1ba 198 GattCharacteristic controlPoint;
Rohit Grover 118:620d28e7a1ba 199 };
Rohit Grover 118:620d28e7a1ba 200
rgrover1 242:0e9201b67e2f 201 #endif /* #ifndef __BLE_HEART_RATE_SERVICE_H__*/