Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/inc/bluetooth/MicroBitLEDService.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_LED_SERVICE_H
MrBedfordVan 0:b9164b348919 27 #define MICROBIT_LED_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 "MicroBitDisplay.h"
MrBedfordVan 0:b9164b348919 32
MrBedfordVan 0:b9164b348919 33 // Defines the buffer size for scrolling text over BLE, hence also defines
MrBedfordVan 0:b9164b348919 34 // the maximum string length that can be scrolled via the BLE service.
MrBedfordVan 0:b9164b348919 35 #define MICROBIT_BLE_MAXIMUM_SCROLLTEXT 20
MrBedfordVan 0:b9164b348919 36
MrBedfordVan 0:b9164b348919 37 // UUIDs for our service and characteristics
MrBedfordVan 0:b9164b348919 38 extern const uint8_t MicroBitLEDServiceUUID[];
MrBedfordVan 0:b9164b348919 39 extern const uint8_t MicroBitLEDServiceMatrixUUID[];
MrBedfordVan 0:b9164b348919 40 extern const uint8_t MicroBitLEDServiceTextUUID[];
MrBedfordVan 0:b9164b348919 41 extern const uint8_t MicroBitLEDServiceScrollingSpeedUUID[];
MrBedfordVan 0:b9164b348919 42
MrBedfordVan 0:b9164b348919 43
MrBedfordVan 0:b9164b348919 44 /**
MrBedfordVan 0:b9164b348919 45 * Class definition for the custom MicroBit LED Service.
MrBedfordVan 0:b9164b348919 46 * Provides a BLE service to remotely read and write the state of the LED display.
MrBedfordVan 0:b9164b348919 47 */
MrBedfordVan 0:b9164b348919 48 class MicroBitLEDService
MrBedfordVan 0:b9164b348919 49 {
MrBedfordVan 0:b9164b348919 50 public:
MrBedfordVan 0:b9164b348919 51
MrBedfordVan 0:b9164b348919 52 /**
MrBedfordVan 0:b9164b348919 53 * Constructor.
MrBedfordVan 0:b9164b348919 54 * Create a representation of the LEDService
MrBedfordVan 0:b9164b348919 55 * @param _ble The instance of a BLE device that we're running on.
MrBedfordVan 0:b9164b348919 56 * @param _display An instance of MicroBitDisplay to interface with.
MrBedfordVan 0:b9164b348919 57 */
MrBedfordVan 0:b9164b348919 58 MicroBitLEDService(BLEDevice &_ble, MicroBitDisplay &_display);
MrBedfordVan 0:b9164b348919 59
MrBedfordVan 0:b9164b348919 60 /**
MrBedfordVan 0:b9164b348919 61 * Callback. Invoked when any of our attributes are written via BLE.
MrBedfordVan 0:b9164b348919 62 */
MrBedfordVan 0:b9164b348919 63 void onDataWritten(const GattWriteCallbackParams *params);
MrBedfordVan 0:b9164b348919 64
MrBedfordVan 0:b9164b348919 65 /**
MrBedfordVan 0:b9164b348919 66 * Callback. Invoked when any of our attributes are read via BLE.
MrBedfordVan 0:b9164b348919 67 */
MrBedfordVan 0:b9164b348919 68 void onDataRead(GattReadAuthCallbackParams *params);
MrBedfordVan 0:b9164b348919 69
MrBedfordVan 0:b9164b348919 70 private:
MrBedfordVan 0:b9164b348919 71
MrBedfordVan 0:b9164b348919 72 // Bluetooth stack we're running on.
MrBedfordVan 0:b9164b348919 73 BLEDevice &ble;
MrBedfordVan 0:b9164b348919 74 MicroBitDisplay &display;
MrBedfordVan 0:b9164b348919 75
MrBedfordVan 0:b9164b348919 76 // memory for our 8 bit control characteristics.
MrBedfordVan 0:b9164b348919 77 uint8_t matrixCharacteristicBuffer[5];
MrBedfordVan 0:b9164b348919 78 uint16_t scrollingSpeedCharacteristicBuffer;
MrBedfordVan 0:b9164b348919 79 uint8_t textCharacteristicBuffer[MICROBIT_BLE_MAXIMUM_SCROLLTEXT];
MrBedfordVan 0:b9164b348919 80
MrBedfordVan 0:b9164b348919 81 // Handles to access each characteristic when they are held by Soft Device.
MrBedfordVan 0:b9164b348919 82 GattAttribute::Handle_t matrixCharacteristicHandle;
MrBedfordVan 0:b9164b348919 83 GattAttribute::Handle_t textCharacteristicHandle;
MrBedfordVan 0:b9164b348919 84 GattAttribute::Handle_t scrollingSpeedCharacteristicHandle;
MrBedfordVan 0:b9164b348919 85
MrBedfordVan 0:b9164b348919 86 // We hold a copy of the GattCharacteristic, as mbed's BLE API requires this to provide read callbacks (pity!).
MrBedfordVan 0:b9164b348919 87 GattCharacteristic matrixCharacteristic;
MrBedfordVan 0:b9164b348919 88 };
MrBedfordVan 0:b9164b348919 89
MrBedfordVan 0:b9164b348919 90
MrBedfordVan 0:b9164b348919 91 #endif