Martin Woolley / microbit-dal

Solution for Bluetooth SIG hands-on training course

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

Dependents:   microbit

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

inc/bluetooth/MicroBitAnimationService.h@81:58bd55de8fc6, 2017-02-06 (annotated)

Committer:
bluetooth_mdw
Date:
Mon Feb 06 09:22:57 2017 +0000
Revision:
81:58bd55de8fc6
Added button B to display name

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bluetooth_mdw 81:58bd55de8fc6 1 /*
bluetooth_mdw 81:58bd55de8fc6 2 The MIT License (MIT)
bluetooth_mdw 81:58bd55de8fc6 3
bluetooth_mdw 81:58bd55de8fc6 4 Copyright (c) 2016 British Broadcasting Corporation.
bluetooth_mdw 81:58bd55de8fc6 5 This software is provided by Lancaster University by arrangement with the BBC.
bluetooth_mdw 81:58bd55de8fc6 6
bluetooth_mdw 81:58bd55de8fc6 7 Permission is hereby granted, free of charge, to any person obtaining a
bluetooth_mdw 81:58bd55de8fc6 8 copy of this software and associated documentation files (the "Software"),
bluetooth_mdw 81:58bd55de8fc6 9 to deal in the Software without restriction, including without limitation
bluetooth_mdw 81:58bd55de8fc6 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
bluetooth_mdw 81:58bd55de8fc6 11 and/or sell copies of the Software, and to permit persons to whom the
bluetooth_mdw 81:58bd55de8fc6 12 Software is furnished to do so, subject to the following conditions:
bluetooth_mdw 81:58bd55de8fc6 13
bluetooth_mdw 81:58bd55de8fc6 14 The above copyright notice and this permission notice shall be included in
bluetooth_mdw 81:58bd55de8fc6 15 all copies or substantial portions of the Software.
bluetooth_mdw 81:58bd55de8fc6 16
bluetooth_mdw 81:58bd55de8fc6 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
bluetooth_mdw 81:58bd55de8fc6 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
bluetooth_mdw 81:58bd55de8fc6 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO Animation SHALL
bluetooth_mdw 81:58bd55de8fc6 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
bluetooth_mdw 81:58bd55de8fc6 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
bluetooth_mdw 81:58bd55de8fc6 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
bluetooth_mdw 81:58bd55de8fc6 23 DEALINGS IN THE SOFTWARE.
bluetooth_mdw 81:58bd55de8fc6 24 */
bluetooth_mdw 81:58bd55de8fc6 25
bluetooth_mdw 81:58bd55de8fc6 26 #ifndef MICROBIT_ANIMATION_SERVICE_H
bluetooth_mdw 81:58bd55de8fc6 27 #define MICROBIT_ANIMATION_SERVICE_H
bluetooth_mdw 81:58bd55de8fc6 28
bluetooth_mdw 81:58bd55de8fc6 29 #include "MicroBitConfig.h"
bluetooth_mdw 81:58bd55de8fc6 30 #include "Animator.h"
bluetooth_mdw 81:58bd55de8fc6 31 #include "ble/BLE.h"
bluetooth_mdw 81:58bd55de8fc6 32
bluetooth_mdw 81:58bd55de8fc6 33 /**
bluetooth_mdw 81:58bd55de8fc6 34 * Class definition for a MicroBit BLE Animation Service.
bluetooth_mdw 81:58bd55de8fc6 35 */
bluetooth_mdw 81:58bd55de8fc6 36
bluetooth_mdw 81:58bd55de8fc6 37 extern const uint8_t MicroBitAnimationServiceUUID[];
bluetooth_mdw 81:58bd55de8fc6 38 // animation type: indicates the type of animation that should be executed by the microbit : R|W
bluetooth_mdw 81:58bd55de8fc6 39 extern const uint8_t MicroBitAnimationServiceAnimationTypeCharacteristicUUID[];
bluetooth_mdw 81:58bd55de8fc6 40 // animation status: indicates whether or not an animation is currently in progress : R|N
bluetooth_mdw 81:58bd55de8fc6 41 extern const uint8_t MicroBitAnimationServiceAnimationStatusCharacteristicUUID[];
bluetooth_mdw 81:58bd55de8fc6 42 // animation control: allows various types of control to be exercised (start|stop|faster|slower) : W
bluetooth_mdw 81:58bd55de8fc6 43 extern const uint8_t MicroBitAnimationServiceAnimationControlCharacteristicUUID[];
bluetooth_mdw 81:58bd55de8fc6 44
bluetooth_mdw 81:58bd55de8fc6 45 class MicroBitAnimationService
bluetooth_mdw 81:58bd55de8fc6 46 {
bluetooth_mdw 81:58bd55de8fc6 47 public:
bluetooth_mdw 81:58bd55de8fc6 48
bluetooth_mdw 81:58bd55de8fc6 49 /**
bluetooth_mdw 81:58bd55de8fc6 50 * Constructor.
bluetooth_mdw 81:58bd55de8fc6 51 * Create a representation of the AnimationService
bluetooth_mdw 81:58bd55de8fc6 52 * @param _ble The instance of a BLE device that we're running on.
bluetooth_mdw 81:58bd55de8fc6 53 */
bluetooth_mdw 81:58bd55de8fc6 54 MicroBitAnimationService(BLEDevice &_ble);
bluetooth_mdw 81:58bd55de8fc6 55
bluetooth_mdw 81:58bd55de8fc6 56 /**
bluetooth_mdw 81:58bd55de8fc6 57 * Callback. Invoked when a characteristic is written to
bluetooth_mdw 81:58bd55de8fc6 58 */
bluetooth_mdw 81:58bd55de8fc6 59 void onDataWritten(const GattWriteCallbackParams *params);
bluetooth_mdw 81:58bd55de8fc6 60
bluetooth_mdw 81:58bd55de8fc6 61 private:
bluetooth_mdw 81:58bd55de8fc6 62
bluetooth_mdw 81:58bd55de8fc6 63 // Bluetooth stack we're running on.
bluetooth_mdw 81:58bd55de8fc6 64 BLEDevice &ble;
bluetooth_mdw 81:58bd55de8fc6 65
bluetooth_mdw 81:58bd55de8fc6 66
bluetooth_mdw 81:58bd55de8fc6 67 // TODO: memory for our Animation characteristics.
bluetooth_mdw 81:58bd55de8fc6 68
bluetooth_mdw 81:58bd55de8fc6 69
bluetooth_mdw 81:58bd55de8fc6 70
bluetooth_mdw 81:58bd55de8fc6 71 // TODO: handles on this service's characterisitics.
bluetooth_mdw 81:58bd55de8fc6 72
bluetooth_mdw 81:58bd55de8fc6 73
bluetooth_mdw 81:58bd55de8fc6 74
bluetooth_mdw 81:58bd55de8fc6 75 void animationStatusUpdate(MicroBitEvent e);
bluetooth_mdw 81:58bd55de8fc6 76
bluetooth_mdw 81:58bd55de8fc6 77 };
bluetooth_mdw 81:58bd55de8fc6 78
bluetooth_mdw 81:58bd55de8fc6 79 #endif