security manager conflict commented 2
Dependencies: BLE_API mbed-dev-bin nRF51822
Fork of microbit-dal by
Diff: inc/bluetooth/MicroBitIOPinService.h
- Revision:
- 1:8aa5cdb4ab67
- Child:
- 33:58453d751bca
diff -r fb15f7887843 -r 8aa5cdb4ab67 inc/bluetooth/MicroBitIOPinService.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/inc/bluetooth/MicroBitIOPinService.h Thu Apr 07 01:33:22 2016 +0100 @@ -0,0 +1,143 @@ +/* +The MIT License (MIT) + +Copyright (c) 2016 British Broadcasting Corporation. +This software is provided by Lancaster University by arrangement with the BBC. + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. +*/ + +#ifndef MICROBIT_IO_PIN_SERVICE_H +#define MICROBIT_IO_PIN_SERVICE_H + +#include "MicroBitConfig.h" +#include "ble/BLE.h" +#include "MicroBitIO.h" + +#define MICROBIT_IO_PIN_SERVICE_PINCOUNT 20 +#define MICROBIT_IO_PIN_SERVICE_DATA_SIZE 10 + +// UUIDs for our service and characteristics +extern const uint8_t MicroBitIOPinServiceUUID[]; +extern const uint8_t MicroBitIOPinServiceADConfigurationUUID[]; +extern const uint8_t MicroBitIOPinServiceIOConfigurationUUID[]; +extern const uint8_t MicroBitIOPinServiceDataUUID[]; +extern MicroBitPin * const MicroBitIOPins[]; + +/** + * Name value pair definition, as used to read and write pin values over BLE. + */ +struct IOData +{ + uint8_t pin; + uint8_t value; +}; + +/** + * Class definition for the custom MicroBit IOPin Service. + * Provides a BLE service to remotely read the state of the I/O Pin, and configure its behaviour. + */ +class MicroBitIOPinService : public MicroBitComponent +{ + public: + + /** + * Constructor. + * Create a representation of the IOPinService + * @param _ble The instance of a BLE device that we're running on. + * @param _io An instance of MicroBitIO that this service will use to perform + * I/O operations. + */ + MicroBitIOPinService(BLEDevice &_ble, MicroBitIO &_io); + + /** + * Periodic callback from MicroBit scheduler. + * + * Check if any of the pins we're watching need updating. Notify any connected + * device with any changes. + */ + virtual void idleTick(); + + private: + + /** + * Callback. Invoked when any of our attributes are written via BLE. + */ + void onDataWritten(const GattWriteCallbackParams *params); + + /** + * Callback. invoked when the BLE data characteristic is read. + * + * Reads all the pins marked as inputs, and updates the data stored in the characteristic. + */ + void onDataRead(GattReadAuthCallbackParams *params); + + /** + * Determines if the given pin was configured as a digital pin by the BLE ADPinConfigurationCharacterisitic. + * + * @param i the enumeration of the pin to test + * @return 1 if this pin is configured as digital, 0 otherwise + */ + int isDigital(int i); + + /** + * Determines if the given pin was configured as an analog pin by the BLE ADPinConfigurationCharacterisitic. + * + * @param i the enumeration of the pin to test + * @return 1 if this pin is configured as analog, 0 otherwise + */ + int isAnalog(int i); + + /** + * Determines if the given pin was configured as an input by the BLE IOPinConfigurationCharacterisitic. + * + * @param i the enumeration of the pin to test + * @return 1 if this pin is configured as an input, 0 otherwise + */ + int isInput(int i); + + /** + * Determines if the given pin was configured as output by the BLE IOPinConfigurationCharacterisitic. + * + * @param i the enumeration of the pin to test + * @return 1 if this pin is configured as an output, 0 otherwise + */ + int isOutput(int i); + + + // Bluetooth stack we're running on. + BLEDevice &ble; + MicroBitIO &io; + + // memory for our 8 bit control characteristics. + uint32_t ioPinServiceADCharacteristicBuffer; + uint32_t ioPinServiceIOCharacteristicBuffer; + IOData ioPinServiceDataCharacteristicBuffer[MICROBIT_IO_PIN_SERVICE_DATA_SIZE]; + + // Historic information about our pin data data. + uint8_t ioPinServiceIOData[MICROBIT_IO_PIN_SERVICE_PINCOUNT]; + + // Handles to access each characteristic when they are held by Soft Device. + GattAttribute::Handle_t ioPinServiceADCharacteristicHandle; + GattAttribute::Handle_t ioPinServiceIOCharacteristicHandle; + GattCharacteristic *ioPinServiceDataCharacteristic; +}; + + +#endif