1.4.20.49 RTC_RTCCTimeSet Function

C

bool RTC_RTCCTimeSet (struct tm * initialTime )

Summary

Sets the Real Time Clock Calendar time and date.

Description

This function sets the Real Time Clock Calendar time and date. The time and date should be specified via the struct tm structure. The isdst, tm_wday, tm_yday member of the initialTime data structure is ignored.

The reference year parameter in MHC should be adjusted to be within 64 years of the input year range. In that, the function will subtract the reference year from the input year while setting the calendar year.

Precondition

RTC_Initialize must have been called for the associated RTC instance. The RTC should have been configured for Real Time Clock Calendar operation.

Parameters

Returns

bool.

Example

struct tm initialTime;

RTC_Initialize();

// Set the time as 22:31:23 and date as 7 April 1980.
// The Reference Year Configuration in MHC should be within
// 64 years of 1980. Also note that tm structure needs the tm_year to
// specified as years since 1900.

initialTime.tm_sec = 23;
initialTime.tm_min = 31;
initialTime.tm_hour = 22;
initialTime.tm_mday = 7;
initialTime.tm_mon = 3;
initialTime.tm_year = 80;

if(RTC_RTCCTimeSet(&initialTime) == false)
{
    //incorrect format
}

Remarks

None.