Diff: SensorNode.hpp

Revision:

0:33d4e66780c0

Child:

13:6a6225690c2e

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SensorNode.hpp	Fri Feb 24 11:23:12 2017 -0600
@@ -0,0 +1,101 @@
+/*******************************************************************************
+* Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* 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 MAXIM INTEGRATED 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.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************/
+
+#ifndef SENSORNODE_HPP
+#define SENSORNODE_HPP
+
+#include <stdint.h>
+#include <Callback.h>
+#include "DS28C36.hpp"
+
+namespace mbed { class I2C; }
+class DS2476;
+
+/// Interface to the authenticated sensor node peripheral board.
+class SensorNode
+{
+public:
+    /// Prints a null-terminated char string.
+    typedef mbed::Callback<void(const char *)> PrintHandler;
+
+    /// Style of temperature to measure.
+    enum TempStyle
+    {
+        AmbientTemp,
+        ObjectTemp
+    };
+    
+    /// @param i2c I2C bus connected to the sensor node. Communicates with DS28C36 and MLX90614.
+    /// @param ds2476 Coprocessor used for authentication computations.
+    SensorNode(mbed::I2C & i2c, DS2476 & ds2476);
+    
+    /// Detects if a potential sensor node is connected.
+    /// @returns True if something was detected.
+    bool detect();
+    
+    /// Checks if the sensor node is authentic.
+    /// @returns True if the sensor node passed the authentication check.
+    bool authenticate();
+    
+    /// Checks if the laser is enabled.
+    /// @param[out] enabled Set to true if the laser is enabled. Only valid if check successful.
+    /// @returns True if check was successful.
+    bool getLaserEnabled(bool & enabled);
+    
+    /// Enable or disable the laser.
+    /// @param enabled True to enable the laser or false to disable.
+    /// @param print Optional callback for displaying informational messages to the user.
+    /// @returns True if the operation was successful.
+    bool setLaserEnabled(bool enabled, const PrintHandler & print = PrintHandler());
+    
+    /// Get a temperature measurement from the MLX90614.
+    /// @param style Temperature style to read.
+    /// @param[out] temp Temperature in Celsius. Only valid if operation successful.
+    /// @returns True if the operation was successful.
+    bool readTemp(TempStyle style, double & temp);
+    
+    /// Checks if the sensor node is provisioned.
+    /// @param[out] provisioned True if provisioned. Only valid if check successful.
+    /// @returns True if the check was successful.
+    bool getProvisioned(bool & provisioned);
+    
+    /// Provision the sensor node.
+    /// @returns True if the operation was successful.
+    bool provision();
+    
+private:
+    mbed::I2C & i2c;
+    DS28C36 ds28c36;
+    DS2476 & ds2476;
+};
+
+#endif