adc_sensor.h

#ifndef _AVRIO_ADC_SENSOR_H_
#define _AVRIO_ADC_SENSOR_H_
#include <avrio/defs.h>

__BEGIN_C_DECLS
/* ========================================================================== */
#include <avrio/adc.h>
/* macros =================================================================== */
#define ADC_SENSOR_SETTING_LINEAR(_vmin,_vmax,_rmin,_rmax) { \
  .xLin.dValueMin=(_vmin), \
  .xLin.dValueMax=(_vmax), \
  .xLin.dRawMin=(_rmin), \
  .xLin.dRawMax=(_rmax) }

#define ADC_SENSOR_SETTING_NLINEAR(_coeff, _f) { \
  .xNlin.dRawToValue=(_f), \
  .xNlin.dCoeff = _coeff }

/* types ==================================================================== */
struct xAdcSensor;

typedef enum {

  ADC_SENSOR_LINEAR = 0,  
  ADC_SENSOR_NLINEAR = 1  
} eAdcSensorType;

typedef double (*dAdcSensorConvert) (struct xAdcSensor *, uint16_t);

/* structures =============================================================== */
typedef struct xAdcSensorLinearSetting {

  double dValueMin; 
  double dValueMax; 
  double dRawMin;   
  double dRawMax;   
} xAdcSensorLinearSetting;

typedef struct xAdcSensorNlinearSetting {

  double * dCoeff; 
  dAdcSensorConvert dRawToValue;   
} xAdcSensorNlinearSetting;

typedef union xAdcSensorSetting {

  xAdcSensorLinearSetting xLin;
  xAdcSensorNlinearSetting xNlin;
} xAdcSensorSetting;

typedef struct xAdcSensor {

  xAdcSensorSetting *pSetting;  
  uint8_t ucAdcChan;            
  uint8_t ucAdcScale;           
  uint8_t ucTerms;              
  eAdcSensorType eType;         
  eAdcFilter eFilter;           
} xAdcSensor;

/* internal public functions ================================================ */
uint16_t usAdcSensorGetRaw (xAdcSensor *pSensor);

double dAdcSensorRawToValue (xAdcSensor *pSensor, uint16_t usRaw);

#  if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */
void vAdcSensorInit (xAdcSensor *pSensor,  xAdcSensorSetting *pSetting,
                      eAdcSensorType eType,
                      uint8_t ucAdcChan, uint8_t ucTerms);

double dAdcSensorGetValue (xAdcSensor *pSensor);

#  else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
#include "avrio-board-adc-sensor.h"
/* internal inline functions ================================================ */

// -----------------------------------------------------------------------------
INLINE void
vAdcSensorInit (xAdcSensor *pSensor,  xAdcSensorSetting *pSetting,
                eAdcSensorType eType, uint8_t ucAdcChan, uint8_t ucTerms) {

  pSensor->pSetting = pSetting;
  pSensor->ucAdcChan = ucAdcChan;
  pSensor->eType = eType;
  pSensor->ucTerms = ucTerms;
  pSensor->eFilter = (ucTerms > 1 ? eAdcAverage : eAdcRaw);
}

// -----------------------------------------------------------------------------
INLINE double
dAdcSensorGetValue (xAdcSensor *pSensor) {

  return dAdcSensorRawToValue (pSensor, usAdcSensorGetRaw (pSensor));
}

#  endif /* __DOXYGEN__ not defined */


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