RTCAlarmParam

Definition

#include <nitro/rtc.h>
typedef struct {
         RTCWeek    week;
         u32        hour;
         u32        minute;
         u32        enable;
} RTCAlarmParam;

Elements

week Value of the RTCWeek enumeration that indicates the day of the week.
hour Numerical value, from 0 to 23, that indicates the hour.
minute Numerical value, from 0 to 59, that indicates the minute.
enable Flag to determine the enabling of alarms (respectively) for: the day of the week, the hour, and the minute

Description

Indicates the real-time clock alarm parameters. This function indicates the day of the week, the hour ,and the minute, as well as the status of the flag that determines whether each element is enabled.
The enable flag that determines whether an alarm is enabled can have any of the following values, or can be the value of the logical OR of all of them.

RTC_ALARM_ENABLE_NONE 0x0000 All determining flags disabled
RTC_ALARM_ENABLE_WEEK 0x0001 Use day of week parameter in alarm determination.
RTC_ALARM_ENABLE_HOUR 0x0002 Use hour parameter in alarm determination.
RTC_ALARM_ENABLE_MINUTE 0x0004 Use minute parameter in alarm determination.

See Also

RTCWeek

Revision History

2004/08/19 Changed descriptions because the time notation was fixed.
2004/07/01 Changed descriptions because the time notation was standardized.
2004/05/18 Initial version.


CONFIDENTIAL