Diff: inc/drivers/MicroBitLightSensor.h

Revision:

1:8aa5cdb4ab67

Child:

3:d86a4ddc1867

diff -r fb15f7887843 -r 8aa5cdb4ab67 inc/drivers/MicroBitLightSensor.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/inc/drivers/MicroBitLightSensor.h	Thu Apr 07 01:33:22 2016 +0100
@@ -0,0 +1,137 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2016 British Broadcasting Corporation.
+This software is provided by Lancaster University by arrangement with the BBC.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+*/
+
+#ifndef MICROBIT_LIGHT_SENSOR_H
+#define MICROBIT_LIGHT_SENSOR_H
+
+#include "mbed.h"
+#include "MicroBitConfig.h"
+#include "MicroBitComponent.h"
+#include "EventModel.h"
+#include "MicroBitMatrixMaps.h"
+
+#define MICROBIT_LIGHT_SENSOR_CHAN_NUM      3
+#define MICROBIT_LIGHT_SENSOR_AN_SET_TIME   4000
+#define MICROBIT_LIGHT_SENSOR_TICK_PERIOD   5
+
+#define MICROBIT_LIGHT_SENSOR_MAX_VALUE     338
+#define MICROBIT_LIGHT_SENSOR_MIN_VALUE     75
+
+/**
+  * Class definition for MicroBitLightSensor.
+  *
+  * This is an object that interleaves light sensing with MicroBitDisplay.
+  */
+class MicroBitLightSensor
+{
+
+    //contains the results from each section of the display
+    int results[MICROBIT_LIGHT_SENSOR_CHAN_NUM] = { 0 };
+
+    //holds the current channel (also used to index the results array)
+    uint8_t chan;
+
+    //a Timeout which triggers our analogReady() call
+    Timeout analogTrigger;
+
+    //a pointer the currently sensed pin, represented as an AnalogIn
+    AnalogIn* sensePin;
+
+    const MatrixMap &matrixMap;
+
+    /**
+      * After the startSensing method has been called, this method will be called
+      * MICROBIT_LIGHT_SENSOR_AN_SET_TIME after.
+      *
+      * It will then read from the currently selected channel using the AnalogIn
+      * that was configured in the startSensing method.
+      */
+    void analogReady();
+
+    /**
+      * Forcibly disables the AnalogIn, otherwise it will remain in possession
+      * of the GPIO channel it is using, meaning that the display will not be
+      * able to use a channel (COL).
+      *
+      * This is required as per PAN 3, details of which can be found here:
+      *
+      * https://www.nordicsemi.com/eng/nordic/download_resource/24634/5/88440387
+      */
+    void analogDisable();
+
+    public:
+
+    /**
+      * Constructor.
+      *
+      * Create a representation of the light sensor.
+      *
+      * @param map The mapping information that relates pin inputs/outputs to physical screen coordinates.
+      *            Defaults to microbitMatrixMap, defined in MicroBitMatrixMaps.h.
+      */
+    MicroBitLightSensor(const MatrixMap &map);
+
+    /**
+      * This method returns a summed average of the three sections of the display.
+      *
+      * A section is defined as:
+      *  ___________________
+      * | 1 |   | 2 |   | 3 |
+      * |___|___|___|___|___|
+      * |   |   |   |   |   |
+      * |___|___|___|___|___|
+      * | 2 |   | 3 |   | 1 |
+      * |___|___|___|___|___|
+      * |   |   |   |   |   |
+      * |___|___|___|___|___|
+      * | 3 |   | 1 |   | 2 |
+      * |___|___|___|___|___|
+      *
+      * Where each number represents a different section on the 5 x 5 matrix display.
+      *
+      * @return returns a value in the range 0 - 255 where 0 is dark, and 255
+      * is very bright
+      */
+    int read();
+
+    /**
+      * The method that is invoked by sending MICROBIT_DISPLAY_EVT_LIGHT_SENSE
+      * using the id MICROBIT_ID_DISPLAY.
+      *
+      * @note this can be manually driven by calling this member function, with
+      *       a MicroBitEvent using the CREATE_ONLY option of the MicroBitEvent
+      *       constructor.
+      */
+    void startSensing(MicroBitEvent);
+
+    /**
+      * A destructor for MicroBitLightSensor.
+      *
+      * The destructor removes the listener, used by MicroBitLightSensor from the default EventModel.
+      */
+    ~MicroBitLightSensor();
+};
+
+#endif