summaryrefslogtreecommitdiff
path: root/peripheral/libupm/src/grove/grovelight.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'peripheral/libupm/src/grove/grovelight.hpp')
-rw-r--r--peripheral/libupm/src/grove/grovelight.hpp46
1 files changed, 46 insertions, 0 deletions
diff --git a/peripheral/libupm/src/grove/grovelight.hpp b/peripheral/libupm/src/grove/grovelight.hpp
new file mode 100644
index 0000000..b71d8ad
--- /dev/null
+++ b/peripheral/libupm/src/grove/grovelight.hpp
@@ -0,0 +1,46 @@
+/*
+ * Place-holder Header for Documentation and future API change
+ *
+ * Copyright (c) 2014 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.
+ */
+
+/**
+ * @library grove
+ * @sensor grovelight
+ * @comname Grove Light Sensor
+ * @type light
+ * @man seeed
+ * @con analog
+ * @kit gsk
+ *
+ * @brief API for the Grove Light Sensor
+ *
+ * The Grove light sensor detects the intensity of the ambient light.
+ * As the light intensity of the environment increases, the resistance
+ * of the sensor decreases. This means the raw value from the
+ * analog pin is larger in bright light and smaller in the dark.
+ * An approximate lux value can also be returned.
+ *
+ * @image html grovelight.jpg
+ * @snippet grovelight.cxx Interesting
+ */
+