KEN OGAMI / microbit-dal-acc

forking microbit-dal

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

Fork of microbit-dal by Martin Woolley

inc/bluetooth/MicroBitAnimationService.h@84:c88c197471f9, 2017-11-29 (annotated)

Committer:
bluetooth_kyo
Date:
Wed Nov 29 22:42:39 2017 +0000
Revision:
84:c88c197471f9
Parent:
83:7e08ab5aba66 
forking microbit-dal

Who changed what in which revision?

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