Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/inc/drivers/MicroBitLightSensor.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_LIGHT_SENSOR_H
MrBedfordVan 0:b9164b348919 27 #define MICROBIT_LIGHT_SENSOR_H
MrBedfordVan 0:b9164b348919 28
MrBedfordVan 0:b9164b348919 29 #include "mbed.h"
MrBedfordVan 0:b9164b348919 30 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 31 #include "MicroBitComponent.h"
MrBedfordVan 0:b9164b348919 32 #include "EventModel.h"
MrBedfordVan 0:b9164b348919 33 #include "MicroBitMatrixMaps.h"
MrBedfordVan 0:b9164b348919 34
MrBedfordVan 0:b9164b348919 35 #define MICROBIT_LIGHT_SENSOR_CHAN_NUM 3
MrBedfordVan 0:b9164b348919 36 #define MICROBIT_LIGHT_SENSOR_AN_SET_TIME 4000
MrBedfordVan 0:b9164b348919 37 #define MICROBIT_LIGHT_SENSOR_TICK_PERIOD 5
MrBedfordVan 0:b9164b348919 38
MrBedfordVan 0:b9164b348919 39 #define MICROBIT_LIGHT_SENSOR_MAX_VALUE 338
MrBedfordVan 0:b9164b348919 40 #define MICROBIT_LIGHT_SENSOR_MIN_VALUE 75
MrBedfordVan 0:b9164b348919 41
MrBedfordVan 0:b9164b348919 42 /**
MrBedfordVan 0:b9164b348919 43 * Class definition for MicroBitLightSensor.
MrBedfordVan 0:b9164b348919 44 *
MrBedfordVan 0:b9164b348919 45 * This is an object that interleaves light sensing with MicroBitDisplay.
MrBedfordVan 0:b9164b348919 46 */
MrBedfordVan 0:b9164b348919 47 class MicroBitLightSensor
MrBedfordVan 0:b9164b348919 48 {
MrBedfordVan 0:b9164b348919 49
MrBedfordVan 0:b9164b348919 50 //contains the results from each section of the display
MrBedfordVan 0:b9164b348919 51 int results[MICROBIT_LIGHT_SENSOR_CHAN_NUM];
MrBedfordVan 0:b9164b348919 52
MrBedfordVan 0:b9164b348919 53 //holds the current channel (also used to index the results array)
MrBedfordVan 0:b9164b348919 54 uint8_t chan;
MrBedfordVan 0:b9164b348919 55
MrBedfordVan 0:b9164b348919 56 //a Timeout which triggers our analogReady() call
MrBedfordVan 0:b9164b348919 57 Timeout analogTrigger;
MrBedfordVan 0:b9164b348919 58
MrBedfordVan 0:b9164b348919 59 //a pointer the currently sensed pin, represented as an AnalogIn
MrBedfordVan 0:b9164b348919 60 AnalogIn* sensePin;
MrBedfordVan 0:b9164b348919 61
MrBedfordVan 0:b9164b348919 62 const MatrixMap &matrixMap;
MrBedfordVan 0:b9164b348919 63
MrBedfordVan 0:b9164b348919 64 /**
MrBedfordVan 0:b9164b348919 65 * After the startSensing method has been called, this method will be called
MrBedfordVan 0:b9164b348919 66 * MICROBIT_LIGHT_SENSOR_AN_SET_TIME after.
MrBedfordVan 0:b9164b348919 67 *
MrBedfordVan 0:b9164b348919 68 * It will then read from the currently selected channel using the AnalogIn
MrBedfordVan 0:b9164b348919 69 * that was configured in the startSensing method.
MrBedfordVan 0:b9164b348919 70 */
MrBedfordVan 0:b9164b348919 71 void analogReady();
MrBedfordVan 0:b9164b348919 72
MrBedfordVan 0:b9164b348919 73 /**
MrBedfordVan 0:b9164b348919 74 * Forcibly disables the AnalogIn, otherwise it will remain in possession
MrBedfordVan 0:b9164b348919 75 * of the GPIO channel it is using, meaning that the display will not be
MrBedfordVan 0:b9164b348919 76 * able to use a channel (COL).
MrBedfordVan 0:b9164b348919 77 *
MrBedfordVan 0:b9164b348919 78 * This is required as per PAN 3, details of which can be found here:
MrBedfordVan 0:b9164b348919 79 *
MrBedfordVan 0:b9164b348919 80 * https://www.nordicsemi.com/eng/nordic/download_resource/24634/5/88440387
MrBedfordVan 0:b9164b348919 81 */
MrBedfordVan 0:b9164b348919 82 void analogDisable();
MrBedfordVan 0:b9164b348919 83
MrBedfordVan 0:b9164b348919 84 public:
MrBedfordVan 0:b9164b348919 85
MrBedfordVan 0:b9164b348919 86 /**
MrBedfordVan 0:b9164b348919 87 * Constructor.
MrBedfordVan 0:b9164b348919 88 *
MrBedfordVan 0:b9164b348919 89 * Create a representation of the light sensor.
MrBedfordVan 0:b9164b348919 90 *
MrBedfordVan 0:b9164b348919 91 * @param map The mapping information that relates pin inputs/outputs to physical screen coordinates.
MrBedfordVan 0:b9164b348919 92 * Defaults to microbitMatrixMap, defined in MicroBitMatrixMaps.h.
MrBedfordVan 0:b9164b348919 93 */
MrBedfordVan 0:b9164b348919 94 MicroBitLightSensor(const MatrixMap &map);
MrBedfordVan 0:b9164b348919 95
MrBedfordVan 0:b9164b348919 96 /**
MrBedfordVan 0:b9164b348919 97 * This method returns a summed average of the three sections of the display.
MrBedfordVan 0:b9164b348919 98 *
MrBedfordVan 0:b9164b348919 99 * A section is defined as:
MrBedfordVan 0:b9164b348919 100 * ___________________
MrBedfordVan 0:b9164b348919 101 * | 1 | | 2 | | 3 |
MrBedfordVan 0:b9164b348919 102 * |___|___|___|___|___|
MrBedfordVan 0:b9164b348919 103 * | | | | | |
MrBedfordVan 0:b9164b348919 104 * |___|___|___|___|___|
MrBedfordVan 0:b9164b348919 105 * | 2 | | 3 | | 1 |
MrBedfordVan 0:b9164b348919 106 * |___|___|___|___|___|
MrBedfordVan 0:b9164b348919 107 * | | | | | |
MrBedfordVan 0:b9164b348919 108 * |___|___|___|___|___|
MrBedfordVan 0:b9164b348919 109 * | 3 | | 1 | | 2 |
MrBedfordVan 0:b9164b348919 110 * |___|___|___|___|___|
MrBedfordVan 0:b9164b348919 111 *
MrBedfordVan 0:b9164b348919 112 * Where each number represents a different section on the 5 x 5 matrix display.
MrBedfordVan 0:b9164b348919 113 *
MrBedfordVan 0:b9164b348919 114 * @return returns a value in the range 0 - 255 where 0 is dark, and 255
MrBedfordVan 0:b9164b348919 115 * is very bright
MrBedfordVan 0:b9164b348919 116 */
MrBedfordVan 0:b9164b348919 117 int read();
MrBedfordVan 0:b9164b348919 118
MrBedfordVan 0:b9164b348919 119 /**
MrBedfordVan 0:b9164b348919 120 * The method that is invoked by sending MICROBIT_DISPLAY_EVT_LIGHT_SENSE
MrBedfordVan 0:b9164b348919 121 * using the id MICROBIT_ID_DISPLAY.
MrBedfordVan 0:b9164b348919 122 *
MrBedfordVan 0:b9164b348919 123 * @note this can be manually driven by calling this member function, with
MrBedfordVan 0:b9164b348919 124 * a MicroBitEvent using the CREATE_ONLY option of the MicroBitEvent
MrBedfordVan 0:b9164b348919 125 * constructor.
MrBedfordVan 0:b9164b348919 126 */
MrBedfordVan 0:b9164b348919 127 void startSensing(MicroBitEvent);
MrBedfordVan 0:b9164b348919 128
MrBedfordVan 0:b9164b348919 129 /**
MrBedfordVan 0:b9164b348919 130 * A destructor for MicroBitLightSensor.
MrBedfordVan 0:b9164b348919 131 *
MrBedfordVan 0:b9164b348919 132 * The destructor removes the listener, used by MicroBitLightSensor from the default EventModel.
MrBedfordVan 0:b9164b348919 133 */
MrBedfordVan 0:b9164b348919 134 ~MicroBitLightSensor();
MrBedfordVan 0:b9164b348919 135 };
MrBedfordVan 0:b9164b348919 136
MrBedfordVan 0:b9164b348919 137 #endif