C18 LaurTec Library  2.5
Open Source C Library for PIC18 Microcontrollers
LaurTec_c18_libraries_v_2.5/src/PCF8563.c File Reference
#include "PCF8563.h"

Go to the source code of this file.

Functions

signed char set_seconds_RTCC (unsigned char seconds)
unsigned char get_seconds_RTCC (void)
signed char set_minutes_RTCC (unsigned char minutes)
unsigned char get_minutes_RTCC (void)
signed char set_hours_RTCC (unsigned char hours)
unsigned char get_hours_RTCC (void)
unsigned char * get_time_seconds_RTCC (void)
unsigned char * get_time_RTCC (void)
signed char set_days_RTCC (unsigned char days)
unsigned char get_days_RTCC (void)
signed char set_day_of_the_week_RTCC (unsigned char day_of_the_week)
unsigned char get_week_days_RTCC (void)
signed char set_months_RTCC (unsigned char months)
unsigned char get_months_RTCC (void)
signed char set_years_RTCC (unsigned char years)
unsigned char get_years_RTCC (void)
unsigned char * get_date_RTCC (void)
signed char set_minutes_alarm_RTCC (unsigned char minutes, unsigned char alarm_enable)
signed char set_hours_alarm_RTCC (unsigned char hours, unsigned char alarm_enable)
signed char set_days_alarm_RTCC (unsigned char days, unsigned char alarm_enable)
signed char set_day_of_the_week_alarm_RTCC (unsigned char day_of_the_week_alarm, unsigned char alarm_enable)
signed char enable_alarm_interrupt_RTCC (void)
signed char disable_alarm_interrupt_RTCC (void)
unsigned char is_alarm_ON_RTCC (void)
signed char increment_minutes_RTCC (void)
signed char increment_hours_RTCC (void)
signed char increment_years_RTCC (void)
signed char increment_months_RTCC (void)
signed char increment_days_RTCC (void)

Function Documentation

signed char disable_alarm_interrupt_RTCC ( void  )

This function disable the interrupt pin funtionality.

Returns:
status 1: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision

Definition at line 370 of file PCF8563.c.

References CONTROL_REG_2_ADDR, and WRITE_ADD.

signed char enable_alarm_interrupt_RTCC ( void  )

This function enables the interrupt pin funtionality.

Returns:
status 1: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision

Definition at line 360 of file PCF8563.c.

References CONTROL_REG_2_ADDR, and WRITE_ADD.

unsigned char* get_date_RTCC ( void  )

This function reads the Date from the RTC. The Format DD/MM/YY

Returns:
Date that is read back, as ASCII string termianted with /0

Definition at line 278 of file PCF8563.c.

References get_days_RTCC(), get_months_RTCC(), and get_years_RTCC().

