tsl230.h

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

__BEGIN_C_DECLS
/* ========================================================================== */

/* constants ================================================================ */
typedef enum {
  eTsl230RangeOff   = 0,  
  eTsl230Range2000  = 1,  
  eTsl230Range200   = 2,  
  eTsl230Range20    = 3,  
} eTsl230Range;


typedef enum {
  eTsl230Off            = 0,  
  eTsl230Sensitivity1   = 1,  
  eTsl230Sensitivity10  = 2,  
  eTsl230Sensitivity100 = 3,  
} eTsl230Sensitivity;

typedef enum {
  
  eTsl230ScaleDiv1      = 0, 
  eTsl230ScaleDiv2      = 1, 
  eTsl230ScaleDiv10     = 2, 
  eTsl230ScaleDiv100    = 3, 
#ifndef __DOXYGEN__
  /* Obsolete */
  eTsl230Scale1   = eTsl230ScaleDiv100,
  eTsl230Scale10  = eTsl230ScaleDiv10,
  eTsl230Scale50  = eTsl230ScaleDiv2,
  eTsl230Scale100 = eTsl230ScaleDiv1,
#endif
} eTsl230Scale;

/* structures =============================================================== */

/* types ==================================================================== */

/* internal public functions ================================================ */
void vTsl230Init (void);

double dTsl230FreqToIrradiance (double dFreq);

void vTsl230SetRange (uint16_t usRange);

uint16_t usTsl230Range (void);

uint16_t usTsl230AutoRange (void);

double dTsl230ReadFreq (bool bAutoRange);

#if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */
inline double dTsl230ReadIrradiance (bool bAutoRange);

inline void vTsl230Enable (void);

inline void vTsl230Disable (void);

inline double dTsl230Freq (void);

inline double dTsl230Irradiance (void);

inline void vTsl230SetDarkFreq (double dDarkFreq);

inline double dTsl230GetDarkFreq (void);

inline void vTsl230SetResponsivity (double dResponsivity);

inline double dTsl230GetResponsivity (void);

inline void vTsl230Start (void);

inline bool bTsl230IsComplete (void);

inline void vTsl230WaitForComplete (void);

inline void vTsl230SetSensitivity (eTsl230Sensitivity eSensitivity);

inline eTsl230Sensitivity eTsl230GetSensitivity (void);

inline void vTsl230SetScale (eTsl230Scale eScale);

inline eTsl230Scale eTsl230GetScale (void);

inline void vTsl230SetWindow (uint16_t usWindowMs);

#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
#include "avrio-config.h"

#ifdef AVRIO_TSL230_ENABLE
// -----------------------------------------------------------------------------
#include "avrio-board-tsl230.h"

#if ! defined(AVRIO_TASK_ENABLE)
#error AVRIO_TASK_ENABLE should be defined for TSL230 module
#endif

#ifdef TSL230_INT
/*******************************************************************************
 * Version avec comptage interruption
 */
#include "icounter.h"

#if ! defined(AVRIO_IRQ_ENABLE) && defined(TSL230_INT)
#error AVRIO_IRQ_ENABLE should be defined for TSL230 module with icounter
#endif

/* structures =============================================================== */
typedef struct xTsl230Context {
  eTsl230Sensitivity eSensitivity;
  eTsl230Scale eScale;
  xICounter xCounter;
  double dDarkFreq;
  double dResponsivity;
} xTsl230Context;

/* public variables ========================================================= */
extern xTsl230Context xTsl230;

/* inline public functions ================================================== */

// -----------------------------------------------------------------------------
INLINE void
vTsl230Start (void) {

  vICounterStart (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE bool
bTsl230IsComplete (void) {

  return bICounterIsComplete (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE void
vTsl230WaitForComplete (void) {

  vICounterWaitForComplete (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE double
dTsl230Freq (void) {

  return dICounterFreq (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE 
void vTsl230SetWindow (uint16_t usWindowMs) {
  
  vICounterSetWindow (&xTsl230.xCounter, usWindowMs);
}

#else /* TSL230_INT not defined */
/*******************************************************************************
 * Version avec comptage d'événements (Timer en horloge externe généralement)
 */
#include "counter.h"

/* structures =============================================================== */
typedef struct xTsl230Context {
  eTsl230Sensitivity eSensitivity;
  eTsl230Scale eScale;
  xCounter xCounter;
  double dDarkFreq;
  double dResponsivity;
} xTsl230Context;

/* public variables ========================================================= */
extern xTsl230Context xTsl230;

/* inline public functions ================================================== */

// -----------------------------------------------------------------------------
INLINE void
vTsl230Start (void) {

  vCounterStart (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE bool
bTsl230IsComplete (void) {

  return bCounterIsComplete (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE void
vTsl230WaitForComplete (void) {

  vCounterWaitForComplete (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE double
dTsl230Freq (void) {

  return dCounterFreq (&xTsl230.xCounter);
}

// -----------------------------------------------------------------------------
INLINE 
void vTsl230SetWindow (uint16_t usWindowMs) {
  
  vCounterSetWindow (&xTsl230.xCounter, usWindowMs);
}

#endif /* TSL230_INT not defined */

/* inline public functions ================================================== */

// -----------------------------------------------------------------------------
INLINE double 
dTsl230ReadIrradiance (bool bAutoRange) {
  
  return dTsl230FreqToIrradiance (dTsl230ReadFreq (bAutoRange));
}

// -----------------------------------------------------------------------------
INLINE double
dTsl230Irradiance (void) {

  return dTsl230FreqToIrradiance (dTsl230Freq());
}

// -----------------------------------------------------------------------------
INLINE void
vTsl230SetSensitivity (eTsl230Sensitivity eSensitivity) {

  xTsl230.eSensitivity = eSensitivity;
  vTsl230PinSetSensitivity (eSensitivity);
}

// -----------------------------------------------------------------------------
INLINE eTsl230Sensitivity 
eTsl230GetSensitivity (void) {
  
  return xTsl230.eSensitivity;
}

// -----------------------------------------------------------------------------
INLINE void
vTsl230SetScale (eTsl230Scale eScale) {

  xTsl230.eScale = eScale;
  vTsl230PinSetScale (eScale);
}

// -----------------------------------------------------------------------------
INLINE eTsl230Scale 
eTsl230GetScale (void) {
  
  return xTsl230.eScale;
}

// -----------------------------------------------------------------------------
INLINE void 
vTsl230SetDarkFreq (double dDarkFreq) {
  xTsl230.dDarkFreq = dDarkFreq;
}

// -----------------------------------------------------------------------------
INLINE double 
dTsl230GetDarkFreq (void) {
  return xTsl230.dDarkFreq;
}

// -----------------------------------------------------------------------------
INLINE void 
vTsl230SetResponsivity (double dResponsivity) {
   xTsl230.dResponsivity = dResponsivity;
}

// -----------------------------------------------------------------------------
INLINE double 
dTsl230GetResponsivity (void) {
  
  return  xTsl230.dResponsivity;
}

#endif  /* AVRIO_TSL230_ENABLE defined */

#endif /* __DOXYGEN__ not defined */

/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_TSL230_H_ */