KEN OGAMI / microbit-dal-acc

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

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

Fork of microbit-dal by Martin Woolley

source/bluetooth/MicroBitAnimationService.cpp@82:91e085d6ad72, 2017-03-24 (annotated)

Committer:
bluetooth_mdw
Date:
Fri Mar 24 06:20:38 2017 +0000
Revision:
82:91e085d6ad72
Parent:
80:74afcabdc9a1
Child:
83:7e08ab5aba66
Removed comment re: writing initial values to the Attribute Table. Added comments to onDataWritten. Removed solution details.

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 82:91e085d6ad72 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 82:91e085d6ad72 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 82:91e085d6ad72 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 82:91e085d6ad72 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 82:91e085d6ad72 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 82:91e085d6ad72 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 82:91e085d6ad72 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 82:91e085d6ad72 44 // TODO: Three GattCharacteristic objects. UUID, valuePTR, length, max length, properties.
bluetooth_mdw 82:91e085d6ad72 45
bluetooth_mdw 82:91e085d6ad72 46 // TODO: initialise characteristic value buffers
bluetooth_mdw 82:91e085d6ad72 47
bluetooth_mdw 74:9771cd712730 48 // Set default security requirements - optional
bluetooth_mdw 74:9771cd712730 49 // animationTypeCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
bluetooth_mdw 74:9771cd712730 50 // animationStatusCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
bluetooth_mdw 74:9771cd712730 51 // animationControlCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
bluetooth_mdw 82:91e085d6ad72 52
bluetooth_mdw 82:91e085d6ad72 53 // TODO: create GattService containing the three characteristics
bluetooth_mdw 74:9771cd712730 54 // create an array of our characteristics so we can pass them to the service when we create it
bluetooth_mdw 74:9771cd712730 55
bluetooth_mdw 74:9771cd712730 56 // create the animation service and specify its characteristics
bluetooth_mdw 82:91e085d6ad72 57
bluetooth_mdw 82:91e085d6ad72 58
bluetooth_mdw 82:91e085d6ad72 59 // TODO: add the service to the Bluetooth attribute table
bluetooth_mdw 82:91e085d6ad72 60
bluetooth_mdw 82:91e085d6ad72 61 // TODO: take a note of the handles of our new characteristics now that they're in the attribute table
bluetooth_mdw 74:9771cd712730 62
bluetooth_mdw 82:91e085d6ad72 63 // TODO: register a callback function for when a characteristic is written to
bluetooth_mdw 74:9771cd712730 64
bluetooth_mdw 74:9771cd712730 65 // subscribe to animation status events so they can be notified to the connected client
bluetooth_mdw 74:9771cd712730 66 if (EventModel::defaultEventBus)
bluetooth_mdw 74:9771cd712730 67 EventModel::defaultEventBus->listen(ANIMATION_STATUS_EVENT, MICROBIT_EVT_ANY, this, &MicroBitAnimationService::animationStatusUpdate, MESSAGE_BUS_LISTENER_IMMEDIATE);
bluetooth_mdw 74:9771cd712730 68 }
bluetooth_mdw 82:91e085d6ad72 69
bluetooth_mdw 82:91e085d6ad72 70
bluetooth_mdw 74:9771cd712730 71 /**
bluetooth_mdw 74:9771cd712730 72 * Callback. Invoked when any of our attributes are written via BLE.
bluetooth_mdw 74:9771cd712730 73 */
bluetooth_mdw 74:9771cd712730 74 void MicroBitAnimationService::onDataWritten(const GattWriteCallbackParams *params)
bluetooth_mdw 74:9771cd712730 75 {
bluetooth_mdw 82:91e085d6ad72 76 // TODO: handle write to animation type characteristic
bluetooth_mdw 82:91e085d6ad72 77
bluetooth_mdw 82:91e085d6ad72 78 // TODO: handle write to animation control characteristic
bluetooth_mdw 74:9771cd712730 79 }
bluetooth_mdw 82:91e085d6ad72 80
bluetooth_mdw 74:9771cd712730 81 void MicroBitAnimationService::animationStatusUpdate(MicroBitEvent e)
bluetooth_mdw 74:9771cd712730 82 {
bluetooth_mdw 82:91e085d6ad72 83 // TODO: notify connected client of change to the animation status characteristic
bluetooth_mdw 74:9771cd712730 84 }
bluetooth_mdw 82:91e085d6ad72 85
bluetooth_mdw 74:9771cd712730 86 const uint8_t MicroBitAnimationServiceUUID[] = {
bluetooth_mdw 74:9771cd712730 87 0xe9,0x5d,0x71,0x70,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 88 };
bluetooth_mdw 82:91e085d6ad72 89
bluetooth_mdw 74:9771cd712730 90 const uint8_t MicroBitAnimationServiceAnimationTypeCharacteristicUUID[] = {
bluetooth_mdw 74:9771cd712730 91 0xe9,0x5d,0xC3,0x06,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 92 };
bluetooth_mdw 82:91e085d6ad72 93
bluetooth_mdw 74:9771cd712730 94 const uint8_t MicroBitAnimationServiceAnimationStatusCharacteristicUUID[] = {
bluetooth_mdw 74:9771cd712730 95 0xe9,0x5d,0x45,0x92,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 74:9771cd712730 96 };
bluetooth_mdw 82:91e085d6ad72 97
bluetooth_mdw 74:9771cd712730 98 const uint8_t MicroBitAnimationServiceAnimationControlCharacteristicUUID[] = {
bluetooth_mdw 74:9771cd712730 99 0xe9,0x5d,0xb8,0x4c,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
bluetooth_mdw 82:91e085d6ad72 100 };
bluetooth_mdw 82:91e085d6ad72 101