Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/inc/bluetooth/MicroBitEventService.h@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 #ifndef MICROBIT_EVENT_SERVICE_H
MrBedfordVan 0:b9164b348919 27 #define MICROBIT_EVENT_SERVICE_H
MrBedfordVan 0:b9164b348919 28
MrBedfordVan 0:b9164b348919 29 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 30 #include "ble/BLE.h"
MrBedfordVan 0:b9164b348919 31 #include "MicroBitEvent.h"
MrBedfordVan 0:b9164b348919 32 #include "EventModel.h"
MrBedfordVan 0:b9164b348919 33
MrBedfordVan 0:b9164b348919 34 // UUIDs for our service and characteristics
MrBedfordVan 0:b9164b348919 35 extern const uint8_t MicroBitEventServiceUUID[];
MrBedfordVan 0:b9164b348919 36 extern const uint8_t MicroBitEventServiceMicroBitEventCharacteristicUUID[];
MrBedfordVan 0:b9164b348919 37 extern const uint8_t MicroBitEventServiceClientEventCharacteristicUUID[];
MrBedfordVan 0:b9164b348919 38 extern const uint8_t MicroBitEventServiceMicroBitRequirementsCharacteristicUUID[];
MrBedfordVan 0:b9164b348919 39 extern const uint8_t MicroBitEventServiceClientRequirementsCharacteristicUUID[];
MrBedfordVan 0:b9164b348919 40
MrBedfordVan 0:b9164b348919 41 struct EventServiceEvent
MrBedfordVan 0:b9164b348919 42 {
MrBedfordVan 0:b9164b348919 43 uint16_t type;
MrBedfordVan 0:b9164b348919 44 uint16_t reason;
MrBedfordVan 0:b9164b348919 45 };
MrBedfordVan 0:b9164b348919 46
MrBedfordVan 0:b9164b348919 47
MrBedfordVan 0:b9164b348919 48 /**
MrBedfordVan 0:b9164b348919 49 * Class definition for a MicroBit BLE Event Service.
MrBedfordVan 0:b9164b348919 50 * Provides a BLE gateway onto an Event Model.
MrBedfordVan 0:b9164b348919 51 */
MrBedfordVan 0:b9164b348919 52 class MicroBitEventService : public MicroBitComponent
MrBedfordVan 0:b9164b348919 53 {
MrBedfordVan 0:b9164b348919 54 public:
MrBedfordVan 0:b9164b348919 55
MrBedfordVan 0:b9164b348919 56 /**
MrBedfordVan 0:b9164b348919 57 * Constructor.
MrBedfordVan 0:b9164b348919 58 * Create a representation of the EventService
MrBedfordVan 0:b9164b348919 59 * @param _ble The instance of a BLE device that we're running on.
MrBedfordVan 0:b9164b348919 60 * @param _messageBus An instance of an EventModel which events will be mirrored from.
MrBedfordVan 0:b9164b348919 61 */
MrBedfordVan 0:b9164b348919 62 MicroBitEventService(BLEDevice &_ble, EventModel &_messageBus);
MrBedfordVan 0:b9164b348919 63
MrBedfordVan 0:b9164b348919 64 /**
MrBedfordVan 0:b9164b348919 65 * Periodic callback from MicroBit scheduler.
MrBedfordVan 0:b9164b348919 66 * If we're no longer connected, remove any registered Message Bus listeners.
MrBedfordVan 0:b9164b348919 67 */
MrBedfordVan 0:b9164b348919 68 virtual void idleTick();
MrBedfordVan 0:b9164b348919 69
MrBedfordVan 0:b9164b348919 70 /**
MrBedfordVan 0:b9164b348919 71 * Callback. Invoked when any of our attributes are written via BLE.
MrBedfordVan 0:b9164b348919 72 */
MrBedfordVan 0:b9164b348919 73 void onDataWritten(const GattWriteCallbackParams *params);
MrBedfordVan 0:b9164b348919 74
MrBedfordVan 0:b9164b348919 75 /**
MrBedfordVan 0:b9164b348919 76 * Callback. Invoked when any events are sent on the microBit message bus.
MrBedfordVan 0:b9164b348919 77 */
MrBedfordVan 0:b9164b348919 78 void onMicroBitEvent(MicroBitEvent evt);
MrBedfordVan 0:b9164b348919 79
MrBedfordVan 0:b9164b348919 80 /**
MrBedfordVan 0:b9164b348919 81 * Read callback on microBitRequirements characteristic.
MrBedfordVan 0:b9164b348919 82 *
MrBedfordVan 0:b9164b348919 83 * Used to iterate through the events that the code on this micro:bit is interested in.
MrBedfordVan 0:b9164b348919 84 */
MrBedfordVan 0:b9164b348919 85 void onRequirementsRead(GattReadAuthCallbackParams *params);
MrBedfordVan 0:b9164b348919 86
MrBedfordVan 0:b9164b348919 87 private:
MrBedfordVan 0:b9164b348919 88
MrBedfordVan 0:b9164b348919 89 // Bluetooth stack we're running on.
MrBedfordVan 0:b9164b348919 90 BLEDevice &ble;
MrBedfordVan 0:b9164b348919 91 EventModel &messageBus;
MrBedfordVan 0:b9164b348919 92
MrBedfordVan 0:b9164b348919 93 // memory for our event characteristics.
MrBedfordVan 0:b9164b348919 94 EventServiceEvent clientEventBuffer;
MrBedfordVan 0:b9164b348919 95 EventServiceEvent microBitEventBuffer;
MrBedfordVan 0:b9164b348919 96 EventServiceEvent microBitRequirementsBuffer;
MrBedfordVan 0:b9164b348919 97 EventServiceEvent clientRequirementsBuffer;
MrBedfordVan 0:b9164b348919 98
MrBedfordVan 0:b9164b348919 99 // handles on this service's characterisitics.
MrBedfordVan 0:b9164b348919 100 GattAttribute::Handle_t microBitEventCharacteristicHandle;
MrBedfordVan 0:b9164b348919 101 GattAttribute::Handle_t clientRequirementsCharacteristicHandle;
MrBedfordVan 0:b9164b348919 102 GattAttribute::Handle_t clientEventCharacteristicHandle;
MrBedfordVan 0:b9164b348919 103 GattCharacteristic *microBitRequirementsCharacteristic;
MrBedfordVan 0:b9164b348919 104
MrBedfordVan 0:b9164b348919 105 // Message bus offset last sent to the client...
MrBedfordVan 0:b9164b348919 106 uint16_t messageBusListenerOffset;
MrBedfordVan 0:b9164b348919 107
MrBedfordVan 0:b9164b348919 108 };
MrBedfordVan 0:b9164b348919 109
MrBedfordVan 0:b9164b348919 110
MrBedfordVan 0:b9164b348919 111 #endif