Philip Holifield / microbit-dal

from bbc microbit library

Dependencies:   BLE_API mbed-dev-bin nRF51822

Dependents:   microbit

Fork of microbit-dal by Lancaster University

inc/bluetooth/MicroBitEventService.h@75:c700add33ba5, 2018-01-11 (annotated)

Committer:
euxton
Date:
Thu Jan 11 21:54:30 2018 +0000
Revision:
75:c700add33ba5
Parent:
1:8aa5cdb4ab67 
1st commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jonathan Austin 1:8aa5cdb4ab67 1 /*
Jonathan Austin 1:8aa5cdb4ab67 2 The MIT License (MIT)
Jonathan Austin 1:8aa5cdb4ab67 3
Jonathan Austin 1:8aa5cdb4ab67 4 Copyright (c) 2016 British Broadcasting Corporation.
Jonathan Austin 1:8aa5cdb4ab67 5 This software is provided by Lancaster University by arrangement with the BBC.
Jonathan Austin 1:8aa5cdb4ab67 6
Jonathan Austin 1:8aa5cdb4ab67 7 Permission is hereby granted, free of charge, to any person obtaining a
Jonathan Austin 1:8aa5cdb4ab67 8 copy of this software and associated documentation files (the "Software"),
Jonathan Austin 1:8aa5cdb4ab67 9 to deal in the Software without restriction, including without limitation
Jonathan Austin 1:8aa5cdb4ab67 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
Jonathan Austin 1:8aa5cdb4ab67 11 and/or sell copies of the Software, and to permit persons to whom the
Jonathan Austin 1:8aa5cdb4ab67 12 Software is furnished to do so, subject to the following conditions:
Jonathan Austin 1:8aa5cdb4ab67 13
Jonathan Austin 1:8aa5cdb4ab67 14 The above copyright notice and this permission notice shall be included in
Jonathan Austin 1:8aa5cdb4ab67 15 all copies or substantial portions of the Software.
Jonathan Austin 1:8aa5cdb4ab67 16
Jonathan Austin 1:8aa5cdb4ab67 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Jonathan Austin 1:8aa5cdb4ab67 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jonathan Austin 1:8aa5cdb4ab67 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
Jonathan Austin 1:8aa5cdb4ab67 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Jonathan Austin 1:8aa5cdb4ab67 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 23 DEALINGS IN THE SOFTWARE.
Jonathan Austin 1:8aa5cdb4ab67 24 */
Jonathan Austin 1:8aa5cdb4ab67 25
Jonathan Austin 1:8aa5cdb4ab67 26 #ifndef MICROBIT_EVENT_SERVICE_H
Jonathan Austin 1:8aa5cdb4ab67 27 #define MICROBIT_EVENT_SERVICE_H
Jonathan Austin 1:8aa5cdb4ab67 28
Jonathan Austin 1:8aa5cdb4ab67 29 #include "MicroBitConfig.h"
Jonathan Austin 1:8aa5cdb4ab67 30 #include "ble/BLE.h"
Jonathan Austin 1:8aa5cdb4ab67 31 #include "MicroBitEvent.h"
Jonathan Austin 1:8aa5cdb4ab67 32 #include "EventModel.h"
Jonathan Austin 1:8aa5cdb4ab67 33
Jonathan Austin 1:8aa5cdb4ab67 34 // UUIDs for our service and characteristics
Jonathan Austin 1:8aa5cdb4ab67 35 extern const uint8_t MicroBitEventServiceUUID[];
Jonathan Austin 1:8aa5cdb4ab67 36 extern const uint8_t MicroBitEventServiceMicroBitEventCharacteristicUUID[];
Jonathan Austin 1:8aa5cdb4ab67 37 extern const uint8_t MicroBitEventServiceClientEventCharacteristicUUID[];
Jonathan Austin 1:8aa5cdb4ab67 38 extern const uint8_t MicroBitEventServiceMicroBitRequirementsCharacteristicUUID[];
Jonathan Austin 1:8aa5cdb4ab67 39 extern const uint8_t MicroBitEventServiceClientRequirementsCharacteristicUUID[];
Jonathan Austin 1:8aa5cdb4ab67 40
Jonathan Austin 1:8aa5cdb4ab67 41 struct EventServiceEvent
Jonathan Austin 1:8aa5cdb4ab67 42 {
Jonathan Austin 1:8aa5cdb4ab67 43 uint16_t type;
Jonathan Austin 1:8aa5cdb4ab67 44 uint16_t reason;
Jonathan Austin 1:8aa5cdb4ab67 45 };
Jonathan Austin 1:8aa5cdb4ab67 46
Jonathan Austin 1:8aa5cdb4ab67 47
Jonathan Austin 1:8aa5cdb4ab67 48 /**
Jonathan Austin 1:8aa5cdb4ab67 49 * Class definition for a MicroBit BLE Event Service.
Jonathan Austin 1:8aa5cdb4ab67 50 * Provides a BLE gateway onto an Event Model.
Jonathan Austin 1:8aa5cdb4ab67 51 */
Jonathan Austin 1:8aa5cdb4ab67 52 class MicroBitEventService : public MicroBitComponent
Jonathan Austin 1:8aa5cdb4ab67 53 {
Jonathan Austin 1:8aa5cdb4ab67 54 public:
Jonathan Austin 1:8aa5cdb4ab67 55
Jonathan Austin 1:8aa5cdb4ab67 56 /**
Jonathan Austin 1:8aa5cdb4ab67 57 * Constructor.
Jonathan Austin 1:8aa5cdb4ab67 58 * Create a representation of the EventService
Jonathan Austin 1:8aa5cdb4ab67 59 * @param _ble The instance of a BLE device that we're running on.
Jonathan Austin 1:8aa5cdb4ab67 60 * @param _messageBus An instance of an EventModel which events will be mirrored from.
Jonathan Austin 1:8aa5cdb4ab67 61 */
Jonathan Austin 1:8aa5cdb4ab67 62 MicroBitEventService(BLEDevice &_ble, EventModel &_messageBus);
Jonathan Austin 1:8aa5cdb4ab67 63
Jonathan Austin 1:8aa5cdb4ab67 64 /**
Jonathan Austin 1:8aa5cdb4ab67 65 * Periodic callback from MicroBit scheduler.
Jonathan Austin 1:8aa5cdb4ab67 66 * If we're no longer connected, remove any registered Message Bus listeners.
Jonathan Austin 1:8aa5cdb4ab67 67 */
Jonathan Austin 1:8aa5cdb4ab67 68 virtual void idleTick();
Jonathan Austin 1:8aa5cdb4ab67 69
Jonathan Austin 1:8aa5cdb4ab67 70 /**
Jonathan Austin 1:8aa5cdb4ab67 71 * Callback. Invoked when any of our attributes are written via BLE.
Jonathan Austin 1:8aa5cdb4ab67 72 */
Jonathan Austin 1:8aa5cdb4ab67 73 void onDataWritten(const GattWriteCallbackParams *params);
Jonathan Austin 1:8aa5cdb4ab67 74
Jonathan Austin 1:8aa5cdb4ab67 75 /**
Jonathan Austin 1:8aa5cdb4ab67 76 * Callback. Invoked when any events are sent on the microBit message bus.
Jonathan Austin 1:8aa5cdb4ab67 77 */
Jonathan Austin 1:8aa5cdb4ab67 78 void onMicroBitEvent(MicroBitEvent evt);
Jonathan Austin 1:8aa5cdb4ab67 79
Jonathan Austin 1:8aa5cdb4ab67 80 /**
Jonathan Austin 1:8aa5cdb4ab67 81 * Read callback on microBitRequirements characteristic.
Jonathan Austin 1:8aa5cdb4ab67 82 *
Jonathan Austin 1:8aa5cdb4ab67 83 * Used to iterate through the events that the code on this micro:bit is interested in.
Jonathan Austin 1:8aa5cdb4ab67 84 */
Jonathan Austin 1:8aa5cdb4ab67 85 void onRequirementsRead(GattReadAuthCallbackParams *params);
Jonathan Austin 1:8aa5cdb4ab67 86
Jonathan Austin 1:8aa5cdb4ab67 87 private:
Jonathan Austin 1:8aa5cdb4ab67 88
Jonathan Austin 1:8aa5cdb4ab67 89 // Bluetooth stack we're running on.
Jonathan Austin 1:8aa5cdb4ab67 90 BLEDevice &ble;
Jonathan Austin 1:8aa5cdb4ab67 91 EventModel &messageBus;
Jonathan Austin 1:8aa5cdb4ab67 92
Jonathan Austin 1:8aa5cdb4ab67 93 // memory for our event characteristics.
Jonathan Austin 1:8aa5cdb4ab67 94 EventServiceEvent clientEventBuffer;
Jonathan Austin 1:8aa5cdb4ab67 95 EventServiceEvent microBitEventBuffer;
Jonathan Austin 1:8aa5cdb4ab67 96 EventServiceEvent microBitRequirementsBuffer;
Jonathan Austin 1:8aa5cdb4ab67 97 EventServiceEvent clientRequirementsBuffer;
Jonathan Austin 1:8aa5cdb4ab67 98
Jonathan Austin 1:8aa5cdb4ab67 99 // handles on this service's characterisitics.
Jonathan Austin 1:8aa5cdb4ab67 100 GattAttribute::Handle_t microBitEventCharacteristicHandle;
Jonathan Austin 1:8aa5cdb4ab67 101 GattAttribute::Handle_t clientRequirementsCharacteristicHandle;
Jonathan Austin 1:8aa5cdb4ab67 102 GattAttribute::Handle_t clientEventCharacteristicHandle;
Jonathan Austin 1:8aa5cdb4ab67 103 GattCharacteristic *microBitRequirementsCharacteristic;
Jonathan Austin 1:8aa5cdb4ab67 104
Jonathan Austin 1:8aa5cdb4ab67 105 // Message bus offset last sent to the client...
Jonathan Austin 1:8aa5cdb4ab67 106 uint16_t messageBusListenerOffset;
Jonathan Austin 1:8aa5cdb4ab67 107
Jonathan Austin 1:8aa5cdb4ab67 108 };
Jonathan Austin 1:8aa5cdb4ab67 109
Jonathan Austin 1:8aa5cdb4ab67 110
Jonathan Austin 1:8aa5cdb4ab67 111 #endif