BLE heartRate demo with security
Dependencies: BLE_API mbed nRF51822
Revision 2:2d9d4b271af8, committed 2015-06-03
- Comitter:
- sunsmile2015
- Date:
- Wed Jun 03 09:11:21 2015 +0000
- Parent:
- 1:52c48814da8e
- Commit message:
- 1.add comment; 2.add heartRate service with security; 3.print passkey as ASCII
Changed in this revision
HeartRateSecSampleSrv.h | Show annotated file Show diff for this revision Revisions of this file |
main.cpp | Show annotated file Show diff for this revision Revisions of this file |
diff -r 52c48814da8e -r 2d9d4b271af8 HeartRateSecSampleSrv.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/HeartRateSecSampleSrv.h Wed Jun 03 09:11:21 2015 +0000 @@ -0,0 +1,202 @@ +/* mbed Microcontroller Library + * Copyright (c) 2006-2013 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __BLE_HEART_RATE_SEC_SAMPLE_SERVICE_H__ +#define __BLE_HEART_RATE_SEC_SAMPLE_SERVICE_H__ + +#include "BLEDevice.h" + +/** +* @class HeartRateSecService +* @brief BLE Service for HeartRate. This BLE Service contains the location of the sensor, the heartrate in beats per minute. <br> +* Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.heart_rate.xml <br> +* HRM Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml <br> +* Location: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.body_sensor_location.xml +*/ +class HeartRateSecService { +public: + /** + * @enum SensorLocation + * @brief Location of HeartRate sensor on body. + */ + enum { + LOCATION_OTHER = 0, /*!< Other Location */ + LOCATION_CHEST, /*!< Chest */ + LOCATION_WRIST, /*!< Wrist */ + LOCATION_FINGER, /*!< Finger */ + LOCATION_HAND, /*!< Hand */ + LOCATION_EAR_LOBE, /*!< Earlobe */ + LOCATION_FOOT, /*!< Foot */ + }; + +public: + /** + * @brief Constructor with 8bit HRM Counter value. + * + * @param[ref] _ble + * Reference to the underlying BLEDevice. + * @param[in] hrmCounter (8-bit) + * initial value for the hrm counter. + * @param[in] location + * Sensor's location. + */ + HeartRateSecService(BLEDevice &_ble, uint8_t hrmCounter, uint8_t location) : + ble(_ble), + valueBytes(hrmCounter), + hrmRate(GattCharacteristic::UUID_HEART_RATE_MEASUREMENT_CHAR, valueBytes.getPointer(), + valueBytes.getNumValueBytes(), HeartRateValueBytes::MAX_VALUE_BYTES, + GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY), + hrmLocation(GattCharacteristic::UUID_BODY_SENSOR_LOCATION_CHAR, &location), + controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) { + setupService(); + } + + /** + * @brief Constructor with a 16-bit HRM Counter value. + * + * @param[in] _ble + * Reference to the underlying BLEDevice. + * @param[in] hrmCounter (8-bit) + * initial value for the hrm counter. + * @param[in] location + * Sensor's location. + */ + HeartRateSecService(BLEDevice &_ble, uint16_t hrmCounter, uint8_t location) : + ble(_ble), + valueBytes(hrmCounter), + hrmRate(GattCharacteristic::UUID_HEART_RATE_MEASUREMENT_CHAR, valueBytes.getPointer(), + valueBytes.getNumValueBytes(), HeartRateValueBytes::MAX_VALUE_BYTES, + GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY), + hrmLocation(GattCharacteristic::UUID_BODY_SENSOR_LOCATION_CHAR, &location), + controlPoint(GattCharacteristic::UUID_HEART_RATE_CONTROL_POINT_CHAR, &controlPointValue) { + setupService(); + } + + /** + * @brief Set a new 8-bit value for heart rate. + * + * @param[in] hrmCounter + * HeartRate in bpm. + */ + void updateHeartRate(uint8_t hrmCounter) { + valueBytes.updateHeartRate(hrmCounter); + ble.updateCharacteristicValue(hrmRate.getValueAttribute().getHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes()); + } + + /** + * Set a new 16-bit value for heart rate. + * + * @param[in] hrmCounter + * HeartRate in bpm. + */ + void updateHeartRate(uint16_t hrmCounter) { + valueBytes.updateHeartRate(hrmCounter); + ble.updateCharacteristicValue(hrmRate.getValueAttribute().getHandle(), valueBytes.getPointer(), valueBytes.getNumValueBytes()); + } + + /** + * This callback allows the HeartRateSecService to receive updates to the + * controlPoint Characteristic. + * + * @param[in] params + * Information about the characterisitc being updated. + */ + virtual void onDataWritten(const GattCharacteristicWriteCBParams *params) { + if (params->charHandle == controlPoint.getValueAttribute().getHandle()) { + /* Do something here if the new value is 1; else you can override this method by + * extending this class. + * @NOTE: if you are extending this class, be sure to also call + * ble.onDataWritten(this, &ExtendedHRService::onDataWritten); in + * your constructor. + */ + } + } + +private: + void setupService(void) { + static bool serviceAdded = false; /* We should only ever need to add the heart rate service once. */ + if (serviceAdded) { + return; + } + + hrmRate.requireSecurity( Gap::SECURITY_MODE_ENCRYPTION_WITH_MITM); + GattCharacteristic *charTable[] = {&hrmRate, &hrmLocation, &controlPoint}; + GattService hrmService(GattService::UUID_HEART_RATE_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *)); + + ble.addService(hrmService); + serviceAdded = true; + + ble.onDataWritten(this, &HeartRateSecService::onDataWritten); + } + +private: + /* Private internal representation for the bytes used to work with the vaulue of the heart-rate characteristic. */ + struct HeartRateValueBytes { + static const unsigned MAX_VALUE_BYTES = 3; /* FLAGS + up to two bytes for heart-rate */ + static const unsigned FLAGS_BYTE_INDEX = 0; + + static const unsigned VALUE_FORMAT_BITNUM = 0; + static const uint8_t VALUE_FORMAT_FLAG = (1 << VALUE_FORMAT_BITNUM); + + HeartRateValueBytes(uint8_t hrmCounter) : valueBytes() { + updateHeartRate(hrmCounter); + } + + HeartRateValueBytes(uint16_t hrmCounter) : valueBytes() { + updateHeartRate(hrmCounter); + } + + void updateHeartRate(uint8_t hrmCounter) { + valueBytes[FLAGS_BYTE_INDEX] &= ~VALUE_FORMAT_FLAG; + valueBytes[FLAGS_BYTE_INDEX + 1] = hrmCounter; + } + + void updateHeartRate(uint16_t hrmCounter) { + valueBytes[FLAGS_BYTE_INDEX] |= VALUE_FORMAT_FLAG; + valueBytes[FLAGS_BYTE_INDEX + 1] = (uint8_t)(hrmCounter & 0xFF); + valueBytes[FLAGS_BYTE_INDEX + 2] = (uint8_t)(hrmCounter >> 8); + } + + uint8_t *getPointer(void) { + return valueBytes; + } + + const uint8_t *getPointer(void) const { + return valueBytes; + } + + unsigned getNumValueBytes(void) const { + return 1 + ((valueBytes[FLAGS_BYTE_INDEX] & VALUE_FORMAT_FLAG) ? sizeof(uint16_t) : sizeof(uint8_t)); + } + +private: + /* First byte = 8-bit values, no extra info, Second byte = uint8_t HRM value */ + /* See --> https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.heart_rate_measurement.xml */ + uint8_t valueBytes[MAX_VALUE_BYTES]; + }; + +private: + BLEDevice &ble; + + HeartRateValueBytes valueBytes; + uint8_t controlPointValue; + + GattCharacteristic hrmRate; + ReadOnlyGattCharacteristic<uint8_t> hrmLocation; + WriteOnlyGattCharacteristic<uint8_t> controlPoint; +}; + +#endif /* #ifndef __BLE_HEART_RATE_SEC_SAMPLE_SERVICE_H__*/ \ No newline at end of file
diff -r 52c48814da8e -r 2d9d4b271af8 main.cpp --- a/main.cpp Tue Jun 02 08:14:51 2015 +0000 +++ b/main.cpp Wed Jun 03 09:11:21 2015 +0000 @@ -16,7 +16,7 @@ #include "mbed.h" #include "BLEDevice.h" -#include "HeartRateService.h" +#include "HeartRateSecSampleSrv.h" #include "DeviceInformationService.h" /* Enable the following if you need to throttle the connection interval. This has @@ -28,16 +28,18 @@ BLEDevice ble; DigitalOut led1(LED1); -const static char DEVICE_NAME[] = "HRM1"; +const static char DEVICE_NAME[] = "HRM_SEC"; static const uint16_t uuid16_list[] = {GattService::UUID_HEART_RATE_SERVICE, GattService::UUID_DEVICE_INFORMATION_SERVICE}; static volatile bool triggerSensorPolling = false; void disconnectionCallback(Gap::Handle_t handle, Gap::DisconnectionReason_t reason) { + printf("Disconnected!\r\n"); ble.startAdvertising(); // restart advertising } + void periodicCallback(void) { led1 = !led1; /* Do blinky on LED1 while we're waiting for BLE events */ @@ -46,22 +48,34 @@ * heavy-weight sensor polling from the main thread. */ triggerSensorPolling = true; } -uint8_t KEY[6] = {0x01, 0x02, 0x00, 0x00, 0x00, 0x00}; + void connectionCallback(Gap::Handle_t handle, Gap::addr_type_t peerAddrType, const Gap::Address_t peerAddr, Gap::addr_type_t ownAddrType, const Gap::Address_t ownAddr, const Gap::ConnectionParams_t * pParam) { - printf("connected!\r\n"); + printf("Connected!\r\n"); } + void passkeyDisplayCallback(Gap::Handle_t handle, const Gap::Passkey_t passkey) { uint8_t i; printf("Input passKey: "); for(i = 0; i < 6; i++) { - printf("%d ", passkey[i]); + printf("%c ", passkey[i]); + } + printf("\r\n"); +} + + +void securitySetupCompletedCallback(Gap::Handle_t handle, Gap::SecurityCompletionStatus_t status) +{ + if(!status) { + printf("Security success\r\n", status); + } else { + printf("Security failed\r\n", status); } } @@ -71,16 +85,23 @@ led1 = 1; Ticker ticker; ticker.attach(periodicCallback, 1); // blink LED every second -printf("Started\r\n"); + printf("Started\r\n"); + + /* Initialize BLE module */ ble.init(); + + /* Initialize BLE security */ ble.initializeSecurity(true, true, Gap::IO_CAPS_DISPLAY_ONLY, NULL); - //ble.initializeSecurity(); + + /* Set callback functions */ ble.onConnection(connectionCallback); ble.onDisconnection(disconnectionCallback); ble.onPasskeyDisplay(passkeyDisplayCallback); + ble.onSecuritySetupCompleted(securitySetupCompletedCallback); + /* Setup primary service. */ uint8_t hrmCounter = 100; // init HRM to 100bps - HeartRateService hrService(ble, hrmCounter, HeartRateService::LOCATION_FINGER); + HeartRateSecService hrService(ble, hrmCounter, HeartRateSecService::LOCATION_FINGER); /* Setup auxiliary service. */ DeviceInformationService deviceInfo(ble, "ARM", "Model1", "SN1", "hw-rev1", "fw-rev1", "soft-rev1");