Icarus Sensors / Mbed 2 deprecated Cycle_Speed_Cadence_Service

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.

Dependencies:   BLE_API mbed nRF51822

Fork of Bluetooth_Heart_Rate_Monitor_dummy by Icarus Sensors

CycleSpeedCadenceService.h@61:16f888838853, 2015-05-04 (annotated)

Committer:
smigielski
Date:
Mon May 04 17:18:12 2015 +0000
Revision:
61:16f888838853
Child:
62:2ea9997b5249
Initial version of speed and cadence sensor

Who changed what in which revision?

UserRevisionLine numberNew contents of line
smigielski 61:16f888838853 1 /* mbed Microcontroller Library
smigielski 61:16f888838853 2 * Copyright (c) 2006-2013 ARM Limited
smigielski 61:16f888838853 3 *
smigielski 61:16f888838853 4 * Licensed under the Apache License, Version 2.0 (the "License");
smigielski 61:16f888838853 5 * you may not use this file except in compliance with the License.
smigielski 61:16f888838853 6 * You may obtain a copy of the License at
smigielski 61:16f888838853 7 *
smigielski 61:16f888838853 8 * http://www.apache.org/licenses/LICENSE-2.0
smigielski 61:16f888838853 9 *
smigielski 61:16f888838853 10 * Unless required by applicable law or agreed to in writing, software
smigielski 61:16f888838853 11 * distributed under the License is distributed on an "AS IS" BASIS,
smigielski 61:16f888838853 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
smigielski 61:16f888838853 13 * See the License for the specific language governing permissions and
smigielski 61:16f888838853 14 * limitations under the License.
smigielski 61:16f888838853 15 */
smigielski 61:16f888838853 16
smigielski 61:16f888838853 17 #ifndef __BLE_CYCLE_SPEED_CADENCE_SERVICE_H__
smigielski 61:16f888838853 18 #define __BLE_CYCLE_SPEED_CADENCE_SERVICE_H__
smigielski 61:16f888838853 19
smigielski 61:16f888838853 20 #include "BLEDevice.h"
smigielski 61:16f888838853 21
smigielski 61:16f888838853 22 /**
smigielski 61:16f888838853 23 * @class CycleSpeedCadenceService
smigielski 61:16f888838853 24 * @brief BLE Service for HeartRate. This BLE Service contains the location of the sensor, the heartrate in beats per minute. <br>
smigielski 61:16f888838853 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.heart_rate.xml <br>
smigielski 61:16f888838853 26 * HRM Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml <br>
smigielski 61:16f888838853 27 * Location: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.body_sensor_location.xml
smigielski 61:16f888838853 28 */
smigielski 61:16f888838853 29 class CycleSpeedCadenceService {
smigielski 61:16f888838853 30 public:
smigielski 61:16f888838853 31 /**
smigielski 61:16f888838853 32 * @enum SensorLocation
smigielski 61:16f888838853 33 * @brief Location of HeartRate sensor on body.
smigielski 61:16f888838853 34 */
smigielski 61:16f888838853 35 enum {
smigielski 61:16f888838853 36 LOCATION_OTHER = 0,
smigielski 61:16f888838853 37 LOCATION_TOP_OF_SHOE,
smigielski 61:16f888838853 38 LOCATION_IN_SHOE,
smigielski 61:16f888838853 39 LOCATION_HIP,
smigielski 61:16f888838853 40 LOCATION_FRONT_WHEEL,
smigielski 61:16f888838853 41 LOCATION_LEFT_CRANK,
smigielski 61:16f888838853 42 LOCATION_RIGHT_CRANK,
smigielski 61:16f888838853 43 LOCATION_LEFT_PEDAL,
smigielski 61:16f888838853 44 LOCATION_RIGHT_PEDAL,
smigielski 61:16f888838853 45 LOCATION_FRONT_HUB,
smigielski 61:16f888838853 46 LOCATION_REAR_DROPOUT,
smigielski 61:16f888838853 47 LOCATION_CHAINSTAY,
smigielski 61:16f888838853 48 LOCATION_REAR_WHEEL,
smigielski 61:16f888838853 49 LOCATION_REAR_HUB,
smigielski 61:16f888838853 50 LOCATION_CHEST
smigielski 61:16f888838853 51 };
smigielski 61:16f888838853 52
smigielski 61:16f888838853 53 enum {
smigielski 61:16f888838853 54 UUID_SENSOR_LOCATION_CHAR = 0x2A5D,
smigielski 61:16f888838853 55 UUID_CSC_MEASUREMENT_CHAR = 0x2A5B,
smigielski 61:16f888838853 56 UUID_CSC_FEATURE_CHAR = 0x2A5C
smigielski 61:16f888838853 57 };
smigielski 61:16f888838853 58
smigielski 61:16f888838853 59
smigielski 61:16f888838853 60
smigielski 61:16f888838853 61 public:
smigielski 61:16f888838853 62 /**
smigielski 61:16f888838853 63 * @brief Constructor with 8bit HRM Counter value.
smigielski 61:16f888838853 64 *
smigielski 61:16f888838853 65 * @param[ref] _ble
smigielski 61:16f888838853 66 * Reference to the underlying BLEDevice.
smigielski 61:16f888838853 67 * @param[in] hrmCounter (8-bit)
smigielski 61:16f888838853 68 * initial value for the hrm counter.
smigielski 61:16f888838853 69 * @param[in] location
smigielski 61:16f888838853 70 * Sensor's location.
smigielski 61:16f888838853 71 */
smigielski 61:16f888838853 72 CycleSpeedCadenceService(BLEDevice &_ble, uint32_t wheelRevolutions ,uint16_t wheelEvent, uint8_t location, bool locationSupport) :
smigielski 61:16f888838853 73 ble(_ble),
smigielski 61:16f888838853 74 feautureBytes(true,false,locationSupport),
smigielski 61:16f888838853 75 valueBytes(wheelRevolutions,wheelEvent),
smigielski 61:16f888838853 76 cscMesurement(GattCharacteristic::UUID_CSC_MEASUREMENT_CHAR, valueBytes.getPointer(),
smigielski 61:16f888838853 77 valueBytes.getNumValueBytes(), CSCValueBytes::MAX_VALUE_BYTES,
smigielski 61:16f888838853 78 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
smigielski 61:16f888838853 79 cscFeatures(CycleSpeedCadenceService::UUID_CSC_FEATURE_CHAR, feautureBytes.getPointer()),
smigielski 61:16f888838853 80 sensorLocation(CycleSpeedCadenceService::UUID_SENSOR_LOCATION_CHAR, &location),
smigielski 61:16f888838853 81 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) {
smigielski 61:16f888838853 82 setupService();
smigielski 61:16f888838853 83 }
smigielski 61:16f888838853 84
smigielski 61:16f888838853 85 CycleSpeedCadenceService(BLEDevice &_ble, uint16_t crankRevolutions, uint16_t crankEvent, uint8_t location, bool locationSupport ) :
smigielski 61:16f888838853 86 ble(_ble),
smigielski 61:16f888838853 87 feautureBytes(false,true,locationSupport),
smigielski 61:16f888838853 88 valueBytes(crankRevolutions,crankEvent),
smigielski 61:16f888838853 89 cscMesurement(GattCharacteristic::UUID_CSC_MEASUREMENT_CHAR, valueBytes.getPointer(),
smigielski 61:16f888838853 90 valueBytes.getNumValueBytes(), CSCValueBytes::MAX_VALUE_BYTES,
smigielski 61:16f888838853 91 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
smigielski 61:16f888838853 92 cscFeatures(CycleSpeedCadenceService::UUID_CSC_FEATURE_CHAR, feautureBytes.getPointer()),
smigielski 61:16f888838853 93 sensorLocation(CycleSpeedCadenceService::UUID_SENSOR_LOCATION_CHAR, &location),
smigielski 61:16f888838853 94 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) {
smigielski 61:16f888838853 95 setupService();
smigielski 61:16f888838853 96 }
smigielski 61:16f888838853 97
smigielski 61:16f888838853 98 CycleSpeedCadenceService(BLEDevice &_ble, uint32_t wheelRevolutions ,uint16_t wheelEvent,uint16_t crankRevolutions, uint16_t crankEvent, uint8_t location,bool locationSupport ) :
smigielski 61:16f888838853 99 ble(_ble),
smigielski 61:16f888838853 100 feautureBytes(true,true,locationSupport),
smigielski 61:16f888838853 101 valueBytes(wheelRevolutions,wheelEvent,crankRevolutions,crankEvent),
smigielski 61:16f888838853 102 cscMesurement(GattCharacteristic::UUID_CSC_MEASUREMENT_CHAR, valueBytes.getPointer(),
smigielski 61:16f888838853 103 valueBytes.getNumValueBytes(), CSCValueBytes::MAX_VALUE_BYTES,
smigielski 61:16f888838853 104 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
smigielski 61:16f888838853 105 cscFeatures(CycleSpeedCadenceService::UUID_CSC_FEATURE_CHAR, feautureBytes.getPointer()),
smigielski 61:16f888838853 106 sensorLocation(CycleSpeedCadenceService::UUID_SENSOR_LOCATION_CHAR, &location),
smigielski 61:16f888838853 107 controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) {
smigielski 61:16f888838853 108 setupService();
smigielski 61:16f888838853 109 }
smigielski 61:16f888838853 110
smigielski 61:16f888838853 111 /**
smigielski 61:16f888838853 112 * @brief Set a new 8-bit value for heart rate.
smigielski 61:16f888838853 113 *
smigielski 61:16f888838853 114 * @param[in] hrmCounter
smigielski 61:16f888838853 115 * HeartRate in bpm.
smigielski 61:16f888838853 116 */
smigielski 61:16f888838853 117 void updateWheel(uint32_t wheelRevolutions ,uint16_t wheelEvent) {
smigielski 61:16f888838853 118 valueBytes.updateWheel(wheelRevolutions,wheelEvent);
smigielski 61:16f888838853 119 ble.updateCharacteristicValue(cscMesurement.getValueAttribute().getHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
smigielski 61:16f888838853 120 }
smigielski 61:16f888838853 121
smigielski 61:16f888838853 122 /**
smigielski 61:16f888838853 123 * Set a new 16-bit value for heart rate.
smigielski 61:16f888838853 124 *
smigielski 61:16f888838853 125 * @param[in] hrmCounter
smigielski 61:16f888838853 126 * HeartRate in bpm.
smigielski 61:16f888838853 127 */
smigielski 61:16f888838853 128 void updateCrank(uint16_t crankRevolutions, uint16_t crankEvent) {
smigielski 61:16f888838853 129 valueBytes.updateCrank(crankRevolutions,crankEvent);
smigielski 61:16f888838853 130 ble.updateCharacteristicValue(cscMesurement.getValueAttribute().getHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes());
smigielski 61:16f888838853 131 }
smigielski 61:16f888838853 132
smigielski 61:16f888838853 133 /**
smigielski 61:16f888838853 134 * This callback allows the CycleSpeedCadenceService to receive updates to the
smigielski 61:16f888838853 135 * controlPoint Characteristic.
smigielski 61:16f888838853 136 *
smigielski 61:16f888838853 137 * @param[in] params
smigielski 61:16f888838853 138 * Information about the characterisitc being updated.
smigielski 61:16f888838853 139 */
smigielski 61:16f888838853 140 virtual void onDataWritten(const GattCharacteristicWriteCBParams *params) {
smigielski 61:16f888838853 141 if (params->charHandle == controlPoint.getValueAttribute().getHandle()) {
smigielski 61:16f888838853 142 /* Do something here if the new value is 1; else you can override this method by
smigielski 61:16f888838853 143 * extending this class.
smigielski 61:16f888838853 144 * @NOTE: if you are extending this class, be sure to also call
smigielski 61:16f888838853 145 * ble.onDataWritten(this, &ExtendedHRService::onDataWritten); in
smigielski 61:16f888838853 146 * your constructor.
smigielski 61:16f888838853 147 */
smigielski 61:16f888838853 148 }
smigielski 61:16f888838853 149 }
smigielski 61:16f888838853 150
smigielski 61:16f888838853 151 private:
smigielski 61:16f888838853 152 void setupService(void) {
smigielski 61:16f888838853 153 static bool serviceAdded = false; /* We should only ever need to add the heart rate service once. */
smigielski 61:16f888838853 154 if (serviceAdded) {
smigielski 61:16f888838853 155 return;
smigielski 61:16f888838853 156 }
smigielski 61:16f888838853 157
smigielski 61:16f888838853 158 GattCharacteristic *charTable[] = {&cscMesurement, &cscFeatures, &sensorLocation, &controlPoint};
smigielski 61:16f888838853 159 GattService cscsService(GattService::UUID_CYCLING_SPEED_AND_CADENCE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
smigielski 61:16f888838853 160
smigielski 61:16f888838853 161 ble.addService(cscsService);
smigielski 61:16f888838853 162 serviceAdded = true;
smigielski 61:16f888838853 163
smigielski 61:16f888838853 164 ble.onDataWritten(this, &CycleSpeedCadenceService::onDataWritten);
smigielski 61:16f888838853 165 }
smigielski 61:16f888838853 166
smigielski 61:16f888838853 167 private:
smigielski 61:16f888838853 168 struct CSCFeatureBytes {
smigielski 61:16f888838853 169 uint16_t cscFeaturesValue;
smigielski 61:16f888838853 170
smigielski 61:16f888838853 171 CSCFeatureBytes(bool wheelSupport, bool crankSupport, bool locationSupport){
smigielski 61:16f888838853 172 cscFeaturesValue= wheelSupport | crankSupport << 1 | locationSupport << 2;
smigielski 61:16f888838853 173 }
smigielski 61:16f888838853 174
smigielski 61:16f888838853 175 uint16_t *getPointer(void) {
smigielski 61:16f888838853 176 return &cscFeaturesValue;
smigielski 61:16f888838853 177 }
smigielski 61:16f888838853 178
smigielski 61:16f888838853 179 const uint16_t *getPointer(void) const {
smigielski 61:16f888838853 180 return &cscFeaturesValue;
smigielski 61:16f888838853 181 }
smigielski 61:16f888838853 182 };
smigielski 61:16f888838853 183 /* Private internal representation for the bytes used to work with the vaulue of the heart-rate characteristic. */
smigielski 61:16f888838853 184 struct CSCValueBytes {
smigielski 61:16f888838853 185 static const unsigned MAX_VALUE_BYTES = 11; /* FLAGS + up to two bytes for heart-rate */
smigielski 61:16f888838853 186 static const unsigned FLAGS_BYTE_INDEX = 0;
smigielski 61:16f888838853 187 static const unsigned WHEEL_REVOLUTIONS_INDEX = 1;
smigielski 61:16f888838853 188 static const unsigned WHEEL_EVENT_INDEX = 5;
smigielski 61:16f888838853 189 static const unsigned CRANK_REVOLUTIONS_INDEX = 1;
smigielski 61:16f888838853 190 static const unsigned CRANK_EVENT_INDEX = 3;
smigielski 61:16f888838853 191
smigielski 61:16f888838853 192
smigielski 61:16f888838853 193 static const unsigned WHEEL_PRESENCE_BITNUM = 0;
smigielski 61:16f888838853 194 static const uint8_t WHEEL_FLAG = (1 << WHEEL_PRESENCE_BITNUM);
smigielski 61:16f888838853 195 static const unsigned CADENCE_PRESENCE_BITNUM = 0;
smigielski 61:16f888838853 196 static const uint8_t CADENCE_FLAG = (1 << CADENCE_PRESENCE_BITNUM);
smigielski 61:16f888838853 197
smigielski 61:16f888838853 198 //speed
smigielski 61:16f888838853 199 CSCValueBytes(uint32_t wheelRevolutions ,uint16_t wheelEvent) : valueBytes() {
smigielski 61:16f888838853 200 valueBytes[FLAGS_BYTE_INDEX] &= WHEEL_FLAG;
smigielski 61:16f888838853 201 updateWheel(wheelRevolutions,wheelEvent);
smigielski 61:16f888838853 202 }
smigielski 61:16f888838853 203 //cadence
smigielski 61:16f888838853 204 CSCValueBytes(uint16_t crankRevolutions, uint16_t crankEvent ) : valueBytes() {
smigielski 61:16f888838853 205 valueBytes[FLAGS_BYTE_INDEX] &= CADENCE_FLAG;
smigielski 61:16f888838853 206 updateCrank(crankRevolutions,crankEvent);
smigielski 61:16f888838853 207 }
smigielski 61:16f888838853 208
smigielski 61:16f888838853 209 //speed + cadence
smigielski 61:16f888838853 210 CSCValueBytes(uint32_t wheelRevolutions ,uint16_t wheelEvent,uint16_t crankRevolutions, uint16_t crankEvent) : valueBytes() {
smigielski 61:16f888838853 211 valueBytes[FLAGS_BYTE_INDEX] &= (WHEEL_FLAG |CADENCE_FLAG);
smigielski 61:16f888838853 212 updateWheel(wheelRevolutions,wheelEvent);
smigielski 61:16f888838853 213 updateCrank(crankRevolutions,crankEvent);
smigielski 61:16f888838853 214 }
smigielski 61:16f888838853 215
smigielski 61:16f888838853 216
smigielski 61:16f888838853 217 void updateWheel(uint32_t wheelRevolutions ,uint16_t wheelEvent) {
smigielski 61:16f888838853 218
smigielski 61:16f888838853 219 valueBytes[WHEEL_REVOLUTIONS_INDEX] = (uint8_t)(wheelRevolutions & 0xFF);
smigielski 61:16f888838853 220 valueBytes[WHEEL_REVOLUTIONS_INDEX + 1] = (uint8_t)((wheelRevolutions >> 8) & 0xFF);
smigielski 61:16f888838853 221 valueBytes[WHEEL_REVOLUTIONS_INDEX + 2] = (uint8_t)((wheelRevolutions >> 16) & 0xFF);
smigielski 61:16f888838853 222 valueBytes[WHEEL_REVOLUTIONS_INDEX + 3] = (uint8_t)((wheelRevolutions >> 24) & 0xFF);
smigielski 61:16f888838853 223 valueBytes[WHEEL_EVENT_INDEX] = (uint8_t)(wheelEvent & 0xFF);
smigielski 61:16f888838853 224 valueBytes[WHEEL_EVENT_INDEX + 1] = (uint8_t)((wheelEvent >> 8) & 0xFF);
smigielski 61:16f888838853 225 }
smigielski 61:16f888838853 226
smigielski 61:16f888838853 227 void updateCrank(uint16_t crankRevolutions, uint16_t crankEvent) {
smigielski 61:16f888838853 228 int offset = (valueBytes[FLAGS_BYTE_INDEX] & WHEEL_FLAG) ? sizeof(uint32_t)+ sizeof(uint16_t):0;
smigielski 61:16f888838853 229 valueBytes[offset + CRANK_REVOLUTIONS_INDEX] = (uint8_t)(crankRevolutions & 0xFF);
smigielski 61:16f888838853 230 valueBytes[offset + CRANK_REVOLUTIONS_INDEX + 1] = (uint8_t)((crankRevolutions >> 8) & 0xFF);
smigielski 61:16f888838853 231 valueBytes[offset + CRANK_EVENT_INDEX] = (uint8_t)(crankEvent & 0xFF);
smigielski 61:16f888838853 232 valueBytes[offset + CRANK_EVENT_INDEX + 1] = (uint8_t)((crankEvent >> 8) & 0xFF);
smigielski 61:16f888838853 233 }
smigielski 61:16f888838853 234
smigielski 61:16f888838853 235 uint8_t *getPointer(void) {
smigielski 61:16f888838853 236 return valueBytes;
smigielski 61:16f888838853 237 }
smigielski 61:16f888838853 238
smigielski 61:16f888838853 239 const uint8_t *getPointer(void) const {
smigielski 61:16f888838853 240 return valueBytes;
smigielski 61:16f888838853 241 }
smigielski 61:16f888838853 242
smigielski 61:16f888838853 243 unsigned getNumValueBytes(void) const {
smigielski 61:16f888838853 244 return 1 + ((valueBytes[FLAGS_BYTE_INDEX] & WHEEL_FLAG) ? sizeof(uint32_t)+ sizeof(uint16_t):0)
smigielski 61:16f888838853 245 + ((valueBytes[FLAGS_BYTE_INDEX] & CADENCE_FLAG) ? sizeof(uint16_t) + sizeof(uint16_t):0);
smigielski 61:16f888838853 246 }
smigielski 61:16f888838853 247
smigielski 61:16f888838853 248 private:
smigielski 61:16f888838853 249 /* First byte = 8-bit values, no extra info, Second byte = uint8_t HRM value */
smigielski 61:16f888838853 250 /* See --> https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml */
smigielski 61:16f888838853 251 uint8_t valueBytes[MAX_VALUE_BYTES];
smigielski 61:16f888838853 252 };
smigielski 61:16f888838853 253
smigielski 61:16f888838853 254 private:
smigielski 61:16f888838853 255 BLEDevice &ble;
smigielski 61:16f888838853 256
smigielski 61:16f888838853 257 CSCFeatureBytes feautureBytes;
smigielski 61:16f888838853 258 CSCValueBytes valueBytes;
smigielski 61:16f888838853 259
smigielski 61:16f888838853 260 uint8_t controlPointValue;
smigielski 61:16f888838853 261
smigielski 61:16f888838853 262
smigielski 61:16f888838853 263 GattCharacteristic cscMesurement;
smigielski 61:16f888838853 264 ReadOnlyGattCharacteristic<uint16_t> cscFeatures;
smigielski 61:16f888838853 265 ReadOnlyGattCharacteristic<uint8_t> sensorLocation;
smigielski 61:16f888838853 266 WriteOnlyGattCharacteristic<uint8_t> controlPoint;
smigielski 61:16f888838853 267 };
smigielski 61:16f888838853 268
smigielski 61:16f888838853 269 #endif /* #ifndef __BLE_CYCLE_SPEED_CADENCE_SERVICE_H__*/