MicroBitValueService.h

00001 /*
00002 The MIT License (MIT)
00003 
00004 Copyright (c) 2016 British Broadcasting Corporation.
00005 This software is provided by Lancaster University by arrangement with the BBC.
00006 
00007 Permission is hereby granted, free of charge, to any person obtaining a
00008 copy of this software and associated documentation files (the "Software"),
00009 to deal in the Software without restriction, including without limitation
00010 the rights to use, copy, modify, merge, publish, distribute, sublicense,
00011 and/or sell copies of the Software, and to permit persons to whom the
00012 Software is furnished to do so, subject to the following conditions:
00013 
00014 The above copyright notice and this permission notice shall be included in
00015 all copies or substantial portions of the Software.
00016 
00017 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00018 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00019 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
00020 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00021 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00022 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
00023 DEALINGS IN THE SOFTWARE.
00024 */
00025 
00026 #ifndef MICROBIT_VALUE_SERVICE_H
00027 #define MICROBIT_VALUE_SERVICE_H
00028 
00029 #include "ble/BLE.h"
00030 #include "MicroBitConfig.h"
00031 #include "EventModel.h"
00032 
00033 #define MICROBIT_VALUE_EVT_UPDATE 1
00034 
00035 // UUIDs for our service and characteristics
00036 extern const uint8_t  MicroBitValueServiceUUID[];
00037 extern const uint8_t  MicroBitValueServiceDataUUID[];
00038 extern const uint8_t  MicroBitValueServiceBearingUUID[];
00039 extern const uint8_t  MicroBitValueServicePeriodUUID[];
00040 
00041 
00042 /**
00043   * Class definition for the MicroBit BLE Value Service.
00044   * Provides access to live data via BLE, and provides basic configuration options.
00045   */
00046 class MicroBitValueService
00047 {
00048     public:
00049 
00050     /**
00051       * Constructor.
00052       * Create a representation of the MagnetometerService.
00053       * @param _ble The instance of a BLE device that we're running on.
00054       * @param _value An instance of MicroBitCompass to use as our Magnetometer source.
00055       */
00056     MicroBitValueService(BLEDevice &_ble, uint16_t *_value);
00057 
00058     private:
00059 
00060     /**
00061       * Callback. Invoked when any of our attributes are written via BLE.
00062       */
00063     void onDataWritten(const GattWriteCallbackParams *params);
00064 
00065     /**
00066      * Value update callback
00067      */
00068     void valueUpdate(MicroBitEvent e);
00069 
00070     // Bluetooth stack we're running on.
00071     BLEDevice           &ble;
00072     uint16_t            *value;
00073 
00074     // memory for our 8 bit control characteristics.
00075     uint16_t            valueCharacteristicBuffer;
00076 
00077     // Handles to access each characteristic when they are held by Soft Device.
00078     GattAttribute::Handle_t valueCharacteristicHandle;
00079 };
00080 
00081 #endif