Cefn Hoile / microbit-dal

Attempting to publish a tree

Dependencies:   BLE_API mbed-dev-bin nRF51822

Fork of microbit-dal by Lancaster University

inc/bluetooth/MicroBitLEDService.h@18:ce4dd8fcdf4f, 2016-06-01 (annotated)

Committer:
cefn
Date:
Wed Jun 01 17:43:26 2016 +0000
Revision:
18:ce4dd8fcdf4f
Parent:
1:8aa5cdb4ab67 
Attempting to publish a tree

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