mq135.h

#ifndef _AVRIO_MQ135_H_
#define _AVRIO_MQ135_H_
#include <math.h>
#include <avrio/defs.h>
#include <avrio/adc_sensor.h>

__BEGIN_C_DECLS
/* ========================================================================== */
/* structures =============================================================== */
typedef struct xMq135Calibration {

  double dRLoad; 
  // -------- Paramètres statiques correspondants à l'étalonnage
  // Teneur CO² actualisée sur http://www.esrl.noaa.gov/gmd/ccgg/trends/global.html
  double dRZero; 
  double dAtmoCO2; 
  // -------- Paramètres dynamiques variants pendant le fonctionnement
  double dTemp; 
  double dHum; 
} xMq135Calibration;

/* internal public functions ================================================ */

double dMq135RawToResistance (xAdcSensor * pSensor, uint16_t usRaw);

double dMq135RawToPPM (xAdcSensor * pSensor, uint16_t usRaw);

double dMq135RawToCorrectedResistance (xAdcSensor * pSensor, uint16_t usRaw, double dTemp, double dHum);

double dMq135RawToCorrectedPPM (xAdcSensor * pSensor, uint16_t usRaw, double dTemp, double dHum);

double dMq135CalibrateRZero (xAdcSensor * pSensor);

double dMq135CorrectionFactor (double dTemp, double dHum);

#  if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */

/* macros =================================================================== */
#define MQ135_CALIBRATION(rload,rzero,atmoco2)

static inline void vMq135Init (xAdcSensorSetting *pSetting, xMq135Calibration * pCalibration);

static inline void vMq135SetTemp (xAdcSensor *pSensor, double dTemp);

static inline void vMq135SetHumidity (xAdcSensor *pSensor, double dHum);

static inline void vMq135SetCorrection (xAdcSensor *pSensor, double dTemp, double dHum);

static inline void dMq135Temp (xAdcSensor *pSensor);

static inline void dMq135Humidity (xAdcSensor *pSensor);

static inline void dMq135RZero (xAdcSensor *pSensor);

static inline void dMq135RLoad (xAdcSensor *pSensor);

static inline void dMq135AtmoCO2 (xAdcSensor *pSensor);

#  else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
/* internal inline functions ================================================ */

#define MQ135_CALIBRATION(_rload,_rzero,_atmoco2) { \
    .dRLoad=(_rload), .dRZero=(_rzero), .dAtmoCO2=(_atmoco2), \
    .dTemp=NAN, .dHum=NAN }

// -----------------------------------------------------------------------------
INLINE void
vMq135Init (xAdcSensorSetting *pSetting,
                      xMq135Calibration * pCalibration) {

  pSetting->xNlin.dRawToValue = dMq135RawToPPM;
  pSetting->xNlin.dCoeff = (double *) pCalibration;
}

// -----------------------------------------------------------------------------
INLINE void
vMq135SetTemp (xAdcSensor *pSensor, double dTemp) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  pCalibration->dTemp = dTemp;
}

// -----------------------------------------------------------------------------
INLINE void
vMq135SetCorrection (xAdcSensor *pSensor, double dTemp, double dHum) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  pCalibration->dTemp = dTemp;
  pCalibration->dHum = dHum;
}

// -----------------------------------------------------------------------------
INLINE double
dMq135Temp (xAdcSensor *pSensor) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  return pCalibration->dTemp;
}

// -----------------------------------------------------------------------------
INLINE void
vMq135SetHumidity (xAdcSensor *pSensor, double dHum) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  pCalibration->dHum = dHum;
}

// -----------------------------------------------------------------------------
INLINE double
dMq135Humidity (xAdcSensor *pSensor) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  return pCalibration->dHum;
}

// -----------------------------------------------------------------------------
INLINE double
dMq135RZero (xAdcSensor *pSensor) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  return pCalibration->dRZero;
}

// -----------------------------------------------------------------------------
INLINE double
dMq135RLoad (xAdcSensor *pSensor) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  return pCalibration->dRLoad;
}

// -----------------------------------------------------------------------------
INLINE double
dMq135AtmoCO2 (xAdcSensor *pSensor) {
  xMq135Calibration * pCalibration =
    (xMq135Calibration *) pSensor->pSetting->xNlin.dCoeff;
  return pCalibration->dAtmoCO2;
}
#  endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif  /* _AVRIO_MQ135_H_ not defined */