1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2014 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 Grove Moisture Sensor library
32    * @defgroup grovemoisture libupm-grovemoisture
33    * @ingroup seeed analog liquid eak hak
34    */
35 
36   /**
37    * @library grovemoisture
38    * @sensor grovemoisture
39    * @comname Grove Moisture Sensor
40    * @type liquid
41    * @man seeed
42    * @con analog
43    * @kit eak hak
44    *
45    * @brief API for the Grove Moisture Sensor
46    *
47    * UPM module for the Grove Moisture Sensor.
48    * This sensor can be used to detect the moisture content
49    * of soil or whether there is water around the sensor.
50    * As the moisture content increases, so does the value that is read.
51    * Note: this sensor is not designed to be left in soil
52    * nor to be used outdoors.
53    *
54    * @image html grovemoisture.jpg
55    * @snippet grovemoisture.cxx Interesting
56    */
57   class GroveMoisture {
58   public:
59     /**
60      * Grove analog moisture sensor constructor
61      *
62      * @param pin Analog pin to use
63      */
64     GroveMoisture(int pin);
65     /**
66      * GroveMoisture destructor
67      */
68     ~GroveMoisture();
69     /**
70      * Gets the moisture value from the sensor
71      *
72      * @return Moisture reading
73      */
74     int value();
75 
76   private:
77     mraa_aio_context m_aio;
78   };
79 }
80 
81 
82