1 /*
2  * Author: Zion Orent <zorent@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 Grove O2 Oxygen Gas Sensor library
32    * @defgroup groveo2 libupm-groveo2
33    * @ingroup seeed analog gaseous
34    */
35 
36   /**
37    * @library groveo2
38    * @sensor groveo2
39    * @comname Grove O2 Sensor
40    * @type gaseous
41    * @man seeed
42    * @con analog
43    *
44    * @brief API for the Grove O2 Oxygen Gas Sensor
45    *
46    * The Grove O2 Oxygen Gas sensor measures the oxygen concentration in the air
47    *
48    * @image html groveo2.jpg
49    * @snippet groveo2.cxx Interesting
50    */
51   class GroveO2 {
52   public:
53     /**
54      * Grove O2 Oxygen Gas sensor constructor
55      *
56      * @param pin Analog pin to use
57      */
58     GroveO2(int pin);
59     /**
60      * GroveO2 destructor
61      */
62     ~GroveO2();
63     /**
64      * Measures O2 from the sensor
65      *
66      * @return Oxygen concentration as voltage
67      */
68     float voltageValue();
69 
70   private:
71     mraa_aio_context m_aio;
72   };
73 }
74