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