ST STM32F31xx

UM1581
Real-time clock (RTC)
DocID023800 Rev 1
377/584
19.2.26.3 RTC_GetAlarm
Function Name
void RTC_GetAlarm ( uint32_t RTC_Format, uint32_t
RTC_Alarm, RTC_AlarmTypeDef * RTC_AlarmStruct)
Function Description
Get the RTC Alarm value and masks.
Parameters
 RTC_Format : specifies the format of the output parameters.
This parameter can be one of the following values:
 RTC_Format_BIN : Binary data format
 RTC_Format_BCD : BCD data format
 RTC_Alarm : specifies the alarm to be read. This parameter
can be one of the following values:
 RTC_Alarm_A : to select Alarm A
 RTC_Alarm_B : to select Alarm B
 RTC_AlarmStruct : pointer to a RTC_AlarmTypeDef
structure that will contains the output alarm configuration
values.
Return values
 None.
Notes
 None.
19.2.26.4 RTC_AlarmCmd
Function Name
ErrorStatus RTC_AlarmCmd ( uint32_t RTC_Alarm,
FunctionalState NewState)
Function Description
Enables or disables the specified RTC Alarm.
Parameters
 RTC_Alarm : specifies the alarm to be configured. This
parameter can be any combination of the following values:
 RTC_Alarm_A : to select Alarm A
 RTC_Alarm_B : to select Alarm B
 NewState : new state of the specified alarm. This parameter
can be: ENABLE or DISABLE.
Return values
 An ErrorStatus enumeration value:
 SUCCESS: RTC Alarm is enabled/disabled
 ERROR: RTC Alarm is not enabled/disabled
Notes
 None.