unsigned char get_days_RTCC ( 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 197 of file PCF8563.c.

References DAYS_ADDR, and WRITE_ADD.

unsigned char get_hours_RTCC ( 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 113 of file PCF8563.c.

References HOURS_ADDR, and WRITE_ADD.

unsigned char get_minutes_RTCC ( void  )

This function reads the muntes 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.

Definition at line 90 of file PCF8563.c.

References MINUTES_ADDR, and WRITE_ADD.

unsigned char get_months_RTCC ( 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 244 of file PCF8563.c.

References MONTHS_ADDR, and WRITE_ADD.

unsigned char get_seconds_RTCC ( 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 63 of file PCF8563.c.

References SECONDS_ADDR, and WRITE_ADD.

unsigned char* get_time_RTCC ( 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 termianted with /0

Definition at line 160 of file PCF8563.c.

References get_hours_RTCC(), and get_minutes_RTCC().

unsigned char* get_time_seconds_RTCC ( void  )

This function reads the time from the RTC. The format is HH:MM.ss

Returns:
Time that is read back, as ASCII string termianted with /0

Definition at line 127 of file PCF8563.c.

References get_hours_RTCC(), get_minutes_RTCC(), and get_seconds_RTCC().

unsigned char get_week_days_RTCC ( void  )

Definition at line 220 of file PCF8563.c.

References DAY_WEEK_ADDR, and WRITE_ADD.

unsigned char get_years_RTCC ( 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 267 of file PCF8563.c.

References WRITE_ADD, and YEARS_ADDR.

signed char increment_days_RTCC ( void  )

This function increments the Days inside the RTCC.

Returns:
status 1: 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 543 of file PCF8563.c.

References get_days_RTCC(), MAX_DAYS, and set_days_RTCC().

signed char increment_hours_RTCC ( void  )

This function increments the hours inside the RTCC.

Returns:
status 1: 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 439 of file PCF8563.c.

References get_hours_RTCC(), MAX_HOURS, and set_hours_RTCC().

signed char increment_minutes_RTCC ( void  )

This function increments the minutes inside the RTCC.

Returns:
status 1: 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 incremetns the hours.

Definition at line 404 of file PCF8563.c.

References get_minutes_RTCC(), MAX_MINUTES, and set_minutes_RTCC().

signed char increment_months_RTCC ( void  )

This function increments the Months inside the RTCC.

Returns:
status 1: 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 509 of file PCF8563.c.

References get_months_RTCC(), MAX_MONTHS, and set_months_RTCC().

signed char increment_years_RTCC ( void  )

This function increments the Years inside the RTCC.

Returns:
status 1: 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 474 of file PCF8563.c.

References get_years_RTCC(), MAX_YEARS, and set_years_RTCC().

unsigned char is_alarm_ON_RTCC ( 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 380 of file PCF8563.c.

References CONTROL_REG_2_ADDR, and WRITE_ADD.

signed char set_day_of_the_week_alarm_RTCC ( unsigned char  day_of_the_week,
unsigned char  alarm_enable 
)

This function writes the WeekDays for the alarm, in the RTC.

Parameters:
day_of_the_weekDays of the week to be written.
alarmEnableEnable the alarm or not (for matching) [Enable_ON , Enable_OFF]
Returns:
status 1: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
Note:
Use the constants to set the Day of the week (either Italian or English). [DO, LU, MA, ME, GI, VE, SA] or [SU, MO, TU, WE, TR, FR, SA]
Use the constants Enable_ON and Enable_OFF

Definition at line 348 of file PCF8563.c.

References DAY_WEEK_ALARM_ADDR, and WRITE_ADD.

signed char set_day_of_the_week_RTCC ( unsigned char  day_of_the_week)

This function writes the WeekDay in the RTC.

Parameters:
day_of_the_weekDay of the week to be written [0..6].
Returns:
status 1: The info has been properly written -1: Bus Collision error -2: Not Ack error condition -3: Write collision
Note:
Use the constants to specify the Day of the week (either Italian or English). [DO, LU, MA, ME, GI, VE, SA] or [SU, MO, TU, WE, TR, FR, SA]

Definition at line 211 of file PCF8563.c.

References DAY_WEEK_ADDR, and WRITE_ADD.

signed char set_days_alarm_RTCC ( unsigned char  days,
unsigned char  alarm_enable 
)

This function writes the Days for the alarm, in the RTC.

Parameters:
daysDays to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010).
alarmEnableEnable the alarm or not (for matching) [Enable_ON , Enable_OFF]
Returns:
status 1: 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 336 of file PCF8563.c.

References DAYS_ALARM_ADDR, and WRITE_ADD.

signed char set_days_RTCC ( unsigned char  days)

This function writes the days in the RTC.

Parameters:
daysDay to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010).
Returns:
status 1: 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 188 of file PCF8563.c.

References DAYS_ADDR, and WRITE_ADD.

signed char set_hours_alarm_RTCC ( unsigned char  hours,
unsigned char  alarm_enable 
)

This function writes the hours for the alarm, in the RTC.

Parameters:
hoursHours to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010).
alarmEnableEnable the alarm or not (for matching) [Enable_ON , Enable_OFF]
Returns:
status 1: 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 325 of file PCF8563.c.

References HOURS_ALARM_ADDR, and WRITE_ADD.

signed char set_hours_RTCC ( unsigned char  hours)

This function writes the hours in the RTC.

Parameters:
hoursHours to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010).
Returns:
status 1: 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 104 of file PCF8563.c.

References HOURS_ADDR, and WRITE_ADD.

signed char set_minutes_alarm_RTCC ( unsigned char  minutes,
unsigned char  alarm_enable 
)

This function writes the minutes for the alarm, in the RTC.

Parameters:
minutesMinutes to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010).
alarmEnableEnable the alarm or not (for matching) [Enable_ON , Enable_OFF]
Returns:
status 1: 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 312 of file PCF8563.c.

References MINUTS_ALARM_ADDR, and WRITE_ADD.

signed char set_minutes_RTCC ( unsigned char  minutes)

This function writes the seconds in the RTC.

Parameters:
minutesMinutes to be written, as 2 digits BCD format (eg. 22 min. is 0x22 or 0b00100010).
Returns:
status 1: 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 80 of file PCF8563.c.

References MINUTES_ADDR, and WRITE_ADD.

signed char set_months_RTCC ( unsigned char  months)

This function writes the moths in the RTC.

Parameters:
monthsMonths to be written, as 2 digits BCD format (eg. 12 is 0x12 or 0b00010010).
Returns:
status 1: 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 234 of file PCF8563.c.

References MONTHS_ADDR, and WRITE_ADD.

signed char set_seconds_RTCC ( unsigned char  seconds)

This function writes the seconds in the RTC.

Parameters:
secondsSeconds to be written, as 2 digits BCD format (eg. 22 sec. is 0x22 or 0b00100010).
Returns:
status 1: 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 53 of file PCF8563.c.

References SECONDS_ADDR, and WRITE_ADD.

signed char set_years_RTCC ( unsigned char  years)

This function writes the Year in the RTC.

Parameters:
yearsYear to be written, as 2 digits BCD format (eg. 2012 is only 0x12 or 0b00010010).
Returns:
status 1: 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 258 of file PCF8563.c.

References WRITE_ADD, and YEARS_ADDR.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines