Bill Schilit / BLE_API

Improve readability with getHandle inline

Fork of BLE_API by Bluetooth Low Energy

services/HealthThermometerService.h@245:98f930d14515, 2014-12-09 (annotated)

Committer:
rgrover1
Date:
Tue Dec 09 13:15:19 2014 +0000
Revision:
245:98f930d14515
Parent:
244:0e9201b67e2f 
Synchronized with git rev ba5fb7fb

Author: Rohit Grover

minor improvements to documentation.

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_HEALTH_THERMOMETER_SERVICE_H__
Rohit Grover 118:620d28e7a1ba 18 #define __BLE_HEALTH_THERMOMETER_SERVICE_H__
Rohit Grover 118:620d28e7a1ba 19
Rohit Grover 118:620d28e7a1ba 20 #include "BLEDevice.h"
Rohit Grover 118:620d28e7a1ba 21
rgrover1 244:0e9201b67e2f 22 /**
mbedAustin 237:448f29f4ae7f 23 * @class HealthThermometerService
rgrover1 244:0e9201b67e2f 24 * @brief BLE Health Thermometer Service. This service provides the location of the thermometer and the temperature. <br>
mbedAustin 237:448f29f4ae7f 25 * Service: https://developer.bluetooth.org/gatt/profiles/Pages/ProfileViewer.aspx?u=org.bluetooth.profile.health_thermometer.xml <br>
mbedAustin 237:448f29f4ae7f 26 * Temperature Measurement: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.temperature_measurement.xml <br>
rgrover1 244:0e9201b67e2f 27 * Temperature Type: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.temperature_type.xml
mbedAustin 237:448f29f4ae7f 28 */
Rohit Grover 118:620d28e7a1ba 29 class HealthThermometerService {
Rohit Grover 118:620d28e7a1ba 30 public:
mbedAustin 237:448f29f4ae7f 31 /**
mbedAustin 237:448f29f4ae7f 32 * @enum Sensor Location
rgrover1 244:0e9201b67e2f 33 * @brief Location of sensor on the body
mbedAustin 237:448f29f4ae7f 34 */
rgrover1 245:98f930d14515 35 enum SensorLocation_t {
mbedAustin 237:448f29f4ae7f 36 LOCATION_ARMPIT = 1, /*!< armpit */
mbedAustin 237:448f29f4ae7f 37 LOCATION_BODY, /*!< body */
mbedAustin 237:448f29f4ae7f 38 LOCATION_EAR, /*!< ear */
mbedAustin 237:448f29f4ae7f 39 LOCATION_FINGER, /*!< finger */
mbedAustin 237:448f29f4ae7f 40 LOCATION_GI_TRACT, /*!< GI tract */
mbedAustin 237:448f29f4ae7f 41 LOCATION_MOUTH, /*!< mouth */
mbedAustin 237:448f29f4ae7f 42 LOCATION_RECTUM, /*!< rectum */
mbedAustin 237:448f29f4ae7f 43 LOCATION_TOE, /*!< toe */
mbedAustin 237:448f29f4ae7f 44 LOCATION_EAR_DRUM, /*!< ear drum */
Rohit Grover 118:620d28e7a1ba 45 };
Rohit Grover 118:620d28e7a1ba 46
Rohit Grover 118:620d28e7a1ba 47 public:
Rohit Grover 118:620d28e7a1ba 48 /**
rgrover1 244:0e9201b67e2f 49 * @brief Add the Health Thermometer Service to an existing ble object, initialize with temperature and location.
mbedAustin 237:448f29f4ae7f 50 * @param[ref] _ble reference to the BLE device
Rohit Grover 118:620d28e7a1ba 51 * @param[in] initialTemp initial value in celsius
Rohit Grover 118:620d28e7a1ba 52 * @param[in] _location
Rohit Grover 118:620d28e7a1ba 53 */
Rohit Grover 118:620d28e7a1ba 54 HealthThermometerService(BLEDevice &_ble, float initialTemp, uint8_t _location) :
Rohit Grover 118:620d28e7a1ba 55 ble(_ble),
Rohit Grover 118:620d28e7a1ba 56 valueBytes(initialTemp),
Rohit Grover 118:620d28e7a1ba 57 tempMeasurement(GattCharacteristic::UUID_TEMPERATURE_MEASUREMENT_CHAR, valueBytes.getPointer(),
Rohit Grover 118:620d28e7a1ba 58 sizeof(TemperatureValueBytes), sizeof(TemperatureValueBytes),
Rohit Grover 118:620d28e7a1ba 59 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY),
Rohit Grover 118:620d28e7a1ba 60 tempLocation(GattCharacteristic::UUID_TEMPERATURE_TYPE_CHAR, (uint8_t *)&_location, sizeof(_location), sizeof(_location),
Rohit Grover 118:620d28e7a1ba 61 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ) {
Rohit Grover 118:620d28e7a1ba 62
Rohit Grover 118:620d28e7a1ba 63 GattCharacteristic *hrmChars[] = {&tempMeasurement, &tempLocation, };
Rohit Grover 118:620d28e7a1ba 64 GattService hrmService(GattService::UUID_HEALTH_THERMOMETER_SERVICE, hrmChars, sizeof(hrmChars) / sizeof(GattCharacteristic *));
Rohit Grover 118:620d28e7a1ba 65
Rohit Grover 118:620d28e7a1ba 66 ble.addService(hrmService);
Rohit Grover 118:620d28e7a1ba 67 }
Rohit Grover 118:620d28e7a1ba 68
mbedAustin 237:448f29f4ae7f 69 /**
rgrover1 244:0e9201b67e2f 70 * @brief Update the temperature being broadcast
mbedAustin 237:448f29f4ae7f 71 *
mbedAustin 237:448f29f4ae7f 72 * @param[in] temperature
mbedAustin 237:448f29f4ae7f 73 * Floating point value of the temperature
rgrover1 244:0e9201b67e2f 74 *
mbedAustin 237:448f29f4ae7f 75 */
Rohit Grover 118:620d28e7a1ba 76 void updateTemperature(float temperature) {
Rohit Grover 118:620d28e7a1ba 77 if (ble.getGapState().connected) {
Rohit Grover 118:620d28e7a1ba 78 valueBytes.updateTemperature(temperature);
Rohit Grover 118:620d28e7a1ba 79 ble.updateCharacteristicValue(tempMeasurement.getValueAttribute().getHandle(), valueBytes.getPointer(), sizeof(TemperatureValueBytes));
Rohit Grover 118:620d28e7a1ba 80 }
Rohit Grover 118:620d28e7a1ba 81 }
Rohit Grover 118:620d28e7a1ba 82
rgrover1 245:98f930d14515 83 /**
rgrover1 245:98f930d14515 84 * @brief Update the location.
rgrover1 245:98f930d14515 85 * @param loc
rgrover1 245:98f930d14515 86 * new location value.
rgrover1 245:98f930d14515 87 */
rgrover1 245:98f930d14515 88 void updateLocation(SensorLocation_t loc) {
rgrover1 245:98f930d14515 89 ble.updateCharacteristicValue(tempLocation.getValueHandle(), reinterpret_cast<uint8_t *>(&loc), sizeof(uint8_t));
rgrover1 245:98f930d14515 90 }
rgrover1 245:98f930d14515 91
Rohit Grover 118:620d28e7a1ba 92 private:
Rohit Grover 118:620d28e7a1ba 93 /* Private internal representation for the bytes used to work with the vaulue of the heart-rate characteristic. */
Rohit Grover 118:620d28e7a1ba 94 struct TemperatureValueBytes {
Rohit Grover 118:620d28e7a1ba 95 static const unsigned OFFSET_OF_FLAGS = 0;
Rohit Grover 118:620d28e7a1ba 96 static const unsigned OFFSET_OF_VALUE = OFFSET_OF_FLAGS + sizeof(uint8_t);
Rohit Grover 118:620d28e7a1ba 97 static const unsigned SIZEOF_VALUE_BYTES = sizeof(uint8_t) + sizeof(float);
Rohit Grover 118:620d28e7a1ba 98
Rohit Grover 118:620d28e7a1ba 99 static const unsigned TEMPERATURE_UNITS_FLAG_POS = 0;
Rohit Grover 118:620d28e7a1ba 100 static const unsigned TIMESTAMP_FLAG_POS = 1;
Rohit Grover 118:620d28e7a1ba 101 static const unsigned TEMPERATURE_TYPE_FLAG_POS = 2;
Rohit Grover 118:620d28e7a1ba 102
rgrover1 244:0e9201b67e2f 103 static const uint8_t TEMPERATURE_UNITS_CELSIUS = 0;
rgrover1 244:0e9201b67e2f 104 static const uint8_t TEMPERATURE_UNITS_FAHRENHEIT = 1;
Rohit Grover 118:620d28e7a1ba 105
Rohit Grover 118:620d28e7a1ba 106 TemperatureValueBytes(float initialTemperature) : bytes() {
Rohit Grover 118:620d28e7a1ba 107 /* assumption: temperature values are expressed in Celsius */
Rohit Grover 118:620d28e7a1ba 108 bytes[OFFSET_OF_FLAGS] = (TEMPERATURE_UNITS_CELSIUS << TEMPERATURE_UNITS_FLAG_POS) |
Rohit Grover 118:620d28e7a1ba 109 (false << TIMESTAMP_FLAG_POS) |
Rohit Grover 118:620d28e7a1ba 110 (false << TEMPERATURE_TYPE_FLAG_POS);
Rohit Grover 118:620d28e7a1ba 111 updateTemperature(initialTemperature);
Rohit Grover 118:620d28e7a1ba 112 }
Rohit Grover 118:620d28e7a1ba 113
Rohit Grover 118:620d28e7a1ba 114 void updateTemperature(float temp) {
Rohit Grover 118:620d28e7a1ba 115 uint32_t temp_ieee11073 = quick_ieee11073_from_float(temp);
Rohit Grover 118:620d28e7a1ba 116 memcpy(&bytes[OFFSET_OF_VALUE], &temp_ieee11073, sizeof(float));
Rohit Grover 118:620d28e7a1ba 117 }
Rohit Grover 118:620d28e7a1ba 118
rgrover1 244:0e9201b67e2f 119 uint8_t *getPointer(void) {
Rohit Grover 118:620d28e7a1ba 120 return bytes;
Rohit Grover 118:620d28e7a1ba 121 }
Rohit Grover 118:620d28e7a1ba 122
Rohit Grover 118:620d28e7a1ba 123 const uint8_t *getPointer(void) const {
Rohit Grover 118:620d28e7a1ba 124 return bytes;
Rohit Grover 118:620d28e7a1ba 125 }
Rohit Grover 118:620d28e7a1ba 126
rgrover1 244:0e9201b67e2f 127 private:
Rohit Grover 118:620d28e7a1ba 128 /**
Rohit Grover 118:620d28e7a1ba 129 * @brief A very quick conversion between a float temperature and 11073-20601 FLOAT-Type.
Rohit Grover 118:620d28e7a1ba 130 * @param temperature The temperature as a float.
Rohit Grover 118:620d28e7a1ba 131 * @return The temperature in 11073-20601 FLOAT-Type format.
Rohit Grover 118:620d28e7a1ba 132 */
Rohit Grover 118:620d28e7a1ba 133 uint32_t quick_ieee11073_from_float(float temperature) {
Rohit Grover 118:620d28e7a1ba 134 uint8_t exponent = 0xFE; //exponent is -2
Rohit Grover 118:620d28e7a1ba 135 uint32_t mantissa = (uint32_t)(temperature * 100);
Rohit Grover 118:620d28e7a1ba 136
Rohit Grover 118:620d28e7a1ba 137 return (((uint32_t)exponent) << 24) | mantissa;
Rohit Grover 118:620d28e7a1ba 138 }
Rohit Grover 118:620d28e7a1ba 139
rgrover1 244:0e9201b67e2f 140 private:
Rohit Grover 118:620d28e7a1ba 141 /* First byte = 8-bit flags, Second field is a float holding the temperature value. */
Rohit Grover 118:620d28e7a1ba 142 /* See --> https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.temperature_measurement.xml */
Rohit Grover 118:620d28e7a1ba 143 uint8_t bytes[SIZEOF_VALUE_BYTES];
Rohit Grover 118:620d28e7a1ba 144 };
Rohit Grover 118:620d28e7a1ba 145
Rohit Grover 118:620d28e7a1ba 146 private:
Rohit Grover 118:620d28e7a1ba 147 BLEDevice &ble;
Rohit Grover 118:620d28e7a1ba 148 TemperatureValueBytes valueBytes;
Rohit Grover 118:620d28e7a1ba 149 GattCharacteristic tempMeasurement;
Rohit Grover 118:620d28e7a1ba 150 GattCharacteristic tempLocation;
Rohit Grover 118:620d28e7a1ba 151 };
Rohit Grover 118:620d28e7a1ba 152
rgrover1 244:0e9201b67e2f 153 #endif /* #ifndef __BLE_HEALTH_THERMOMETER_SERVICE_H__*/