Paulo Roman / BLE_API

BLE FORK

Fork of BLE_API by Bluetooth Low Energy

ble/services/HeartRateService.h@1131:4d921282c434, 2016-10-26 (annotated)

Committer:
paulocroman
Date:
Wed Oct 26 00:18:34 2016 +0000
Revision:
1131:4d921282c434
Parent:
728:997ba5e7b3b6 
PPG BLE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 712:b04b5db36865 1 /* mbed Microcontroller Library
rgrover1 712:b04b5db36865 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 712:b04b5db36865 3 *
rgrover1 712:b04b5db36865 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 712:b04b5db36865 5 * you may not use this file except in compliance with the License.
rgrover1 712:b04b5db36865 6 * You may obtain a copy of the License at
rgrover1 712:b04b5db36865 7 *
rgrover1 712:b04b5db36865 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 712:b04b5db36865 9 *
rgrover1 712:b04b5db36865 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 712:b04b5db36865 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 712:b04b5db36865 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 712:b04b5db36865 13 * See the License for the specific language governing permissions and
rgrover1 712:b04b5db36865 14 * limitations under the License.
rgrover1 712:b04b5db36865 15 */
rgrover1 712:b04b5db36865 16
rgrover1 712:b04b5db36865 17 #ifndef __BLE_HEART_RATE_SERVICE_H__
rgrover1 712:b04b5db36865 18 #define __BLE_HEART_RATE_SERVICE_H__
rgrover1 712:b04b5db36865 19
rgrover1 712:b04b5db36865 20 #include "ble/BLE.h"
rgrover1 712:b04b5db36865 21
rgrover1 712:b04b5db36865 22 /**
rgrover1 712:b04b5db36865 23 * @class HeartRateService
rgrover1 712:b04b5db36865 24 * @brief BLE Service for HeartRate. This BLE Service contains the location of the sensor, the heartrate in beats per minute. <br>
rgrover1 712:b04b5db36865 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.heart_rate.xml <br>
rgrover1 712:b04b5db36865 26 * HRM Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml <br>
rgrover1 712:b04b5db36865 27 * Location: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.body_sensor_location.xml
rgrover1 712:b04b5db36865 28 */
rgrover1 712:b04b5db36865 29 class HeartRateService {
rgrover1 712:b04b5db36865 30 public:
rgrover1 712:b04b5db36865 31 /**
rgrover1 712:b04b5db36865 32 * @enum SensorLocation
rgrover1 712:b04b5db36865 33 * @brief Location of HeartRate sensor on body.
rgrover1 712:b04b5db36865 34 */
rgrover1 712:b04b5db36865 35 enum {
rgrover1 712:b04b5db36865 36 LOCATION_OTHER = 0, /*!< Other Location */
rgrover1 712:b04b5db36865 37 LOCATION_CHEST, /*!< Chest */
rgrover1 712:b04b5db36865 38 LOCATION_WRIST, /*!< Wrist */
rgrover1 712:b04b5db36865 39 LOCATION_FINGER, /*!< Finger */
rgrover1 712:b04b5db36865 40 LOCATION_HAND, /*!< Hand */
rgrover1 712:b04b5db36865 41 LOCATION_EAR_LOBE, /*!< Earlobe */
rgrover1 712:b04b5db36865 42 LOCATION_FOOT, /*!< Foot */
rgrover1 712:b04b5db36865 43 };
rgrover1 712:b04b5db36865 44
rgrover1 712:b04b5db36865 45 public:
rgrover1 712:b04b5db36865 46 /**
rgrover1 712:b04b5db36865 47 * @brief Constructor with 8bit HRM Counter value.
rgrover1 712:b04b5db36865 48 *
rgrover1 712:b04b5db36865 49 * @param[ref] _ble
rgrover1 712:b04b5db36865 50 * Reference to the underlying BLE.
rgrover1 712:b04b5db36865 51 * @param[in] hrmCounter (8-bit)
rgrover1 712:b04b5db36865 52 * initial value for the hrm counter.
rgrover1 712:b04b5db36865 53 * @param[in] location
rgrover1 712:b04b5db36865 54 * Sensor's location.
rgrover1 712:b04b5db36865 55 */
rgrover1 712:b04b5db36865 56 HeartRateService(BLE &_ble, uint8_t hrmCounter, uint8_t location) :
rgrover1 712:b04b5db36865 57 ble(_ble),
rgrover1 712:b04b5db36865 58 valueBytes(hrmCounter),
rgrover1 712:b04b5db36865 59 hrmRate(GattCharacteristic::UUID_HEART_RATE_MEASUREMENT_CHAR, valueBytes.getPointer(),
rgrover1 712:b04b5db36865 60 valueBytes.getNumValueBytes(), HeartRateValueBytes::MAX_VALUE_BYTES,
rgrover1 712:b04b5db36865 61 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
rgrover1 712:b04b5db36865 62 hrmLocation(GattCharacteristic::UUID_BODY_SENSOR_LOCATION_CHAR, &location),
rgrover1 712:b04b5db36865 63 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) {
rgrover1 712:b04b5db36865 64 setupService();
rgrover1 712:b04b5db36865 65 }
rgrover1 712:b04b5db36865 66
rgrover1 712:b04b5db36865 67 /**
rgrover1 712:b04b5db36865 68 * @brief Constructor with a 16-bit HRM Counter value.
rgrover1 712:b04b5db36865 69 *
rgrover1 712:b04b5db36865 70 * @param[in] _ble
rgrover1 712:b04b5db36865 71 * Reference to the underlying BLE.
rgrover1 712:b04b5db36865 72 * @param[in] hrmCounter (8-bit)
rgrover1 712:b04b5db36865 73 * initial value for the hrm counter.
rgrover1 712:b04b5db36865 74 * @param[in] location
rgrover1 712:b04b5db36865 75 * Sensor's location.
rgrover1 712:b04b5db36865 76 */
paulocroman 1131:4d921282c434 77 HeartRateService(BLE &_ble, uint16_t v1, uint16_t v2, uint8_t location) :
rgrover1 712:b04b5db36865 78 ble(_ble),
paulocroman 1131:4d921282c434 79 valueBytes(v1,v2),
rgrover1 712:b04b5db36865 80 hrmRate(GattCharacteristic::UUID_HEART_RATE_MEASUREMENT_CHAR, valueBytes.getPointer(),
rgrover1 712:b04b5db36865 81 valueBytes.getNumValueBytes(), HeartRateValueBytes::MAX_VALUE_BYTES,
rgrover1 712:b04b5db36865 82 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
rgrover1 712:b04b5db36865 83 hrmLocation(GattCharacteristic::UUID_BODY_SENSOR_LOCATION_CHAR, &location),
rgrover1 712:b04b5db36865 84 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) {
rgrover1 712:b04b5db36865 85 setupService();
rgrover1 712:b04b5db36865 86 }
rgrover1 712:b04b5db36865 87
rgrover1 712:b04b5db36865 88 /**
rgrover1 712:b04b5db36865 89 * @brief Set a new 8-bit value for heart rate.
rgrover1 712:b04b5db36865 90 *
rgrover1 712:b04b5db36865 91 * @param[in] hrmCounter
rgrover1 712:b04b5db36865 92 * HeartRate in bpm.
rgrover1 712:b04b5db36865 93 */
rgrover1 712:b04b5db36865 94 void updateHeartRate(uint8_t hrmCounter) {
rgrover1 712:b04b5db36865 95 valueBytes.updateHeartRate(hrmCounter);
rgrover1 728:997ba5e7b3b6 96 ble.gattServer().write(hrmRate.getValueHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
rgrover1 712:b04b5db36865 97 }
rgrover1 712:b04b5db36865 98
rgrover1 712:b04b5db36865 99 /**
rgrover1 712:b04b5db36865 100 * Set a new 16-bit value for heart rate.
rgrover1 712:b04b5db36865 101 *
rgrover1 712:b04b5db36865 102 * @param[in] hrmCounter
rgrover1 712:b04b5db36865 103 * HeartRate in bpm.
rgrover1 712:b04b5db36865 104 */
rgrover1 712:b04b5db36865 105 void updateHeartRate(uint16_t hrmCounter) {
rgrover1 712:b04b5db36865 106 valueBytes.updateHeartRate(hrmCounter);
rgrover1 728:997ba5e7b3b6 107 ble.gattServer().write(hrmRate.getValueHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
rgrover1 712:b04b5db36865 108 }
paulocroman 1131:4d921282c434 109
paulocroman 1131:4d921282c434 110 void updateHeartRate(uint16_t v1, uint16_t v2) {
paulocroman 1131:4d921282c434 111 valueBytes.updateHeartRate(v1,v2);
paulocroman 1131:4d921282c434 112 ble.gattServer().write(hrmRate.getValueHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
paulocroman 1131:4d921282c434 113 }
paulocroman 1131:4d921282c434 114
paulocroman 1131:4d921282c434 115 void updateHeartRate(int32_t v1, int32_t v2) {
paulocroman 1131:4d921282c434 116 valueBytes.updateHeartRate(v1,v2);
paulocroman 1131:4d921282c434 117 ble.gattServer().write(hrmRate.getValueHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
paulocroman 1131:4d921282c434 118 }
rgrover1 712:b04b5db36865 119
rgrover1 712:b04b5db36865 120 /**
rgrover1 712:b04b5db36865 121 * This callback allows the HeartRateService to receive updates to the
rgrover1 712:b04b5db36865 122 * controlPoint Characteristic.
rgrover1 712:b04b5db36865 123 *
rgrover1 712:b04b5db36865 124 * @param[in] params
rgrover1 712:b04b5db36865 125 * Information about the characterisitc being updated.
rgrover1 712:b04b5db36865 126 */
rgrover1 712:b04b5db36865 127 virtual void onDataWritten(const GattWriteCallbackParams *params) {
rgrover1 712:b04b5db36865 128 if (params->handle == controlPoint.getValueAttribute().getHandle()) {
rgrover1 712:b04b5db36865 129 /* Do something here if the new value is 1; else you can override this method by
rgrover1 712:b04b5db36865 130 * extending this class.
rgrover1 712:b04b5db36865 131 * @NOTE: if you are extending this class, be sure to also call
rgrover1 712:b04b5db36865 132 * ble.onDataWritten(this, &ExtendedHRService::onDataWritten); in
rgrover1 712:b04b5db36865 133 * your constructor.
rgrover1 712:b04b5db36865 134 */
rgrover1 712:b04b5db36865 135 }
rgrover1 712:b04b5db36865 136 }
rgrover1 712:b04b5db36865 137
rgrover1 712:b04b5db36865 138 protected:
rgrover1 712:b04b5db36865 139 void setupService(void) {
rgrover1 712:b04b5db36865 140 GattCharacteristic *charTable[] = {&hrmRate, &hrmLocation, &controlPoint};
rgrover1 712:b04b5db36865 141 GattService hrmService(GattService::UUID_HEART_RATE_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 712:b04b5db36865 142
rgrover1 712:b04b5db36865 143 ble.addService(hrmService);
rgrover1 712:b04b5db36865 144 ble.onDataWritten(this, &HeartRateService::onDataWritten);
rgrover1 712:b04b5db36865 145 }
rgrover1 712:b04b5db36865 146
rgrover1 712:b04b5db36865 147 protected:
rgrover1 712:b04b5db36865 148 /* Private internal representation for the bytes used to work with the vaulue of the heart-rate characteristic. */
rgrover1 712:b04b5db36865 149 struct HeartRateValueBytes {
paulocroman 1131:4d921282c434 150 static const unsigned MAX_VALUE_BYTES = 10; /* FLAGS + up to two bytes for heart-rate */
rgrover1 712:b04b5db36865 151 static const unsigned FLAGS_BYTE_INDEX = 0;
rgrover1 712:b04b5db36865 152
rgrover1 712:b04b5db36865 153 static const unsigned VALUE_FORMAT_BITNUM = 0;
rgrover1 712:b04b5db36865 154 static const uint8_t VALUE_FORMAT_FLAG = (1 << VALUE_FORMAT_BITNUM);
rgrover1 712:b04b5db36865 155
rgrover1 712:b04b5db36865 156 HeartRateValueBytes(uint8_t hrmCounter) : valueBytes() {
rgrover1 712:b04b5db36865 157 updateHeartRate(hrmCounter);
rgrover1 712:b04b5db36865 158 }
rgrover1 712:b04b5db36865 159
rgrover1 712:b04b5db36865 160 HeartRateValueBytes(uint16_t hrmCounter) : valueBytes() {
rgrover1 712:b04b5db36865 161 updateHeartRate(hrmCounter);
rgrover1 712:b04b5db36865 162 }
rgrover1 712:b04b5db36865 163
paulocroman 1131:4d921282c434 164 HeartRateValueBytes(uint16_t v1, uint16_t v2) : valueBytes() {
paulocroman 1131:4d921282c434 165 updateHeartRate(v1,v2);
paulocroman 1131:4d921282c434 166 }
paulocroman 1131:4d921282c434 167
rgrover1 712:b04b5db36865 168 void updateHeartRate(uint8_t hrmCounter) {
rgrover1 712:b04b5db36865 169 valueBytes[FLAGS_BYTE_INDEX] &= ~VALUE_FORMAT_FLAG;
rgrover1 712:b04b5db36865 170 valueBytes[FLAGS_BYTE_INDEX + 1] = hrmCounter;
rgrover1 712:b04b5db36865 171 }
rgrover1 712:b04b5db36865 172
rgrover1 712:b04b5db36865 173 void updateHeartRate(uint16_t hrmCounter) {
rgrover1 712:b04b5db36865 174 valueBytes[FLAGS_BYTE_INDEX] |= VALUE_FORMAT_FLAG;
rgrover1 712:b04b5db36865 175 valueBytes[FLAGS_BYTE_INDEX + 1] = (uint8_t)(hrmCounter & 0xFF);
rgrover1 712:b04b5db36865 176 valueBytes[FLAGS_BYTE_INDEX + 2] = (uint8_t)(hrmCounter >> 8);
rgrover1 712:b04b5db36865 177 }
paulocroman 1131:4d921282c434 178
paulocroman 1131:4d921282c434 179 void updateHeartRate(uint16_t v1, uint16_t v2)
paulocroman 1131:4d921282c434 180 {
paulocroman 1131:4d921282c434 181 valueBytes[FLAGS_BYTE_INDEX] |= VALUE_FORMAT_FLAG;
paulocroman 1131:4d921282c434 182 valueBytes[FLAGS_BYTE_INDEX + 1] = (uint8_t)(v1 & 0xFF);
paulocroman 1131:4d921282c434 183 valueBytes[FLAGS_BYTE_INDEX + 2] = (uint8_t)(v1 >> 8);
paulocroman 1131:4d921282c434 184 valueBytes[FLAGS_BYTE_INDEX + 3] = (uint8_t)(v2 & 0xFF);
paulocroman 1131:4d921282c434 185 valueBytes[FLAGS_BYTE_INDEX + 4] = (uint8_t)(v2 >> 8);
paulocroman 1131:4d921282c434 186 }
paulocroman 1131:4d921282c434 187
paulocroman 1131:4d921282c434 188 void updateHeartRate(int32_t v1, int32_t v2)
paulocroman 1131:4d921282c434 189 {
paulocroman 1131:4d921282c434 190 unsigned char *u1;
paulocroman 1131:4d921282c434 191 u1 = ((unsigned char*)&v1);
paulocroman 1131:4d921282c434 192 valueBytes[FLAGS_BYTE_INDEX] |= VALUE_FORMAT_FLAG;
paulocroman 1131:4d921282c434 193 valueBytes[FLAGS_BYTE_INDEX + 1] = (uint8_t)(u1[0]&0xFF);
paulocroman 1131:4d921282c434 194 valueBytes[FLAGS_BYTE_INDEX + 2] = (uint8_t)(u1[1]&0xFF);
paulocroman 1131:4d921282c434 195 valueBytes[FLAGS_BYTE_INDEX + 3] = (uint8_t)(u1[2]&0xFF);
paulocroman 1131:4d921282c434 196 valueBytes[FLAGS_BYTE_INDEX + 4] = (uint8_t)(u1[3]&0xFF);
paulocroman 1131:4d921282c434 197
paulocroman 1131:4d921282c434 198 u1 = ((unsigned char*)&v2);
paulocroman 1131:4d921282c434 199 valueBytes[FLAGS_BYTE_INDEX + 5] = (uint8_t)(u1[0]&0xFF);
paulocroman 1131:4d921282c434 200 valueBytes[FLAGS_BYTE_INDEX + 6] = (uint8_t)(u1[1]&0xFF);
paulocroman 1131:4d921282c434 201 valueBytes[FLAGS_BYTE_INDEX + 7] = (uint8_t)(u1[2]&0xFF);
paulocroman 1131:4d921282c434 202 valueBytes[FLAGS_BYTE_INDEX + 8] = (uint8_t)(u1[3]&0xFF);
paulocroman 1131:4d921282c434 203 }
paulocroman 1131:4d921282c434 204
rgrover1 712:b04b5db36865 205
rgrover1 712:b04b5db36865 206 uint8_t *getPointer(void) {
rgrover1 712:b04b5db36865 207 return valueBytes;
rgrover1 712:b04b5db36865 208 }
rgrover1 712:b04b5db36865 209
rgrover1 712:b04b5db36865 210 const uint8_t *getPointer(void) const {
rgrover1 712:b04b5db36865 211 return valueBytes;
rgrover1 712:b04b5db36865 212 }
rgrover1 712:b04b5db36865 213
rgrover1 712:b04b5db36865 214 unsigned getNumValueBytes(void) const {
paulocroman 1131:4d921282c434 215 //return 1 + ((valueBytes[FLAGS_BYTE_INDEX] & VALUE_FORMAT_FLAG) ? sizeof(uint16_t) : sizeof(uint8_t));
paulocroman 1131:4d921282c434 216 return 1 + sizeof(uint32_t)*2;
rgrover1 712:b04b5db36865 217 }
rgrover1 712:b04b5db36865 218
rgrover1 712:b04b5db36865 219 private:
rgrover1 712:b04b5db36865 220 /* First byte = 8-bit values, no extra info, Second byte = uint8_t HRM value */
rgrover1 712:b04b5db36865 221 /* See --> https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml */
rgrover1 712:b04b5db36865 222 uint8_t valueBytes[MAX_VALUE_BYTES];
rgrover1 712:b04b5db36865 223 };
rgrover1 712:b04b5db36865 224
rgrover1 712:b04b5db36865 225 protected:
rgrover1 712:b04b5db36865 226 BLE &ble;
rgrover1 712:b04b5db36865 227
rgrover1 712:b04b5db36865 228 HeartRateValueBytes valueBytes;
rgrover1 712:b04b5db36865 229 uint8_t controlPointValue;
rgrover1 712:b04b5db36865 230
rgrover1 712:b04b5db36865 231 GattCharacteristic hrmRate;
rgrover1 712:b04b5db36865 232 ReadOnlyGattCharacteristic<uint8_t> hrmLocation;
rgrover1 712:b04b5db36865 233 WriteOnlyGattCharacteristic<uint8_t> controlPoint;
rgrover1 712:b04b5db36865 234 };
rgrover1 712:b04b5db36865 235
rgrover1 712:b04b5db36865 236 #endif /* #ifndef __BLE_HEART_RATE_SERVICE_H__*/