src/gas/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
  30 struct thresholdContext {
  31     long averageReading;
  32     long runningAverage;
  33     int averagedOver;
  34 };
  35
  36 namespace upm {
  37
  38 /**
  39  * @brief C++ API for Gas sensors
  40  *
  41  * This file defines the Gas Analog sensors virtual functions
  42  */
  43 class Gas {
  44     public:
  45         /**
  46          * Instanciates a Gas object
  47          *
  48          * @param gasPin pin where gas is connected
  49          */
  50         Gas(int gasPin);
  51
  52         /**
  53          * Gas object destructor
  54          */
  55         ~Gas();
  56
  57         /**
  58          * Get samples from gas sensor according to provided window and
  59          * number of samples
  60          *
  61          * @param freqMS time between each sample (in microseconds)
  62          * @param numberOfSamples number of sample to sample for this window
  63          * @param buffer bufer with sampled data
  64          */
  65         virtual int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer);
  66
  67         /**
  68          * Given sampled buffer this method will return TRUE/FALSE if threshold
  69          * was reached
  70          *
  71          * @param ctx threshold context
  72          * @param threshold sample threshold
  73          * @param buffer buffer with samples
  74          * @param len bufer len
  75          */
  76         virtual int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len);
  77
  78         /**
  79          * Return avarage data for the sampled window
  80          *
  81          * @param ctx threshold context
  82          */
  83         virtual int getSampledData (thresholdContext* ctx);
  84
  85         /**
  86          * Return one sample from the sensor
  87          *
  88          * @param ctx threshold context
  89          */
  90         virtual int getSample (thresholdContext* ctx);
  91
  92         /**
  93          *
  94          * Print running average of threshold context
  95          *
  96          * @param ctx threshold context
  97          */
  98         virtual void printGraph (thresholdContext* ctx, uint8_t resolution);
  99
 100     protected:
 101         mraa_aio_context    m_gasCtx;
 102 };
 103
 104 }