rtc.h

#ifndef _AVRIO_RTC_H_
#define _AVRIO_RTC_H_

#include <avrio/defs.h>
#include <avrio/mutex.h>
#include <stdio.h>

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

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

  MONDAY     =  2, 
  TUESDAY    =  3, 
  WEDNESDAY  = 4, 
  THURSDAY  = 5, 
  FRIDAY    = 6, 
  SATURDAY  = 7, 
  SUNDAY     = 1  
} eRtcWeekDay;

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

typedef struct xRtcTime {

  uint8_t ucSecond;   
  uint8_t ucMinute;   
  uint8_t ucHour;     
  uint8_t ucWeekDay;  
  uint8_t ucDate;     
  uint8_t ucMonth;    
  uint16_t usYear;    
} xRtcTime;

/* internal public functions ================================================ */
int iRtcInit (int iArg1);

int iRtcSetTime (const xRtcTime * pxTime);

int iRtcGetTime (xRtcTime * pxTime);

xMutex * pxRtcHeartBeatsMutex (void);

bool xRtcYearIsLeap (int usYear);

int iRtcSetAlm (int8_t index, const xRtcTime * pxTime);

int iRtcGetAlm (int8_t index, xRtcTime * pxTime);

xMutex * pxRtcAlmMutex (int8_t index);

const char *pcRtcWeekdayToStr (uint8_t wd);

int iRtcDateToStr (char * pcStr, const xRtcTime * pxDate);

int iRtcTimeToStr (char * pcStr, const xRtcTime * pxTime);

int iRtcPrintDateToStream (FILE * pxStream, const xRtcTime * pxDate);

int iRtcPrintTimeToStream (FILE * pxStream, const xRtcTime * pxTime);

/* macros =================================================================== */
#define iRtcPrintDate(d) iRtcPrintDateToStream(stdout, d)

#define iRtcPrintTime(t) iRtcPrintTimeToStream(stdout, t)

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

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