summaryrefslogtreecommitdiff
path: root/peripheral/libupm/src/gas/tp401.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'peripheral/libupm/src/gas/tp401.hpp')
-rw-r--r--peripheral/libupm/src/gas/tp401.hpp89
1 files changed, 89 insertions, 0 deletions
diff --git a/peripheral/libupm/src/gas/tp401.hpp b/peripheral/libupm/src/gas/tp401.hpp
new file mode 100644
index 0000000..14b15c0
--- /dev/null
+++ b/peripheral/libupm/src/gas/tp401.hpp
@@ -0,0 +1,89 @@
+/*
+ * Author: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
+ * 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.
+ */
+#pragma once
+
+#include <iostream>
+#include <string>
+#include "gas.hpp"
+
+namespace upm {
+ /**
+ * @library gas
+ * @sensor tp401
+ * @comname Grove Air Quality Sensor
+ * @altname TP401 Gas Sensor
+ * @type gaseous
+ * @man seeed
+ * @con analog
+ * @kit hak
+ *
+ * @brief API for the Grove TP401 Air Quality Sensor
+ *
+ * The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors.
+ * It can detect CO and a wide range of other harmful gases, but, due to a limited detection
+ * range, it should be used only when qualitative results are needed. Example applications
+ * are air recirculation, ventilation systems, and refreshing sprayers.
+ * The sensor is linear and should be roughly sensitive to 0-20 ppm CO from 0-4 V.
+ * Note: the sensor requires 2-3 minutes to warm up initially and 48 hours of
+ * operation to stabilize completely.
+ *
+ * @image html tp401.jpeg
+ * @snippet tp401.cxx Interesting
+ */
+ class TP401 : public Gas {
+ public:
+ /**
+ * TP401 constructor
+ *
+ * @param gasPin Analog pin where the sensor is connected
+ */
+ TP401 (int gasPin);
+
+ /**
+ * TP401 destructor
+ */
+ ~TP401 ();
+
+ /**
+ * Returns the name of the sensor
+ *
+ * @return Name of the sensor
+ */
+ std::string name()
+ {
+ return m_name;
+ }
+
+ /**
+ * Returns one sample in parts per million (ppm) of CO in the air based on
+ * the following sensor calibration: 0-4 V is roughly 0-20 ppm CO
+ *
+ * @return New sample converted to ppm CO
+ */
+ float getPPM();
+
+ private:
+ std::string m_name;
+ };
+}