nz_rtc.h

Go to the documentation of this file.

#ifndef NZ_RTC_H
#define NZ_RTC_H

#if defined(HAS_NZ_RTC)

#include "nz_tick.h"

#ifndef __INLINE_FUNCTION__
#define __INLINE_FUNCTION__ extern inline __attribute__((always_inline))
#endif

typedef struct __attribute__((__packed__)) {
    BYTE hour;  //The current time in Hours ( 0 to 23 )
    BYTE min;   //The current time in Minutes ( 0 to 59 )
    BYTE sec;   //The current time in seconds ( 0 to 59 )
    BYTE day;   //The current date, in day of the month ( 1 to 31 )
    BYTE month; //The current date, in month of the year ( 1 to 12 )
    BYTE year;  //The current date, in years since 2000. For example, is 14 for 2014
    BYTE wday;  //The current date, in day of week ( 0 to 6 where Sunday = 0)
} RTC_TIME_AND_DATE;

typedef struct __attribute__((__packed__)) {
    BYTE hour;  //The current time in Hours ( 0 to 23 )
    BYTE min;   //The current time in Minutes ( 0 to 59 )
    BYTE sec;   //The current time in seconds ( 0 to 59 )
} RTC_TIME;

typedef struct __attribute__((__packed__)) {
    BYTE day;   //The current date, in day of the month ( 1 to 31 )
    BYTE month; //The current date, in month of the year ( 1 to 12 )
    BYTE year;  //The current date, in years since 2000. For example, is 14 for 2014
    BYTE wday;  //The current date, in day of week ( 0 to 6 where Sunday = 0)
} RTC_DATE;




BYTE rtcInit(void);


BYTE rtcLock(void);


BYTE rtcUnlock(void);


BYTE nz_rtcGetRegBcd2Bin(BYTE reg);


BYTE nz_rtcSetRegBin2Bcd(BYTE reg, BYTE val);

BYTE rtcGetReg(BYTE regAdr, BYTE* reg);


BYTE rtcSetReg(BYTE regAdr, BYTE val);



// Get Time & Date Functions

BYTE __INLINE_FUNCTION__ rtcGetSec(void) {
    return nz_rtcGetRegBcd2Bin(0x0);  //Return second register = 0x00
}


BYTE __INLINE_FUNCTION__ rtcGetMin(void) {
    return nz_rtcGetRegBcd2Bin(0x01);  //Return min register = 0x01
}


BYTE rtcGetHour(void);


BYTE __INLINE_FUNCTION__ rtcGetDay(void)  {
    return nz_rtcGetRegBcd2Bin(0x03);  //Return hour register = 0x03
}


BYTE __INLINE_FUNCTION__ rtcGetMonth(void)  {
    return nz_rtcGetRegBcd2Bin(0x04);  //Return hour register = 0x04
}


WORD __INLINE_FUNCTION__ rtcGetYear(void) {
    return nz_rtcGetRegBcd2Bin(0x05);  //Return hour register = 0x05
}


WORD __INLINE_FUNCTION__ rtcGetWeekDay(void) {
    return nz_rtcGetRegBcd2Bin(0x06);  //Return hour register = 0x06
}


BYTE rtcGetTime(RTC_TIME* tm, BOOL bcdFormat);


BYTE rtcGetDate(RTC_DATE* dt, BOOL bcdFormat);


BYTE rtcGetTimeAndDate(RTC_TIME_AND_DATE* td, BOOL bcdFormat);


// Set Time & Date Functions

BYTE __INLINE_FUNCTION__ rtcSetSec(BYTE sec) {
    return nz_rtcSetRegBin2Bcd(0x0, sec);   //Set seconds register = address 0x0
}

BYTE __INLINE_FUNCTION__ rtcSetMin(BYTE min) {
    return nz_rtcSetRegBin2Bcd(0x01, min);  //Set minutes register = address 0x01
}


BYTE rtcSetHour(BYTE hour);


BYTE __INLINE_FUNCTION__ rtcSetDay(BYTE day) {
    return nz_rtcSetRegBin2Bcd(0x03, day);  //Set day register = address 0x03
}


BYTE __INLINE_FUNCTION__ rtcSetMonth(BYTE month) {
    return nz_rtcSetRegBin2Bcd(0x04, month);    //Set month register = address 0x04
}


BYTE __INLINE_FUNCTION__ rtcSetYear(WORD year) {
    return nz_rtcSetRegBin2Bcd(0x05, year);     //Set year register = address 0x05
}


BYTE __INLINE_FUNCTION__ rtcSetWeekDay(BYTE wday) {
    return nz_rtcSetRegBin2Bcd(0x06, wday);    //Set weekday register = address 0x06
}


BYTE rtcSetTime(RTC_TIME* tm);


BYTE rtcSetTimeAndDate(RTC_TIME_AND_DATE* td);


// Flag and Alarm Functions

BOOL rtcDidPowerFail();

BOOL rtcGetBatteryFlag();

void rtcClearBatteryFlag();

BOOL rtcGetAlarmFlag();

void rtcClearAlarmFlag();


// RAM Functions

BYTE __INLINE_FUNCTION__ rtcGetRAM1(void) {
    BYTE val;
    rtcGetReg(0x12, &val); //Get user ram 1 = address 0x12
    return val;
}

BYTE __INLINE_FUNCTION__ rtcGetRAM2(void) {
    BYTE val;
    rtcGetReg(0x13, &val); //Get user ram 2 = address 0x13
    return val;
}

BYTE __INLINE_FUNCTION__ rtcSetRAM1(BYTE val) {
    return rtcSetReg(0x12, val);   //Set user ram 1 = address 0x12
}


BYTE __INLINE_FUNCTION__ rtcSetRAM2(BYTE val) {
    return rtcSetReg(0x13, val);   //Set user ram 2 = address 0x13
}

#endif  //#if defined(HAS_NZ_RTC)
#endif  //#ifndef NZ_RTC_H