cpp_headers: Renamed C++ headers from .h -> .hpp
To make room for UPM C and C++ sensor code to coexist, all UPM
C++ headers have been renamed from h -> hpp. This commit contains
updates to documentation, includes, cmake collateral, examples, and
swig interface files.
* Renamed all cxx/cpp header files which contain the string
'copyright intel' from .h -> .hpp (if not already hpp).
* Replaced all references to .h with .hpp in documentation,
source files, cmake collateral, example code, and swig interface
files.
* Replaced cmake variable module_h with module_hpp.
* Intentionally left upm.h since this file currently does not
contain code (documentation only).
Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
74
src/gas/mq2.hpp
Normal file
74
src/gas/mq2.hpp
Normal file
@@ -0,0 +1,74 @@
|
||||
/*
|
||||
* Author: Brendan Le Foll <brendan.le.foll@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 mq2
|
||||
* @comname Grove MQ2 Gas Sensor
|
||||
* @type gaseous
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit hak
|
||||
*
|
||||
* @brief API for the Grove MQ2 Gas Sensor
|
||||
*
|
||||
* The Grove MQ2 Gas Sensor module is useful for gas leakage detection
|
||||
* (in home and industry). It can detect LPG, i-butane, methane, alcohol,
|
||||
* hydrogen, smoke, and other combustible gases. It's a medium-sensitivity
|
||||
* sensor with a detection range of 300-10,000 ppm.
|
||||
*
|
||||
* @image html mq2-5.jpeg
|
||||
* @snippet mq2.cxx Interesting
|
||||
*/
|
||||
class MQ2 : public Gas {
|
||||
public:
|
||||
/**
|
||||
* MQ2 constructor
|
||||
*
|
||||
* @param gasPin Analog pin where the sensor is connected
|
||||
*/
|
||||
MQ2 (int gasPin);
|
||||
|
||||
/**
|
||||
* MQ2 destructor
|
||||
*/
|
||||
~MQ2 ();
|
||||
|
||||
/**
|
||||
* Returns the name of the sensor
|
||||
*/
|
||||
std::string name()
|
||||
{
|
||||
return m_name;
|
||||
}
|
||||
private:
|
||||
std::string m_name;
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user