ims: Initial turnin of I2C Moisture Sensor

* Added C library * Added CXX library * Added C/CXX/java/js/python examples Signed-off-by: Noel Eck <noel.eck@intel.com>
2016-11-17 16:20:29 -08:00
parent a2698fd560
commit 971cb4ab51
18 changed files with 1106 additions and 1 deletions
--- a/src/ims/ims.hpp
+++ b/src/ims/ims.hpp
@@ -0,0 +1,148 @@
+/*
+ * Author: Noel Eck <noel.eck@intel.com>
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include "mraa/i2c.h"
+#include "ims.h"
+
+namespace upm {
+/**
+ * @brief Catnip Electronics I2C moisture sensor
+ * @defgroup ims libupm-ims
+ * @ingroup catnip i2c liquid light temp
+ */
+
+/**
+ * @library ims
+ * @sensor ims
+ * @comname Catnip Electronics I2C moisture sensor
+ * @type liquid light temp
+ * @man catnip
+ * @web https://www.tindie.com/products/miceuz/i2c-soil-moisture-sensor/
+ * @con i2c
+ *
+ * @brief API for the Catnip Electronics I2C moisture sensor
+ *
+ * I2C sensor which can be used to read:
+ *    moisture
+ *    light
+ *    temperature
+ *
+ *    This sensor must run at 100 kHz
+ *
+ * @image html ims.png
+ * @snippet ims.cxx Interesting
+ */
+
+class IMS {
+    public:
+        /**
+         * I2C Moisture Sensor constructor
+         *
+         * Initialize I2C Moisture Sensor
+         * @param i2c_bus Target I2C bus
+         * @param i2c_address Target I2C address (default is 0x20)
+         * @return sensor context pointer
+         * @throws std::runtime_error if sensor initializate fails
+         */
+        IMS(int16_t i2c_bus, int16_t i2c_address = IMS_ADDRESS_DEFAULT);
+
+        /**
+         * IMS destructor
+         */
+        virtual ~IMS() {};
+
+        /**
+         * Write I2C Moisture Sensor registers
+         * @param cmd Write command
+         * @param wr_data Target data to write (only used for IMS_SET_ADDRESS)
+         * @throws std::runtime_error if I2C write command fails
+         */
+        void write(IMS_WR_COMMAND cmd, uint8_t wr_data);
+
+        /**
+         * Read I2C Moisture Sensor registers
+         * @param cmd Read command
+         * @return Data returned from sensor (1 or 2 bytes depending on CMD)
+         * @throws std::runtime_error if I2C read command fails
+         */
+        uint16_t read(IMS_RD_COMMAND cmd);
+
+        /**
+         * Get sensor version
+         * @return Sensor version
+         * @throws std::runtime_error if I2C read command fails
+         */
+        uint16_t get_version();
+
+        /**
+         * Get moisture reading from sensor
+         * @return Unitless, relative capacitance value (moisture)
+         * @throws std::runtime_error if I2C read command fails
+         */
+        uint16_t get_moisture();
+
+        /**
+         * Get light reading from LED on device.  The technical data for the I2C
+         * moisture sensor specifies a 3 second wait.  Loop for 3 seconds
+         * checking the GET_BUSY register.  IF the sensor is NOT ready after 3
+         * seconds, assume there is NO light and return a max uint16_t (dark)
+         * value.
+         * @return rd_data Unitless, relative value for brightness
+         *        dark (0xFFFF) ---> light (0x0000)
+         * @throws std::runtime_error if I2C write/read command fails
+         */
+        uint16_t get_light();
+
+        /**
+         * Get temperature reading from device
+         * @return rd_data Temperature in degrees Celsius
+         * @throws std::runtime_error if I2C read command fails
+         */
+        float get_temperature();
+
+        /**
+         * Reset sensor
+         * @throws std::runtime_error if I2C write command fails
+         */
+        void reset();
+
+        /**
+         * Set I2C address AND reset sensor
+         * @param address_new New I2C for device
+         * @throws std::runtime_error if I2C write command fails
+         */
+        void reset_i2c_address(uint8_t address_new);
+
+        /**
+         * Put device into low-power mode.  Device wakes on any I2C command.
+         * @throws std::runtime_error if I2C write command fails
+         */
+        void sleep();
+    private:
+        /* device context struct */
+        ims_context* _dev;
+};
+}