Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/inc/bluetooth/MicroBitMagnetometerService.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_MAGNETOMETER_SERVICE_H
MrBedfordVan 0:b9164b348919 27 #define MICROBIT_MAGNETOMETER_SERVICE_H
MrBedfordVan 0:b9164b348919 28
MrBedfordVan 0:b9164b348919 29 #include "ble/BLE.h"
MrBedfordVan 0:b9164b348919 30 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 31 #include "MicroBitCompass.h"
MrBedfordVan 0:b9164b348919 32 #include "EventModel.h"
MrBedfordVan 0:b9164b348919 33
MrBedfordVan 0:b9164b348919 34 // UUIDs for our service and characteristics
MrBedfordVan 0:b9164b348919 35 extern const uint8_t MicroBitMagnetometerServiceUUID[];
MrBedfordVan 0:b9164b348919 36 extern const uint8_t MicroBitMagnetometerServiceDataUUID[];
MrBedfordVan 0:b9164b348919 37 extern const uint8_t MicroBitMagnetometerServiceBearingUUID[];
MrBedfordVan 0:b9164b348919 38 extern const uint8_t MicroBitMagnetometerServicePeriodUUID[];
MrBedfordVan 0:b9164b348919 39
MrBedfordVan 0:b9164b348919 40
MrBedfordVan 0:b9164b348919 41 /**
MrBedfordVan 0:b9164b348919 42 * Class definition for the MicroBit BLE Magnetometer Service.
MrBedfordVan 0:b9164b348919 43 * Provides access to live magnetometer data via BLE, and provides basic configuration options.
MrBedfordVan 0:b9164b348919 44 */
MrBedfordVan 0:b9164b348919 45 class MicroBitMagnetometerService
MrBedfordVan 0:b9164b348919 46 {
MrBedfordVan 0:b9164b348919 47 public:
MrBedfordVan 0:b9164b348919 48
MrBedfordVan 0:b9164b348919 49 /**
MrBedfordVan 0:b9164b348919 50 * Constructor.
MrBedfordVan 0:b9164b348919 51 * Create a representation of the MagnetometerService.
MrBedfordVan 0:b9164b348919 52 * @param _ble The instance of a BLE device that we're running on.
MrBedfordVan 0:b9164b348919 53 * @param _compass An instance of MicroBitCompass to use as our Magnetometer source.
MrBedfordVan 0:b9164b348919 54 */
MrBedfordVan 0:b9164b348919 55 MicroBitMagnetometerService(BLEDevice &_ble, MicroBitCompass &_compass);
MrBedfordVan 0:b9164b348919 56
MrBedfordVan 0:b9164b348919 57 private:
MrBedfordVan 0:b9164b348919 58
MrBedfordVan 0:b9164b348919 59 /**
MrBedfordVan 0:b9164b348919 60 * Callback. Invoked when any of our attributes are written via BLE.
MrBedfordVan 0:b9164b348919 61 */
MrBedfordVan 0:b9164b348919 62 void onDataWritten(const GattWriteCallbackParams *params);
MrBedfordVan 0:b9164b348919 63
MrBedfordVan 0:b9164b348919 64 /**
MrBedfordVan 0:b9164b348919 65 * Magnetometer update callback
MrBedfordVan 0:b9164b348919 66 */
MrBedfordVan 0:b9164b348919 67 void magnetometerUpdate(MicroBitEvent e);
MrBedfordVan 0:b9164b348919 68
MrBedfordVan 0:b9164b348919 69 /**
MrBedfordVan 0:b9164b348919 70 * Sample Period Change Needed callback.
MrBedfordVan 0:b9164b348919 71 * Reconfiguring the magnetometer can to a REALLY long time (sometimes even seconds to complete)
MrBedfordVan 0:b9164b348919 72 * So we do this in the background when necessary, through this event handler.
MrBedfordVan 0:b9164b348919 73 */
MrBedfordVan 0:b9164b348919 74 void samplePeriodUpdateNeeded(MicroBitEvent e);
MrBedfordVan 0:b9164b348919 75
MrBedfordVan 0:b9164b348919 76 // Bluetooth stack we're running on.
MrBedfordVan 0:b9164b348919 77 BLEDevice &ble;
MrBedfordVan 0:b9164b348919 78 MicroBitCompass &compass;
MrBedfordVan 0:b9164b348919 79
MrBedfordVan 0:b9164b348919 80 // memory for our 8 bit control characteristics.
MrBedfordVan 0:b9164b348919 81 int16_t magnetometerDataCharacteristicBuffer[3];
MrBedfordVan 0:b9164b348919 82 uint16_t magnetometerBearingCharacteristicBuffer;
MrBedfordVan 0:b9164b348919 83 uint16_t magnetometerPeriodCharacteristicBuffer;
MrBedfordVan 0:b9164b348919 84
MrBedfordVan 0:b9164b348919 85 // Handles to access each characteristic when they are held by Soft Device.
MrBedfordVan 0:b9164b348919 86 GattAttribute::Handle_t magnetometerDataCharacteristicHandle;
MrBedfordVan 0:b9164b348919 87 GattAttribute::Handle_t magnetometerBearingCharacteristicHandle;
MrBedfordVan 0:b9164b348919 88 GattAttribute::Handle_t magnetometerPeriodCharacteristicHandle;
MrBedfordVan 0:b9164b348919 89 };
MrBedfordVan 0:b9164b348919 90
MrBedfordVan 0:b9164b348919 91 #endif