ST STM32F31xx User Manual

Real-time clock (RTC)
UM1581
376/584
DocID023800 Rev 1
Return values
 None.
Notes
 None.
19.2.26 Alarm configuration functions
19.2.26.1 RTC_SetAlarm
Function Name
void RTC_SetAlarm ( uint32_t RTC_Format, uint32_t
RTC_Alarm, RTC_AlarmTypeDef * RTC_AlarmStruct)
Function Description
Set the specified RTC Alarm.
Parameters
 RTC_Format : specifies the format of the returned
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 configured. 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 contains the alarm configuration parameters.
Return values
 None.
Notes
 The Alarm register can only be written when the
corresponding Alarm is disabled (Use the
RTC_AlarmCmd(DISABLE)).
19.2.26.2 RTC_AlarmStructInit
Function Name
void RTC_AlarmStructInit ( RTC_AlarmTypeDef *
RTC_AlarmStruct)
Function Description
Fills each RTC_AlarmStruct member with its default value (Time =
00h:00mn:00sec / Date = 1st day of the month/Mask = all fields
are masked).
Parameters
 RTC_AlarmStruct : pointer to a RTC_AlarmTypeDef
structure which will be initialized.
Return values
 None.
Notes
 None.

ST STM32F31xx Specifications

General

Brand	ST
Model	STM32F31xx
Category	Microcontrollers
Language	English