uRTCLib
https://github.com/Naguissa/uRTCLib
Public Member Functions | List of all members
uRTCLib Class Reference

DS1307, DS3231 and DS3232 RTCs basic library. More...

Public Member Functions

 uRTCLib ()
 Constructor.
 
 uRTCLib (const int)
 Constructor. More...
 
 uRTCLib (const int, const uint8_t)
 Constructor. More...
 
void refresh ()
 Refresh data from HW RTC.
 
uint8_t second ()
 Returns actual second. More...
 
uint8_t minute ()
 Returns actual minute. More...
 
uint8_t hour ()
 Returns actual hour. More...
 
uint8_t day ()
 Returns actual day. More...
 
uint8_t month ()
 Returns actual month. More...
 
uint8_t year ()
 Returns actual year. More...
 
uint8_t dayOfWeek ()
 Returns actual Day Of Week. More...
 
int16_t temp ()
 Returns actual temperature. More...
 
void set (const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t)
 Sets RTC datetime data. More...
 
void set_rtc_address (const int)
 Sets RTC i2 addres. More...
 
void set_model (const uint8_t)
 Sets RTC Model. More...
 
uint8_t model ()
 Gets RTC Model. More...
 
bool lostPower ()
 Returns lost power VBAT staus. More...
 
void lostPowerClear ()
 Clears lost power VBAT staus. More...
 
bool alarmSet (const uint8_t, const uint8_t, const uint8_t, const uint8_t, const uint8_t)
 Sets any alarm. More...
 
bool alarmDisable (const uint8_t)
 Disables an alarm. More...
 
bool alarmClearFlag (const uint8_t)
 Clears an alarm flag. More...
 
uint8_t alarmMode (const uint8_t)
 Returns actual alarm mode. More...
 
uint8_t alarmSecond (const uint8_t)
 Returns actual alarm second. More...
 
uint8_t alarmMinute (const uint8_t)
 Returns actual alarm minute. More...
 
uint8_t alarmHour (const uint8_t)
 Returns actual alarm hour. More...
 
uint8_t alarmDayDow (const uint8_t)
 Returns actual alarm day or DOW. More...
 
uint8_t sqwgMode ()
 Gets current SQWG mode. More...
 
bool sqwgSetMode (const uint8_t)
 Changes SQWG mode, including turning it off. More...
 
byte ramRead (const uint8_t)
 Reads a byte from RTC RAM. More...
 
bool ramWrite (const uint8_t, byte)
 Writes a byte to RTC RAM. More...
 

Detailed Description

DS1307, DS3231 and DS3232 RTCs basic library.

Really tiny library to basic RTC functionality on Arduino.

Supported features:

See uEEPROMLib for EEPROM support, https://github.com/Naguissa/uEEPROMLib

Constructor & Destructor Documentation

◆ uRTCLib() [1/2]

uRTCLib::uRTCLib ( const int  rtc_address)

Constructor.

Parameters
rtc_addressI2C address of RTC

◆ uRTCLib() [2/2]

uRTCLib::uRTCLib ( const int  rtc_address,
const uint8_t  model 
)

Constructor.

Parameters
rtc_addressI2C address of RTC
modelRTC model:

Member Function Documentation

◆ alarmClearFlag()

bool uRTCLib::alarmClearFlag ( const uint8_t  alarm)

Clears an alarm flag.

Parameters
alarmAlarm number:
Returns
false in case of not supported (DS1307) or wrong parameters

◆ alarmDayDow()

uint8_t uRTCLib::alarmDayDow ( const uint8_t  alarm)

Returns actual alarm day or DOW.

Parameters
alarmAlarm number:
Returns
Current stored day or dow. 0b11111111 means error.

◆ alarmDisable()

bool uRTCLib::alarmDisable ( const uint8_t  alarm)

Disables an alarm.

Parameters
alarmAlarm number:
Returns
false in case of not supported (DS1307) or wrong parameters

◆ alarmHour()

uint8_t uRTCLib::alarmHour ( const uint8_t  alarm)

Returns actual alarm hour.

Parameters
alarmAlarm number:
Returns
Current stored hour. 0b11111111 means error.

◆ alarmMinute()

uint8_t uRTCLib::alarmMinute ( const uint8_t  alarm)

Returns actual alarm minute.

