uRTCLib
https://github.com/Naguissa/uRTCLib
|
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... | |
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
uRTCLib::uRTCLib | ( | const int | rtc_address | ) |
Constructor.
rtc_address | I2C address of RTC |
uRTCLib::uRTCLib | ( | const int | rtc_address, |
const uint8_t | model | ||
) |
Constructor.
rtc_address | I2C address of RTC |
model | RTC model: |
bool uRTCLib::alarmClearFlag | ( | const uint8_t | alarm | ) |
Clears an alarm flag.
alarm | Alarm number: |
uint8_t uRTCLib::alarmDayDow | ( | const uint8_t | alarm | ) |
Returns actual alarm day or DOW.
alarm | Alarm number: |
bool uRTCLib::alarmDisable | ( | const uint8_t | alarm | ) |
Disables an alarm.
alarm | Alarm number: |
uint8_t uRTCLib::alarmHour | ( | const uint8_t | alarm | ) |
Returns actual alarm hour.
alarm | Alarm number: |
uint8_t uRTCLib::alarmMinute | ( | const uint8_t | alarm | ) |
Returns actual alarm minute.
alarm | Alarm number: |
uint8_t uRTCLib::alarmMode | ( | const uint8_t | alarm | ) |
Returns actual alarm mode.
See URTCLIB_ALARM_TYPE_X_YYYYY defines to see modes
alarm | Alarm number: |
uint8_t uRTCLib::alarmSecond | ( | const uint8_t | alarm | ) |
Returns actual alarm second.
alarm | Alarm number: |
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.
type | Alarm type:
|
second | second to set Alarm (ignored in Alarm 2) |
minute | minute to set Alarm |
hour | hour to set Alarm |
day_dow | Day of the month or DOW to set Alarm, depending on alarm type |
uint8_t uRTCLib::day | ( | ) |
Returns actual day.
uint8_t uRTCLib::dayOfWeek | ( | ) |
Returns actual Day Of Week.
uint8_t uRTCLib::hour | ( | ) |
Returns actual hour.
bool uRTCLib::lostPower | ( | ) |
Returns lost power VBAT staus.
WARNING: DS1307 is known to not have it at a known address
void uRTCLib::lostPowerClear | ( | ) |
Clears lost power VBAT staus.
WARNING: DS1307 is known to not have it at a known address
uint8_t uRTCLib::minute | ( | ) |
Returns actual minute.
uint8_t uRTCLib::model | ( | ) |
Gets RTC Model.
uint8_t uRTCLib::month | ( | ) |
Returns actual month.
byte uRTCLib::ramRead | ( | const uint8_t | address | ) |
Reads a byte from RTC RAM.
address | RAM Address |
bool uRTCLib::ramWrite | ( | const uint8_t | address, |
byte | data | ||
) |
Writes a byte to RTC RAM.
address | RAM Address |
data | Content to write on that position |
uint8_t uRTCLib::second | ( | ) |
Returns actual second.
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.
second | second to set to HW RTC |
minute | minute to set to HW RTC |
hour | hour to set to HW RTC |
dayOfWeek | day of week to set to HW RTC |
dayOfMonth | day of month to set to HW RTC |
month | month to set to HW RTC |
year | year to set to HW RTC |
void uRTCLib::set_model | ( | const uint8_t | model | ) |
Sets RTC Model.
model | RTC Model |
void uRTCLib::set_rtc_address | ( | const int | addr | ) |
Sets RTC i2 addres.
addr | RTC i2C address |
uint8_t uRTCLib::sqwgMode | ( | ) |
Gets current SQWG mode.
bool uRTCLib::sqwgSetMode | ( | const uint8_t | mode | ) |
Changes SQWG mode, including turning it off.
mode | SQWG mode: |
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
uint8_t uRTCLib::year | ( | ) |
Returns actual year.