15.6.3.3.5 Function rtc_calendar_is_alarm_match()
Check the RTC alarm flag.
bool rtc_calendar_is_alarm_match( struct rtc_module *const module, const enum rtc_calendar_alarm alarm_index)
Check if the specified alarm flag is set. The flag is set when there is an compare match between the alarm value and the clock.
| Data direction | Parameter name | Description |
|---|---|---|
|
[in, out] |
module |
Pointer to the software instance struct |
|
[in] |
alarm_index |
Index of the alarm to check |
Returns
Match status of the specified alarm.
| Return value | Description |
|---|---|
|
true |
If the specified alarm has matched the current time |
|
false |
If the specified alarm has not matched the current time |