summaryrefslogtreecommitdiff
path: root/peripheral/libupm/src/apds9002/apds9002.h
diff options
context:
space:
mode:
Diffstat (limited to 'peripheral/libupm/src/apds9002/apds9002.h')
-rw-r--r--peripheral/libupm/src/apds9002/apds9002.h78
1 files changed, 78 insertions, 0 deletions
diff --git a/peripheral/libupm/src/apds9002/apds9002.h b/peripheral/libupm/src/apds9002/apds9002.h
new file mode 100644
index 0000000..0c3a3d5
--- /dev/null
+++ b/peripheral/libupm/src/apds9002/apds9002.h
@@ -0,0 +1,78 @@
+/*
+ * Author: Zion Orent <zorent@ics.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 <string>
+#include <mraa/aio.h>
+
+namespace upm {
+ /**
+ * @brief APDS-9002 Luminance Sensor library
+ * @defgroup apds9002 libupm-apds9002
+ * @ingroup seeed analog light
+ */
+
+ /**
+ * @library apds9002
+ * @sensor apds9002
+ * @comname APDS-9002 Luminance Sensor
+ * @altname Grove Luminance Sensor
+ * @type light
+ * @man seeed
+ * @con analog
+ *
+ * @brief UPM module for the APDS-9002 Luminance Sensor
+ *
+ * This sensor transforms luminous intensity to output analog values.
+ * It uses an APDS-9002 ambient light sensor.
+ *
+ * @image html apds9002.jpg
+ * @snippet apds9002.cxx Interesting
+ */
+
+ class APDS9002 {
+ public:
+ /**
+ * APDS-9002 luminance sensor constructor
+ *
+ * @param pin Analog pin to use
+ */
+ APDS9002(int pin);
+ /**
+ * APDS9002 destructor
+ */
+ ~APDS9002();
+ /**
+ * Gets the luminance value from the sensor
+ *
+ * @return Luminance value
+ */
+ int value();
+
+ private:
+ mraa_aio_context m_aio;
+ };
+}
+
+