Parameters
alarmAlarm number:
Returns
Current stored minute. 0b11111111 means error.

◆ alarmMode()

uint8_t uRTCLib::alarmMode ( const uint8_t  alarm)

◆ alarmSecond()

uint8_t uRTCLib::alarmSecond ( const uint8_t  alarm)

Returns actual alarm second.

Parameters
alarmAlarm number:
Returns
Current stored second. 0b11111111 means error.

◆ alarmSet()

bool uRTCLib::alarmSet ( const uint8_t  type,
const uint8_t  second,
const uint8_t  minute,
const uint8_t  hour,
const uint8_t  day_dow 
)

Sets any alarm.

This method can also be used to disable an alarm, but it's better to use alarmDisable(const uint8_t alarm) to do so.

Parameters
typeAlarm type:
secondsecond to set Alarm (ignored in Alarm 2)
minuteminute to set Alarm
hourhour to set Alarm
day_dowDay of the month or DOW to set Alarm, depending on alarm type
Returns
false in case of not supported (DS1307) or wrong parameters

◆ day()

uint8_t uRTCLib::day ( )

Returns actual day.

Returns
Current stored day

◆ dayOfWeek()

uint8_t uRTCLib::dayOfWeek ( )

Returns actual Day Of Week.

Returns
Current stored Day Of Week

◆ hour()

uint8_t uRTCLib::hour ( )

Returns actual hour.

Returns
Current stored hour

◆ lostPower()

bool uRTCLib::lostPower ( )

Returns lost power VBAT staus.

WARNING: DS1307 is known to not have it at a known address

Returns
True if power was lost (both power sources, VCC and VBAT)

◆ lostPowerClear()

void uRTCLib::lostPowerClear ( )

Clears lost power VBAT staus.

WARNING: DS1307 is known to not have it at a known address

◆ minute()

uint8_t uRTCLib::minute ( )

Returns actual minute.

Returns
Current stored minute

◆ model()

uint8_t uRTCLib::model ( )

◆ month()

uint8_t uRTCLib::month ( )

Returns actual month.

Returns
Current stored month

◆ ramRead()

byte uRTCLib::ramRead ( const uint8_t  address)

Reads a byte from RTC RAM.

Parameters
addressRAM Address
Returns
content of that position. If any error it will return always 0xFF;

◆ ramWrite()

bool uRTCLib::ramWrite ( const uint8_t  address,
byte  data 
)

Writes a byte to RTC RAM.

Parameters
addressRAM Address
dataContent to write on that position
Returns
true if correct

◆ second()

uint8_t uRTCLib::second ( )

Returns actual second.

Returns
Current stored second

◆ set()

void uRTCLib::set ( const uint8_t  second,
const uint8_t  minute,
const uint8_t  hour,
const uint8_t  dayOfWeek,
const uint8_t  dayOfMonth,
const uint8_t  month,
const uint8_t  year 
)

Sets RTC datetime data.

Parameters
secondsecond to set to HW RTC
minuteminute to set to HW RTC
hourhour to set to HW RTC
dayOfWeekday of week to set to HW RTC
dayOfMonthday of month to set to HW RTC
monthmonth to set to HW RTC
yearyear to set to HW RTC

◆ set_model()

void uRTCLib::set_model ( const uint8_t  model)

Sets RTC Model.

Parameters
modelRTC Model

◆ set_rtc_address()

void uRTCLib::set_rtc_address ( const int  addr)

Sets RTC i2 addres.

Parameters
addrRTC i2C address

◆ sqwgMode()

uint8_t uRTCLib::sqwgMode ( )

◆ sqwgSetMode()

bool uRTCLib::sqwgSetMode ( const uint8_t  mode)

Changes SQWG mode, including turning it off.

Parameters
modeSQWG mode:
Returns
false in case of not supported (DS1307) or wrong parameters

◆ temp()

int16_t uRTCLib::temp ( )

Returns actual temperature.

Temperature is returned as degress * 100; i.e.: 3050 is 30.50ยบ

WARNING: DS1307 has no temperature register, so it always returns URTCLIB_TEMP_ERROR

Returns
Current stored temperature

◆ year()

uint8_t uRTCLib::year ( )

Returns actual year.

Returns
Current stored year

The documentation for this class was generated from the following files: