Philip Holifield / microbit-dal

from bbc microbit library

Dependencies:   BLE_API mbed-dev-bin nRF51822

Dependents:   microbit

Fork of microbit-dal by Lancaster University

inc/bluetooth/MicroBitMagnetometerService.h@75:c700add33ba5, 2018-01-11 (annotated)

Committer:
euxton
Date:
Thu Jan 11 21:54:30 2018 +0000
Revision:
75:c700add33ba5
Parent:
1:8aa5cdb4ab67 
1st commit

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