Home | History | Annotate | Download | only in ina132
      1 /*
      2  * Author: Zion Orent <zorent (at) ics.com>
      3  * Copyright (c) 2015 Intel Corporation.
      4  *
      5  * Permission is hereby granted, free of charge, to any person obtaining
      6  * a copy of this software and associated documentation files (the
      7  * "Software"), to deal in the Software without restriction, including
      8  * without limitation the rights to use, copy, modify, merge, publish,
      9  * distribute, sublicense, and/or sell copies of the Software, and to
     10  * permit persons to whom the Software is furnished to do so, subject to
     11  * the following conditions:
     12  *
     13  * The above copyright notice and this permission notice shall be
     14  * included in all copies or substantial portions of the Software.
     15  *
     16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     23  */
     24 #pragma once
     25 
     26 #include <string>
     27 #include <mraa/aio.h>
     28 
     29 namespace upm {
     30   /**
     31    * @brief INA132 Differential Amplifier Sensor library
     32    * @defgroup ina132 libupm-ina132
     33    * @ingroup seeed analog electric
     34    */
     35   /**
     36    * @library ina132
     37    * @sensor ina132
     38    * @comname Grove Differential Amplifier
     39    * @altname INA132
     40    * @type electric
     41    * @man seeed
     42    * @con analog
     43    *
     44    * @brief API for the INA132 Differential Amplifier Sensor
     45    *
     46    * The INA132 Differential Amplifier Sensor is designed
     47    * for precise differential-input amplification.
     48    *
     49    * This sensor was tested amplifying the signal
     50    * from a Weight Sensor (Load Cell) 0-500g
     51    *
     52    * @image html ina132.jpg
     53    * @snippet ina132.cxx Interesting
     54    */
     55   class INA132 {
     56   public:
     57     /**
     58      * INA132 constructor
     59      *
     60      * @param pin Analog pin to use
     61      */
     62     INA132(int pin);
     63     /**
     64      * INA132 destructor
     65      */
     66     ~INA132();
     67 
     68     /**
     69      * Measures precise differential-input amplification from the sensor
     70      *
     71      * @return Precise differential-input amplification
     72      */
     73     float value();
     74 
     75   private:
     76     mraa_aio_context m_aio;
     77   };
     78 }
     79 
     80 
     81