Austin Blackstone / BLE_API

Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

services/HealthThermometerService.h@235:448f29f4ae7f, 2014-12-08 (annotated)

Committer:
mbedAustin
Date:
Mon Dec 08 19:59:40 2014 +0000
Revision:
235:448f29f4ae7f
Parent:
118:620d28e7a1ba
Child:
236:a77aefd88e78
Update doxygen for HealthThermometerService.h

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