Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/source/bluetooth/MicroBitAccelerometerService.cpp@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MrBedfordVan 0:b9164b348919 1 /*
MrBedfordVan 0:b9164b348919 2 The MIT License (MIT)
MrBedfordVan 0:b9164b348919 3
MrBedfordVan 0:b9164b348919 4 Copyright (c) 2016 British Broadcasting Corporation.
MrBedfordVan 0:b9164b348919 5 This software is provided by Lancaster University by arrangement with the BBC.
MrBedfordVan 0:b9164b348919 6
MrBedfordVan 0:b9164b348919 7 Permission is hereby granted, free of charge, to any person obtaining a
MrBedfordVan 0:b9164b348919 8 copy of this software and associated documentation files (the "Software"),
MrBedfordVan 0:b9164b348919 9 to deal in the Software without restriction, including without limitation
MrBedfordVan 0:b9164b348919 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
MrBedfordVan 0:b9164b348919 11 and/or sell copies of the Software, and to permit persons to whom the
MrBedfordVan 0:b9164b348919 12 Software is furnished to do so, subject to the following conditions:
MrBedfordVan 0:b9164b348919 13
MrBedfordVan 0:b9164b348919 14 The above copyright notice and this permission notice shall be included in
MrBedfordVan 0:b9164b348919 15 all copies or substantial portions of the Software.
MrBedfordVan 0:b9164b348919 16
MrBedfordVan 0:b9164b348919 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
MrBedfordVan 0:b9164b348919 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
MrBedfordVan 0:b9164b348919 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
MrBedfordVan 0:b9164b348919 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
MrBedfordVan 0:b9164b348919 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
MrBedfordVan 0:b9164b348919 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
MrBedfordVan 0:b9164b348919 23 DEALINGS IN THE SOFTWARE.
MrBedfordVan 0:b9164b348919 24 */
MrBedfordVan 0:b9164b348919 25
MrBedfordVan 0:b9164b348919 26 /**
MrBedfordVan 0:b9164b348919 27 * Class definition for the custom MicroBit Accelerometer Service.
MrBedfordVan 0:b9164b348919 28 * Provides a BLE service to remotely read the state of the accelerometer, and configure its behaviour.
MrBedfordVan 0:b9164b348919 29 */
MrBedfordVan 0:b9164b348919 30 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 31 #include "ble/UUID.h"
MrBedfordVan 0:b9164b348919 32
MrBedfordVan 0:b9164b348919 33 #include "MicroBitAccelerometerService.h"
MrBedfordVan 0:b9164b348919 34
MrBedfordVan 0:b9164b348919 35 /**
MrBedfordVan 0:b9164b348919 36 * Constructor.
MrBedfordVan 0:b9164b348919 37 * Create a representation of the AccelerometerService
MrBedfordVan 0:b9164b348919 38 * @param _ble The instance of a BLE device that we're running on.
MrBedfordVan 0:b9164b348919 39 * @param _accelerometer An instance of MicroBitAccelerometer.
MrBedfordVan 0:b9164b348919 40 */
MrBedfordVan 0:b9164b348919 41 MicroBitAccelerometerService::MicroBitAccelerometerService(BLEDevice &_ble, MicroBitAccelerometer &_accelerometer) :
MrBedfordVan 0:b9164b348919 42 ble(_ble), accelerometer(_accelerometer)
MrBedfordVan 0:b9164b348919 43 {
MrBedfordVan 0:b9164b348919 44 // Create the data structures that represent each of our characteristics in Soft Device.
MrBedfordVan 0:b9164b348919 45 GattCharacteristic accelerometerDataCharacteristic(MicroBitAccelerometerServiceDataUUID, (uint8_t *)accelerometerDataCharacteristicBuffer, 0,
MrBedfordVan 0:b9164b348919 46 sizeof(accelerometerDataCharacteristicBuffer), GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY);
MrBedfordVan 0:b9164b348919 47
MrBedfordVan 0:b9164b348919 48 GattCharacteristic accelerometerPeriodCharacteristic(MicroBitAccelerometerServicePeriodUUID, (uint8_t *)&accelerometerPeriodCharacteristicBuffer, 0,
MrBedfordVan 0:b9164b348919 49 sizeof(accelerometerPeriodCharacteristicBuffer),
MrBedfordVan 0:b9164b348919 50 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE);
MrBedfordVan 0:b9164b348919 51
MrBedfordVan 0:b9164b348919 52 // Initialise our characteristic values.
MrBedfordVan 0:b9164b348919 53 accelerometerDataCharacteristicBuffer[0] = 0;
MrBedfordVan 0:b9164b348919 54 accelerometerDataCharacteristicBuffer[1] = 0;
MrBedfordVan 0:b9164b348919 55 accelerometerDataCharacteristicBuffer[2] = 0;
MrBedfordVan 0:b9164b348919 56 accelerometerPeriodCharacteristicBuffer = accelerometer.getPeriod();
MrBedfordVan 0:b9164b348919 57
MrBedfordVan 0:b9164b348919 58 // Set default security requirements
MrBedfordVan 0:b9164b348919 59 accelerometerDataCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
MrBedfordVan 0:b9164b348919 60 accelerometerPeriodCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
MrBedfordVan 0:b9164b348919 61
MrBedfordVan 0:b9164b348919 62 GattCharacteristic *characteristics[] = {&accelerometerDataCharacteristic, &accelerometerPeriodCharacteristic};
MrBedfordVan 0:b9164b348919 63 GattService service(MicroBitAccelerometerServiceUUID, characteristics, sizeof(characteristics) / sizeof(GattCharacteristic *));
MrBedfordVan 0:b9164b348919 64
MrBedfordVan 0:b9164b348919 65 ble.addService(service);
MrBedfordVan 0:b9164b348919 66
MrBedfordVan 0:b9164b348919 67 accelerometerDataCharacteristicHandle = accelerometerDataCharacteristic.getValueHandle();
MrBedfordVan 0:b9164b348919 68 accelerometerPeriodCharacteristicHandle = accelerometerPeriodCharacteristic.getValueHandle();
MrBedfordVan 0:b9164b348919 69
MrBedfordVan 0:b9164b348919 70 ble.gattServer().write(accelerometerDataCharacteristicHandle,(uint8_t *)accelerometerDataCharacteristicBuffer, sizeof(accelerometerDataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 71 ble.gattServer().write(accelerometerPeriodCharacteristicHandle, (const uint8_t *)&accelerometerPeriodCharacteristicBuffer, sizeof(accelerometerPeriodCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 72
MrBedfordVan 0:b9164b348919 73 ble.onDataWritten(this, &MicroBitAccelerometerService::onDataWritten);
MrBedfordVan 0:b9164b348919 74
MrBedfordVan 0:b9164b348919 75 if (EventModel::defaultEventBus)
MrBedfordVan 0:b9164b348919 76 EventModel::defaultEventBus->listen(MICROBIT_ID_ACCELEROMETER, MICROBIT_ACCELEROMETER_EVT_DATA_UPDATE, this, &MicroBitAccelerometerService::accelerometerUpdate, MESSAGE_BUS_LISTENER_IMMEDIATE);
MrBedfordVan 0:b9164b348919 77 }
MrBedfordVan 0:b9164b348919 78
MrBedfordVan 0:b9164b348919 79 /**
MrBedfordVan 0:b9164b348919 80 * Callback. Invoked when any of our attributes are written via BLE.
MrBedfordVan 0:b9164b348919 81 */
MrBedfordVan 0:b9164b348919 82 void MicroBitAccelerometerService::onDataWritten(const GattWriteCallbackParams *params)
MrBedfordVan 0:b9164b348919 83 {
MrBedfordVan 0:b9164b348919 84 if (params->handle == accelerometerPeriodCharacteristicHandle && params->len >= sizeof(accelerometerPeriodCharacteristicBuffer))
MrBedfordVan 0:b9164b348919 85 {
MrBedfordVan 0:b9164b348919 86 accelerometerPeriodCharacteristicBuffer = *((uint16_t *)params->data);
MrBedfordVan 0:b9164b348919 87 accelerometer.setPeriod(accelerometerPeriodCharacteristicBuffer);
MrBedfordVan 0:b9164b348919 88
MrBedfordVan 0:b9164b348919 89 // The accelerometer will choose the nearest period to that requested that it can support
MrBedfordVan 0:b9164b348919 90 // Read back the ACTUAL period it is using, and report this back.
MrBedfordVan 0:b9164b348919 91 accelerometerPeriodCharacteristicBuffer = accelerometer.getPeriod();
MrBedfordVan 0:b9164b348919 92 ble.gattServer().write(accelerometerPeriodCharacteristicHandle, (const uint8_t *)&accelerometerPeriodCharacteristicBuffer, sizeof(accelerometerPeriodCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 93 }
MrBedfordVan 0:b9164b348919 94 }
MrBedfordVan 0:b9164b348919 95
MrBedfordVan 0:b9164b348919 96 /**
MrBedfordVan 0:b9164b348919 97 * Accelerometer update callback
MrBedfordVan 0:b9164b348919 98 */
MrBedfordVan 0:b9164b348919 99 void MicroBitAccelerometerService::accelerometerUpdate(MicroBitEvent)
MrBedfordVan 0:b9164b348919 100 {
MrBedfordVan 0:b9164b348919 101 if (ble.getGapState().connected)
MrBedfordVan 0:b9164b348919 102 {
MrBedfordVan 0:b9164b348919 103 accelerometerDataCharacteristicBuffer[0] = accelerometer.getX();
MrBedfordVan 0:b9164b348919 104 accelerometerDataCharacteristicBuffer[1] = accelerometer.getY();
MrBedfordVan 0:b9164b348919 105 accelerometerDataCharacteristicBuffer[2] = accelerometer.getZ();
MrBedfordVan 0:b9164b348919 106
MrBedfordVan 0:b9164b348919 107 ble.gattServer().notify(accelerometerDataCharacteristicHandle,(uint8_t *)accelerometerDataCharacteristicBuffer, sizeof(accelerometerDataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 108 }
MrBedfordVan 0:b9164b348919 109 }
MrBedfordVan 0:b9164b348919 110
MrBedfordVan 0:b9164b348919 111 const uint8_t MicroBitAccelerometerServiceUUID[] = {
MrBedfordVan 0:b9164b348919 112 0xe9,0x5d,0x07,0x53,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
MrBedfordVan 0:b9164b348919 113 };
MrBedfordVan 0:b9164b348919 114
MrBedfordVan 0:b9164b348919 115 const uint8_t MicroBitAccelerometerServiceDataUUID[] = {
MrBedfordVan 0:b9164b348919 116 0xe9,0x5d,0xca,0x4b,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
MrBedfordVan 0:b9164b348919 117 };
MrBedfordVan 0:b9164b348919 118
MrBedfordVan 0:b9164b348919 119 const uint8_t MicroBitAccelerometerServicePeriodUUID[] = {
MrBedfordVan 0:b9164b348919 120 0xe9,0x5d,0xfb,0x24,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
MrBedfordVan 0:b9164b348919 121 };