Go to the source code of this file.
#define DS1337_I2C_MODULE_1 |
#define RTCC_ALARM_DISABLED 0b10000000 |
#define RTCC_ALARM_ENABLED 0b00000000 |
#define RTCC_CONTROL_REG_1_ADDR 0x0E |
#define RTCC_CONTROL_REG_2_ADDR 0x0F |
#define RTCC_DAYS_ADDR 0x04 |
#define RTCC_DAYS_ALARM_2_ADDR 0x0D |
#define RTCC_DAYS_ALARM_ADDR 0x0A |
#define RTCC_ENABLE_OFF 0b10000000 |
#define RTCC_ENABLE_ON 0b00000000 |
#define RTCC_HOURS_ADDR 0x02 |
#define RTCC_HOURS_ALARM_2_ADDR 0x0C |
#define RTCC_HOURS_ALARM_ADDR 0x09 |
#define RTCC_MAX_DAYS 0x32 |
#define RTCC_MAX_HOURS 0x24 |
#define RTCC_MAX_MINUTES 0x60 |
#define RTCC_MAX_MONTHS 0x13 |
#define RTCC_MAX_YEARS 0xA0 |
#define RTCC_MINUTES_ADDR 0x01 |
#define RTCC_MINUTS_ALARM_2_ADDR 0x0B |
#define RTCC_MINUTS_ALARM_ADDR 0x08 |
#define RTCC_MONTHS_ADDR 0x05 |
#define RTCC_SECONDS_ADDR 0x00 |
#define RTCC_SECONDS_ALARM_ADDR 0x07 |
#define RTCC_WRITE_ADD 0xD0 |
#define RTCC_YEARS_ADDR 0x06 |
unsigned char get_minutes_RTCC |
( |
void |
| ) |
|
This function reads the minutes from the RTC.
- Returns
- Minutes that are read back, in BCD format (eg. 22 min. is 0x22 or 0b00100010).
- Note
- Seconds are in BCD format.
signed char RTCC_disable_alarm_interrupt |
( |
void |
| ) |
|
This function disable the interrupt pin functionality.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
Definition at line 353 of file DS1337.c.
signed char RTCC_enable_alarm_interrupt |
( |
void |
| ) |
|
This function enables the interrupt pin functionality.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
Definition at line 340 of file DS1337.c.
unsigned char* RTCC_get_date |
( |
void |
| ) |
|
This function reads the Date from the RTC. The Format DD/MM/YY
- Returns
- Date that is read back, as ASCII string terminated with /0
Definition at line 258 of file DS1337.c.
unsigned char RTCC_get_days |
( |
void |
| ) |
|
This function reads the day from the RTC.
- Returns
- Days that are read back, in BCD format (eg. 12 is 0x12 or 0b00010010).
- Note
- Days are in BCD format.
Definition at line 200 of file DS1337.c.
unsigned char RTCC_get_hours |
( |
void |
| ) |
|
This function reads the hours from the RTC.
- Returns
- Hours that are read back, in BCD format (eg. 12 is 0x12 or 0b00010010).
- Note
- Hours are in BCD format.
Definition at line 116 of file DS1337.c.
unsigned char RTCC_get_months |
( |
void |
| ) |
|
This function reads the months from the RTC.
- Returns
- Months that are read back, in BCD format (eg. 12 is 0x12 or 0b00010010).
- Note
- Months are in BCD format.
Definition at line 224 of file DS1337.c.
unsigned char RTCC_get_seconds |
( |
void |
| ) |
|
This function reads the second from the RTC.
- Returns
- Second that are read back, in BCD format (eg. 22 sec. is 0x22 or 0b00100010).
- Note
- Seconds are in BCD format.
Definition at line 66 of file DS1337.c.
unsigned char* RTCC_get_time |
( |
void |
| ) |
|
This function reads the time from the RTC. The format is HH:MM (without seconds)
- Returns
- Time that is read back, as ASCII string terminated with /0
Definition at line 163 of file DS1337.c.
unsigned char* RTCC_get_time_seconds |
( |
void |
| ) |
|
This function reads the time from the RTC. The format is HH:MM.ss
- Returns
- Time that is read back, as ASCII string terminated with /0
Definition at line 130 of file DS1337.c.
unsigned char RTCC_get_years |
( |
void |
| ) |
|
This function reads the Year from the RTC.
- Returns
- Year that is read back, in BCD format (eg. 12 is 0x12 or 0b00010010 represents 2012).
- Note
- Year are in BCD format. 2012 is read as 0x12.
Definition at line 247 of file DS1337.c.
signed char RTCC_increment_days |
( |
void |
| ) |
|
This function increments the Days inside the RTCC.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Note
- The function automatically checks the overflow.
Definition at line 526 of file DS1337.c.
signed char RTCC_increment_hours |
( |
void |
| ) |
|
This function increments the hours inside the RTCC.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Note
- The function automatically checks the overflow.
Definition at line 422 of file DS1337.c.
signed char RTCC_increment_minutes |
( |
void |
| ) |
|
This function increments the minutes inside the RTCC.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Note
- The function automatically checks the overflow and automatically increments the hours.
Definition at line 387 of file DS1337.c.
signed char RTCC_increment_months |
( |
void |
| ) |
|
This function increments the Months inside the RTCC.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Note
- The function automatically checks the overflow.
Definition at line 492 of file DS1337.c.
signed char RTCC_increment_years |
( |
void |
| ) |
|
This function increments the Years inside the RTCC.
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Note
- The function automatically checks the overflow.
Definition at line 457 of file DS1337.c.
void RTCC_initialize |
( |
unsigned int |
baud_rate_KHz | ) |
|
This function initialize the I2C module accordingly to the clock and baud rate.
- Parameters
-
baud_rate_KHz | Baud rate expressed in KHz |
- Returns
- Note
- If other devices are connected on the I2C bus the baud rate would be changed by the function. Among several calls from different device initializations, only the last one will be reflected in the I2C module configuration.
Definition at line 46 of file DS1337.c.
unsigned char RTCC_is_alarm_ON |
( |
void |
| ) |
|
This function checks if the Alarm id ON using polling method.
- Returns
- status Alarm status 1: ON 0:OFF
- Note
- If the alarm is on, AF flag is automatically cleaned.
Definition at line 363 of file DS1337.c.
signed char RTCC_set_days |
( |
unsigned char |
days | ) |
|
This function writes the days in the RTC.
- Parameters
-
days | Day to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Days are in BCD format. Decimal format won't work!
Definition at line 191 of file DS1337.c.
signed char RTCC_set_days_alarm |
( |
unsigned char |
days, |
|
|
unsigned char |
alarm_enable |
|
) |
| |
This function writes the Days for the alarm, in the RTC.
- Parameters
-
days | Days to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
alarmEnable | Enable the alarm or not (for matching) [ENABLE_ON , ENABLE_OFF] |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Days are in BCD format. Decimal format won't work!
- Note
- Use the constants ENABLE_ON and ENABLE_OFF
Definition at line 328 of file DS1337.c.
signed char RTCC_set_hours |
( |
unsigned char |
hours | ) |
|
This function writes the hours in the RTC.
- Parameters
-
hours | Hours to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Hours are in BCD format. Decimal format won't work!
Definition at line 107 of file DS1337.c.
signed char RTCC_set_hours_alarm |
( |
unsigned char |
hours, |
|
|
unsigned char |
alarm_enable |
|
) |
| |
This function writes the hours for the alarm, in the RTC.
- Parameters
-
hours | Hours to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
alarmEnable | Enable the alarm or not (for matching) [ENABLE_ON , ENABLE_OFF] |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Hours are in BCD format. Decimal format won't work!
- Note
- Use the constants ENABLE_ON and ENABLE_OFF
Definition at line 317 of file DS1337.c.
signed char RTCC_set_minutes |
( |
unsigned char |
minutes | ) |
|
This function writes the seconds in the RTC.
- Parameters
-
minutes | Minutes to be written, as 2 digits BCD format (eg. 22 min. is 0x22 or 0b00100010). |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Minutes are in BCD format. Decimal format won't work!
Definition at line 83 of file DS1337.c.
signed char RTCC_set_minutes_alarm |
( |
unsigned char |
minutes, |
|
|
unsigned char |
alarm_enable |
|
) |
| |
This function writes the minutes for the alarm, in the RTC.
- Parameters
-
minutes | Minutes to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
alarmEnable | Enable the alarm or not (for matching) [ENABLE_ON , ENABLE_OFF] |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Minutes are in BCD format. Decimal format won't work!
- Note
- Use the constants ENABLE_ON and ENABLE_OFF
Definition at line 304 of file DS1337.c.
signed char RTCC_set_months |
( |
unsigned char |
months | ) |
|
This function writes the moths in the RTC.
- Parameters
-
months | Months to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Months are in BCD format. Decimal format won't work!
Definition at line 214 of file DS1337.c.
signed char RTCC_set_seconds |
( |
unsigned char |
seconds | ) |
|
This function writes the seconds in the RTC.
- Parameters
-
seconds | Seconds to be written, as 2 digits BCD format (eg. 22 sec. is 0x22 or 0b00100010). |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Seconds are in BCD format. Decimal format won't work!
Definition at line 56 of file DS1337.c.
signed char RTCC_set_seconds_alarm |
( |
unsigned char |
seconds, |
|
|
unsigned char |
alarm_enable |
|
) |
| |
This function writes the seconds for the alarm, in the RTC.
- Parameters
-
seconds | Seconds to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010). |
alarmEnable | Enable the alarm or not (for matching) [ENABLE_ON , ENABLE_OFF] |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Seconds are in BCD format. Decimal format won't work!
- Note
- Use the constants ENABLE_ON and ENABLE_OFF
Definition at line 292 of file DS1337.c.
References DS1337_I2C_write_byte_to_external_device, RTCC_SECONDS_ALARM_ADDR, and RTCC_WRITE_ADD.
signed char RTCC_set_years |
( |
unsigned char |
years | ) |
|
This function writes the Year in the RTC.
- Parameters
-
years | Year to be written, as 2 digits BCD format (eg. 2012 is only 0x12 or 0b00010010). |
- Returns
- status 0: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
- Warning
- Years are in BCD format. Decimal format won't work!
- Note
- 2012 is written as 12.
Definition at line 238 of file DS1337.c.