Martin Woolley / microbit-dal-bluetooth-mdw_starter

My fork

Dependencies:   BLE_API mbed-dev-bin nRF51822-bluetooth-mdw

Fork of microbit-dal-bluetooth-mdw by Martin Woolley

source/bluetooth/MicroBitAnimationService.cpp@74:9771cd712730, 2016-12-27 (annotated)

Committer:
bluetooth_mdw
Date:
Tue Dec 27 10:48:18 2016 +0000
Revision:
74:9771cd712730
Child:
77:9909cbcd0ece
New Bluetooth animation service

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bluetooth_mdw 74:9771cd712730 1 /*
bluetooth_mdw 74:9771cd712730 2 The MIT License (MIT)
bluetooth_mdw 74:9771cd712730 3
bluetooth_mdw 74:9771cd712730 4 Copyright (c) 2016 British Broadcasting Corporation.
bluetooth_mdw 74:9771cd712730 5 This software is provided by Lancaster University by arrangement with the BBC.
bluetooth_mdw 74:9771cd712730 6
bluetooth_mdw 74:9771cd712730 7 Permission is hereby granted, free of charge, to any person obtaining a
bluetooth_mdw 74:9771cd712730 8 copy of this software and associated documentation files (the "Software"),
bluetooth_mdw 74:9771cd712730 9 to deal in the Software without restriction, including without limitation
bluetooth_mdw 74:9771cd712730 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
bluetooth_mdw 74:9771cd712730 11 and/or sell copies of the Software, and to permit persons to whom the
bluetooth_mdw 74:9771cd712730 12 Software is furnished to do so, subject to the following conditions:
bluetooth_mdw 74:9771cd712730 13
bluetooth_mdw 74:9771cd712730 14 The above copyright notice and this permission notice shall be included in
bluetooth_mdw 74:9771cd712730 15 all copies or substantial portions of the Software.
bluetooth_mdw 74:9771cd712730 16
bluetooth_mdw 74:9771cd712730 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
bluetooth_mdw 74:9771cd712730 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
bluetooth_mdw 74:9771cd712730 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO Animation SHALL
bluetooth_mdw 74:9771cd712730 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
bluetooth_mdw 74:9771cd712730 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
bluetooth_mdw 74:9771cd712730 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
bluetooth_mdw 74:9771cd712730 23 DEALINGS IN THE SOFTWARE.
bluetooth_mdw 74:9771cd712730 24 */
bluetooth_mdw 74:9771cd712730 25
bluetooth_mdw 74:9771cd712730 26 /**
bluetooth_mdw 74:9771cd712730 27 * Class definition for a MicroBit BLE Animation Service.
bluetooth_mdw 74:9771cd712730 28 * Provides a BLE gateway onto an Animation Model.
bluetooth_mdw 74:9771cd712730 29 */
bluetooth_mdw 74:9771cd712730 30
bluetooth_mdw 74:9771cd712730 31 #include "MicroBitConfig.h"
bluetooth_mdw 74:9771cd712730 32 #include "MicroBitAnimationService.h"
bluetooth_mdw 74:9771cd712730 33 #include "ble/UUID.h"
bluetooth_mdw 74:9771cd712730 34 #include "Animator.h"
bluetooth_mdw 74:9771cd712730 35
bluetooth_mdw 74:9771cd712730 36 /**
bluetooth_mdw 74:9771cd712730 37 * Constructor.
bluetooth_mdw 74:9771cd712730 38 * Create a representation of the AnimationService
bluetooth_mdw 74:9771cd712730 39 * @param _ble The instance of a BLE device that we're running on.
bluetooth_mdw 74:9771cd712730 40 */
bluetooth_mdw 74:9771cd712730 41 MicroBitAnimationService::MicroBitAnimationService(BLEDevice &_ble) :
bluetooth_mdw 74:9771cd712730 42 ble(_ble)
bluetooth_mdw 74:9771cd712730 43 {
bluetooth_mdw 74:9771cd712730 44 // UUID, valuePTR, length, max length, properties
bluetooth_mdw 74:9771cd712730 45 GattCharacteristic animationTypeCharacteristic(
bluetooth_mdw 74:9771cd712730 46 MicroBitAnimationServiceAnimationTypeCharacteristicUUID,
bluetooth_mdw 74:9771cd712730 47 (uint8_t *)animation_type_buffer,
bluetooth_mdw 74:9771cd712730 48 1,
bluetooth_mdw 74:9771cd712730 49 1,
bluetooth_mdw 74:9771cd712730 50 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE);
bluetooth_mdw 74:9771cd712730 51
bluetooth_mdw 74:9771cd712730 52 GattCharacteristic animationStatusCharacteristic(
bluetooth_mdw 74:9771cd712730 53 MicroBitAnimationServiceAnimationStatusCharacteristicUUID,
bluetooth_mdw 74:9771cd712730 54 (uint8_t *)animation_status_buffer,
bluetooth_mdw 74:9771cd712730 55 1,
bluetooth_mdw 74:9771cd712730 56 1,
bluetooth_mdw 74:9771cd712730 57 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY);
bluetooth_mdw 74:9771cd712730 58
bluetooth_mdw 74:9771cd712730 59 GattCharacteristic animationControlCharacteristic(
bluetooth_mdw 74:9771cd712730 60 MicroBitAnimationServiceAnimationControlCharacteristicUUID,
bluetooth_mdw 74:9771cd712730 61 (uint8_t *)animation_control_buffer,
bluetooth_mdw 74:9771cd712730 62 1,
bluetooth_mdw 74:9771cd712730 63 1,
bluetooth_mdw 74:9771cd712730 64 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE);
bluetooth_mdw 74:9771cd712730 65
bluetooth_mdw 74:9771cd712730 66 animation_type_buffer[0] = 0x00;
bluetooth_mdw 74:9771cd712730 67 animation_status_buffer[0] = 0x00;
bluetooth_mdw 74:9771cd712730 68 animation_control_buffer[0] = 0x00;
bluetooth_mdw 74:9771cd712730 69
bluetooth_mdw 74:9771cd712730 70 // Set default security requirements - optional
bluetooth_mdw 74:9771cd712730 71 // animationTypeCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
bluetooth_mdw 74:9771cd712730 72 // animationStatusCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
bluetooth_mdw 74:9771cd712730 73 // animationControlCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
bluetooth_mdw 74:9771cd712730 74
bluetooth_mdw 74:9771cd712730 75 // create an array of our characteristics so we can pass them to the service when we create it
bluetooth_mdw 74:9771cd712730 76 GattCharacteristic *characteristics[] = {&animationTypeCharacteristic, &animationStatusCharacteristic, &animationControlCharacteristic};
bluetooth_mdw 74:9771cd712730 77
bluetooth_mdw 74:9771cd712730 78 // create the animation service and specify its characteristics
bluetooth_mdw 74:9771cd712730 79 GattService service(MicroBitAnimationServiceUUID, characteristics, sizeof(characteristics) / sizeof(GattCharacteristic *));
bluetooth_mdw 74:9771cd712730 80
bluetooth_mdw 74:9771cd712730 81 // add the service to the Bluetooth attribute table
bluetooth_mdw 74:9771cd712730 82 ble.addService(service);
bluetooth_mdw 74:9771cd712730 83
bluetooth_mdw 74:9771cd712730 84 // take a note of the handles of our new characteristics now that they're in the attribute table
bluetooth_mdw 74:9771cd712730 85 animationTypeCharacteristicHandle = animationTypeCharacteristic.getValueHandle();
bluetooth_mdw 74:9771cd712730 86 animationStatusCharacteristicHandle = animationStatusCharacteristic.getValueHandle();
bluetooth_mdw 74:9771cd712730 87 animationControlCharacteristicHandle = animationControlCharacteristic.getValueHandle();
bluetooth_mdw 74:9771cd712730 88
bluetooth_mdw 74:9771cd712730 89 ble.gattServer().write(animationTypeCharacteristicHandle, (const uint8_t *)&animation_type_buffer, sizeof(animation_type_buffer));
bluetooth_mdw 74:9771cd712730 90 ble.gattServer().write(animationStatusCharacteristicHandle, (const uint8_t *)&animation_status_buffer, sizeof(animation_status_buffer));
bluetooth_mdw 74:9771cd712730 91 ble.gattServer().write(animationControlCharacteristicHandle, (const uint8_t *)&animation_control_buffer, sizeof(animation_control_buffer));
bluetooth_mdw 74:9771cd712730 92
bluetooth_mdw 74:9771cd712730 93 // register a callback function for when a characteristic is written to
bluetooth_mdw 74:9771cd712730 94 ble.onDataWritten(this, &MicroBitAnimationService::onDataWritten);
bluetooth_mdw 74:9771cd712730 95
bluetooth_mdw 74:9771cd712730 96 // subscribe to animation status events so they can be notified to the connected client
bluetooth_mdw 74:9771cd712730 97 if (EventModel::defaultEventBus)
bluetooth_mdw 74:9771cd712730 98 EventModel::defaultEventBus->listen(ANIMATION_STATUS_EVENT, MICROBIT_EVT_ANY, this, &MicroBitAnimationService::animationStatusUpdate, MESSAGE_BUS_LISTENER_IMMEDIATE);
bluetooth_mdw 74:9771cd712730 99 }
bluetooth_mdw 74:9771cd712730 100
bluetooth_mdw 74:9771cd712730 101
bluetooth_mdw 74:9771cd712730 102 /**
bluetooth_mdw 74:9771cd712730 103 * Callback. Invoked when any of our attributes are written via BLE.
bluetooth_mdw 74:9771cd712730 104 */
bluetooth_mdw 74:9771cd712730 105 void MicroBitAnimationService::onDataWritten(const GattWriteCallbackParams *params)
bluetooth_mdw 74:9771cd712730 106 {
bluetooth_mdw 74:9771cd712730 107
bluetooth_mdw 74:9771cd712730 108 if (params->handle == animationTypeCharacteristicHandle && params->len >= 1) {
bluetooth_mdw 74:9771cd712730 109 uint8_t *value = (uint8_t *)params->data;
bluetooth_mdw 74:9771cd712730 110 uint16_t event_value = static_cast<uint16_t>(value[0]);
bluetooth_mdw 74:9771cd712730 111 MicroBitEvent evt(ANIMATION_TYPE_EVENT, event_value);
bluetooth_mdw 74:9771cd712730 112 return;
bluetooth_mdw 74:9771cd712730 113 }
bluetooth_mdw 74:9771cd712730 114
bluetooth_mdw 74:9771cd712730 115 if (params->handle == animationControlCharacteristicHandle && params->len >= 1) {
bluetooth_mdw 74:9771cd712730 116 uint8_t *value = (uint8_t *)params->data;
bluetooth_mdw 74:9771cd712730 117 uint16_t event_value = static_cast<uint16_t>(value[0]);
bluetooth_mdw 74:9771cd712730 118 MicroBitEvent evt(ANIMATION_CONTROL_EVENT, event_value);
bluetooth_mdw 74:9771cd712730 119 return;
bluetooth_mdw 74:9771cd712730 120 }
bluetooth_mdw 74:9771cd712730 121 }
bluetooth_mdw 74:9771cd712730 122
bluetooth_mdw 74:9771cd712730 123 void MicroBitAnimationService::animationStatusUpdate(MicroBitEvent e)
bluetooth_mdw 74:9771cd712730 124 {
bluetooth_mdw 74:9771cd712730 125 if (ble.getGapState().connected)
bluetooth_mdw 74:9771cd712730 126 {
bluetooth_mdw 74:9771cd712730 127 animation_status_buffer[0] = e.value;
bluetooth_mdw 74:9771cd712730 128 ble.gattServer().notify(animationStatusCharacteristicHandle,(uint8_t *)animation_status_buffer, 1);
bluetooth_mdw 74:9771cd712730 129 }
bluetooth_mdw 74:9771cd712730 130 }
bluetooth_mdw 74:9771cd712730 131
bluetooth_mdw 74:9771cd712730 132 const uint8_t MicroBitAnimationServiceUUID[] = {
bluetooth_mdw 74:9771cd712730 133 0xe9,0x5d,0x71,0x70,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 134 };
bluetooth_mdw 74:9771cd712730 135
bluetooth_mdw 74:9771cd712730 136 const uint8_t MicroBitAnimationServiceAnimationTypeCharacteristicUUID[] = {
bluetooth_mdw 74:9771cd712730 137 0xe9,0x5d,0xC3,0x06,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 138 };
bluetooth_mdw 74:9771cd712730 139
bluetooth_mdw 74:9771cd712730 140 const uint8_t MicroBitAnimationServiceAnimationStatusCharacteristicUUID[] = {
bluetooth_mdw 74:9771cd712730 141 0xe9,0x5d,0x45,0x92,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 142 };
bluetooth_mdw 74:9771cd712730 143
bluetooth_mdw 74:9771cd712730 144 const uint8_t MicroBitAnimationServiceAnimationControlCharacteristicUUID[] = {
bluetooth_mdw 74:9771cd712730 145 0xe9,0x5d,0xb8,0x4c,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 146 };