Function rtc_calendar_set_alarm()

Set the alarm time for the specified alarm.

enum status_code rtc_calendar_set_alarm(
		struct rtc_module *const module,
		const struct rtc_calendar_alarm_time *const alarm,
		const enum rtc_calendar_alarm alarm_index)

Sets the time and mask specified to the requested alarm.

Table 1. Parameters
Data direction Parameter name Description

[in, out]

module

Pointer to the software instance struct

[in]

alarm

The alarm struct to set the alarm with

[in]

alarm_index

The index of the alarm to set

Returns

Status of setting alarm.

Table 2. Return Values
Return value Description

STATUS_OK

If alarm was set correctly

STATUS_ERR_INVALID_ARG

If invalid argument(s) were provided