Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/inc/drivers/MicroBitCompassCalibrator.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_COMPASS_CALIBRATOR_H
MrBedfordVan 0:b9164b348919 27 #define MICROBIT_COMPASS_CALIBRATOR_H
MrBedfordVan 0:b9164b348919 28
MrBedfordVan 0:b9164b348919 29 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 30 #include "MicroBitCompass.h"
MrBedfordVan 0:b9164b348919 31 #include "MicroBitAccelerometer.h"
MrBedfordVan 0:b9164b348919 32 #include "MicroBitDisplay.h"
MrBedfordVan 0:b9164b348919 33
MrBedfordVan 0:b9164b348919 34
MrBedfordVan 0:b9164b348919 35 /**
MrBedfordVan 0:b9164b348919 36 * Class definition for an interactive compass calibration algorithm.
MrBedfordVan 0:b9164b348919 37 *
MrBedfordVan 0:b9164b348919 38 * The algorithm uses an accelerometer to ensure that a broad range of sample data has been gathered
MrBedfordVan 0:b9164b348919 39 * from the compass module, then performs a least mean squares optimisation of the
MrBedfordVan 0:b9164b348919 40 * results to determine the calibration data for the compass.
MrBedfordVan 0:b9164b348919 41 *
MrBedfordVan 0:b9164b348919 42 * The LED matrix display is used to provide feedback to the user on the gestures required.
MrBedfordVan 0:b9164b348919 43 *
MrBedfordVan 0:b9164b348919 44 * This class listens for calibration requests from the compass (on the default event model),
MrBedfordVan 0:b9164b348919 45 * and automatically initiates a calibration sequence as necessary.
MrBedfordVan 0:b9164b348919 46 */
MrBedfordVan 0:b9164b348919 47 class MicroBitCompassCalibrator
MrBedfordVan 0:b9164b348919 48 {
MrBedfordVan 0:b9164b348919 49 MicroBitCompass& compass;
MrBedfordVan 0:b9164b348919 50 MicroBitAccelerometer& accelerometer;
MrBedfordVan 0:b9164b348919 51 MicroBitDisplay& display;
MrBedfordVan 0:b9164b348919 52
MrBedfordVan 0:b9164b348919 53 public:
MrBedfordVan 0:b9164b348919 54
MrBedfordVan 0:b9164b348919 55 /**
MrBedfordVan 0:b9164b348919 56 * Constructor.
MrBedfordVan 0:b9164b348919 57 *
MrBedfordVan 0:b9164b348919 58 * Create an object capable of calibrating the compass.
MrBedfordVan 0:b9164b348919 59 *
MrBedfordVan 0:b9164b348919 60 * The algorithm uses an accelerometer to ensure that a broad range of sample data has been gathered
MrBedfordVan 0:b9164b348919 61 * from the compass module, then performs a least mean squares optimisation of the
MrBedfordVan 0:b9164b348919 62 * results to determine the calibration data for the compass.
MrBedfordVan 0:b9164b348919 63 *
MrBedfordVan 0:b9164b348919 64 * The LED matrix display is used to provide feedback to the user on the gestures required.
MrBedfordVan 0:b9164b348919 65 *
MrBedfordVan 0:b9164b348919 66 * @param compass The compass instance to calibrate.
MrBedfordVan 0:b9164b348919 67 *
MrBedfordVan 0:b9164b348919 68 * @param accelerometer The accelerometer to gather contextual data from.
MrBedfordVan 0:b9164b348919 69 *
MrBedfordVan 0:b9164b348919 70 * @param display The LED matrix to display user feedback on.
MrBedfordVan 0:b9164b348919 71 */
MrBedfordVan 0:b9164b348919 72 MicroBitCompassCalibrator(MicroBitCompass& _compass, MicroBitAccelerometer& _accelerometer, MicroBitDisplay& _display);
MrBedfordVan 0:b9164b348919 73
MrBedfordVan 0:b9164b348919 74 /**
MrBedfordVan 0:b9164b348919 75 * Performs a simple game that in parallel, calibrates the compass.
MrBedfordVan 0:b9164b348919 76 *
MrBedfordVan 0:b9164b348919 77 * This function is executed automatically when the user requests a compass bearing, and compass calibration is required.
MrBedfordVan 0:b9164b348919 78 *
MrBedfordVan 0:b9164b348919 79 * This function is, by design, synchronous and only returns once calibration is complete.
MrBedfordVan 0:b9164b348919 80 */
MrBedfordVan 0:b9164b348919 81 void calibrate(MicroBitEvent);
MrBedfordVan 0:b9164b348919 82 };
MrBedfordVan 0:b9164b348919 83
MrBedfordVan 0:b9164b348919 84 #endif