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 APDS-9002 Luminance Sensor library
32    * @defgroup apds9002 libupm-apds9002
33    * @ingroup seeed analog light
34    */
35 
36   /**
37    * @library apds9002
38    * @sensor apds9002
39    * @comname APDS-9002 Luminance Sensor
40    * @altname Grove Luminance Sensor
41    * @type light
42    * @man seeed
43    * @con analog
44    *
45    * @brief UPM module for the APDS-9002 Luminance Sensor
46    *
47    * This sensor transforms luminous intensity to output analog values.
48    * It uses an APDS-9002 ambient light sensor.
49    *
50    * @image html apds9002.jpg
51    * @snippet apds9002.cxx Interesting
52    */
53 
54   class APDS9002 {
55   public:
56     /**
57      * APDS-9002 luminance sensor constructor
58      *
59      * @param pin Analog pin to use
60      */
61     APDS9002(int pin);
62     /**
63      * APDS9002 destructor
64      */
65     ~APDS9002();
66     /**
67      * Gets the luminance value from the sensor
68      *
69      * @return Luminance value
70      */
71     int value();
72 
73   private:
74     mraa_aio_context m_aio;
75   };
76 }
77 
78 
79