encoder.h

#ifndef _AVRIO_ENCODER_H_
#  define _AVRIO_ENCODER_H_

#  include <avrio/defs.h>

__BEGIN_C_DECLS
  /* ======================================================================== */
  /* constants ============================================================== */
   typedef enum {

  ENCODER_STOP = 0, 
  ENCODER_CW = 1,   
  ENCODER_CCW = -1  
} eEncoderDir;

/* types ==================================================================== */
typedef int32_t xEncoderCounter;

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

xEncoderCounter xEncoderCount (uint8_t ucEncoder);

int16_t xEncoderSpeed (uint8_t ucEncoder);

eEncoderDir eEncoderDirection (uint8_t ucEncoder);

void vEncoderReset (uint8_t ucEncoder);

void vEncoderEnable (uint8_t ucEncoder, bool xEnable);

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

#  else
/* 
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
void vEncoderTask (uint8_t ucEncoder);

#  endif /* __DOXYGEN__ not defined */
/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_ENCODER_H_ */