Real Time Clock (RTC) API Function List

Initialization

RTC_Init Initializes the API.

Date, Time

RTC_GetDate Acquires the date.
RTC_GetDateAsync Asynchronously acquires the date.
RTC_SetDate Modifies the date.
RTC_SetDateAsync Asynchronously modifies the date.
RTC_GetTime Gets the time.
RTC_GetTimeAsync Asynchronously gets the time.
RTC_SetTime Modifies the time.
RTC_SetTimeAsync Asynchronously modifies the time.
RTC_GetDateTime Gets the date and the time.
RTC_GetDateTimeAsync Asynchronously gets the date and the time.
RTC_SetDateTime Modifies the date and the time.
RTC_SetDateTimeAsync Asynchronously modifies the date and the time.

Alarms

RTC_SetAlarmInterrupt Sets the callback function that runs when an alarm interrupt is generated.
RTC_GetAlarmStatus Gets alarm interrupt permission status.
RTC_GetAlarmStatusAsync Asynchronously gets alarm interrupt permission status.
RTC_SetAlarmStatus Modifies alarm interrupt permission status.
RTC_SetAlarmStatusAsync Asynchronously modifies alarm interrupt permission status.
RTC_GetAlarmParam Gets alarm parameter values.
RTC_GetAlarmParamAsync Asynchronously gets alarm parameter values.
RTC_SetAlarmParam Modifies alarm parameter values.
RTC_SetAlarmParamAsync Asynchronously modifies alarm parameter values.

Types, Structures

RTCDate Date structure
RTCWeek Day of the week enumeration
RTCTime Time structure
RTCAlarmChan Alarm channel enumeration
RTCAlarmStatus RTC alarm interrupt permission status enumeration
RTCAlarmParam Alarm parameter structure
RTCCallback Callback function type for asynchronous functions
RTCInterrupt Callback function type for RTC alarm interrupts
RTCResult Enumeration of the process results that are common to the RTC function group