upm  0.1.8
Sensor/Actuator repository for libmraa (v0.4.5)
 All Data Structures Files Functions Variables Macros Pages
gas.h
1 /*
2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3  * Copyright (c) 2014 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/gpio.h>
28 #include <mraa/aio.h>
29 
31  long averageReading;
32  long runningAverage;
33  int averagedOver;
34 };
35 
36 namespace upm {
37 
43 class Gas {
44  public:
50  Gas(int gasPin);
51 
55  ~Gas();
56 
65  virtual int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer);
66 
76  virtual int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len);
77 
83  virtual int getSampledData (thresholdContext* ctx);
84 
90  virtual int getSample (thresholdContext* ctx);
91 
98  virtual void printGraph (thresholdContext* ctx, uint8_t resolution);
99 
100  protected:
101  mraa_aio_context m_gasCtx;
102 };
103 
104 }
virtual int getSampledWindow(unsigned int freqMS, unsigned int numberOfSamples, uint16_t *buffer)
Definition: gas.cxx:49
virtual int findThreshold(thresholdContext *ctx, unsigned int threshold, uint16_t *buffer, unsigned int len)
Definition: gas.cxx:72
virtual void printGraph(thresholdContext *ctx, uint8_t resolution)
Definition: gas.cxx:100
Gas(int gasPin)
Definition: gas.cxx:34
Definition: gas.h:30
virtual int getSampledData(thresholdContext *ctx)
Definition: gas.cxx:90
C++ API for Gas sensors.
Definition: gas.h:43
~Gas()
Definition: gas.cxx:39
virtual int getSample(thresholdContext *ctx)
Definition: gas.cxx:95