STM32F439xx HAL User Manual
Functions
ALARMB
RTC Exported Functions

Functions

__STATIC_INLINE void LL_RTC_ALMB_Enable (RTC_TypeDef *RTCx)
 Enable Alarm B.
__STATIC_INLINE void LL_RTC_ALMB_Disable (RTC_TypeDef *RTCx)
 Disable Alarm B.
__STATIC_INLINE void LL_RTC_ALMB_SetMask (RTC_TypeDef *RTCx, uint32_t Mask)
 Specify the Alarm B masks.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMask (RTC_TypeDef *RTCx)
 Get the Alarm B masks.
__STATIC_INLINE void LL_RTC_ALMB_EnableWeekday (RTC_TypeDef *RTCx)
 Enable AlarmB Week day selection (DU[3:0] represents the week day.
__STATIC_INLINE void LL_RTC_ALMB_DisableWeekday (RTC_TypeDef *RTCx)
 Disable AlarmB Week day selection (DU[3:0] represents the date )
__STATIC_INLINE void LL_RTC_ALMB_SetDay (RTC_TypeDef *RTCx, uint32_t Day)
 Set ALARM B Day in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetDay (RTC_TypeDef *RTCx)
 Get ALARM B Day in BCD format.
__STATIC_INLINE void LL_RTC_ALMB_SetWeekDay (RTC_TypeDef *RTCx, uint32_t WeekDay)
 Set ALARM B Weekday.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetWeekDay (RTC_TypeDef *RTCx)
 Get ALARM B Weekday.
__STATIC_INLINE void LL_RTC_ALMB_SetTimeFormat (RTC_TypeDef *RTCx, uint32_t TimeFormat)
 Set ALARM B time format (AM/24-hour or PM notation)
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTimeFormat (RTC_TypeDef *RTCx)
 Get ALARM B time format (AM or PM notation)
__STATIC_INLINE void LL_RTC_ALMB_SetHour (RTC_TypeDef *RTCx, uint32_t Hours)
 Set ALARM B Hours in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetHour (RTC_TypeDef *RTCx)
 Get ALARM B Hours in BCD format.
__STATIC_INLINE void LL_RTC_ALMB_SetMinute (RTC_TypeDef *RTCx, uint32_t Minutes)
 Set ALARM B Minutes in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMinute (RTC_TypeDef *RTCx)
 Get ALARM B Minutes in BCD format.
__STATIC_INLINE void LL_RTC_ALMB_SetSecond (RTC_TypeDef *RTCx, uint32_t Seconds)
 Set ALARM B Seconds in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSecond (RTC_TypeDef *RTCx)
 Get ALARM B Seconds in BCD format.
__STATIC_INLINE void LL_RTC_ALMB_ConfigTime (RTC_TypeDef *RTCx, uint32_t Format12_24, uint32_t Hours, uint32_t Minutes, uint32_t Seconds)
 Set Alarm B Time (hour, minute and second) in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTime (RTC_TypeDef *RTCx)
 Get Alarm B Time (hour, minute and second) in BCD format.
__STATIC_INLINE void LL_RTC_ALMB_SetSubSecondMask (RTC_TypeDef *RTCx, uint32_t Mask)
 Set Alarm B Mask the most-significant bits starting at this bit.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecondMask (RTC_TypeDef *RTCx)
 Get Alarm B Mask the most-significant bits starting at this bit.
__STATIC_INLINE void LL_RTC_ALMB_SetSubSecond (RTC_TypeDef *RTCx, uint32_t Subsecond)
 Set Alarm B Sub seconds value.
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecond (RTC_TypeDef *RTCx)
 Get Alarm B Sub seconds value.

Function Documentation

__STATIC_INLINE void LL_RTC_ALMB_ConfigTime ( RTC_TypeDef *  RTCx,
uint32_t  Format12_24,
uint32_t  Hours,
uint32_t  Minutes,
uint32_t  Seconds 
)

Set Alarm B Time (hour, minute and second) in BCD format.

Reference Manual to LL API cross reference:
ALRMBR PM LL_RTC_ALMB_ConfigTime
ALRMBR HT LL_RTC_ALMB_ConfigTime
ALRMBR HU LL_RTC_ALMB_ConfigTime
ALRMBR MNT LL_RTC_ALMB_ConfigTime
ALRMBR MNU LL_RTC_ALMB_ConfigTime
ALRMBR ST LL_RTC_ALMB_ConfigTime
ALRMBR SU LL_RTC_ALMB_ConfigTime
Parameters:
RTCxRTC Instance
Format12_24This parameter can be one of the following values:
HoursValue between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23
MinutesValue between Min_Data=0x00 and Max_Data=0x59
SecondsValue between Min_Data=0x00 and Max_Data=0x59
Return values:
None

Definition at line 2373 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_Init().

__STATIC_INLINE void LL_RTC_ALMB_Disable ( RTC_TypeDef *  RTCx)

Disable Alarm B.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
Reference Manual to LL API cross reference:
CR ALRBE LL_RTC_ALMB_Disable
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2099 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_DisableWeekday ( RTC_TypeDef *  RTCx)

Disable AlarmB Week day selection (DU[3:0] represents the date )

Reference Manual to LL API cross reference:
ALRMBR WDSEL LL_RTC_ALMB_DisableWeekday
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2162 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_Init().

__STATIC_INLINE void LL_RTC_ALMB_Enable ( RTC_TypeDef *  RTCx)

Enable Alarm B.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
Reference Manual to LL API cross reference:
CR ALRBE LL_RTC_ALMB_Enable
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2087 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_EnableWeekday ( RTC_TypeDef *  RTCx)

Enable AlarmB Week day selection (DU[3:0] represents the week day.

DT[1:0] is do not care)

Reference Manual to LL API cross reference:
ALRMBR WDSEL LL_RTC_ALMB_EnableWeekday
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2151 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_Init().

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetDay ( RTC_TypeDef *  RTCx)

Get ALARM B Day in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Day from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMBR DT LL_RTC_ALMB_GetDay
ALRMBR DU LL_RTC_ALMB_GetDay
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x01 and Max_Data=0x31

Definition at line 2190 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetHour ( RTC_TypeDef *  RTCx)

Get ALARM B Hours in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Hours from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMBR HT LL_RTC_ALMB_GetHour
ALRMBR HU LL_RTC_ALMB_GetHour
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23

Definition at line 2285 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_GetTime().

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMask ( RTC_TypeDef *  RTCx)

Get the Alarm B masks.

Reference Manual to LL API cross reference:
ALRMBR MSK4 LL_RTC_ALMB_GetMask
ALRMBR MSK3 LL_RTC_ALMB_GetMask
ALRMBR MSK2 LL_RTC_ALMB_GetMask
ALRMBR MSK1 LL_RTC_ALMB_GetMask
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be can be a combination of the following values:

Definition at line 2140 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMinute ( RTC_TypeDef *  RTCx)

Get ALARM B Minutes in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Minutes from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMBR MNT LL_RTC_ALMB_GetMinute
ALRMBR MNU LL_RTC_ALMB_GetMinute
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0x59

Definition at line 2316 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_GetTime().

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSecond ( RTC_TypeDef *  RTCx)

Get ALARM B Seconds in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Seconds from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMBR ST LL_RTC_ALMB_GetSecond
ALRMBR SU LL_RTC_ALMB_GetSecond
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0x59

Definition at line 2347 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_GetTime().

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecond ( RTC_TypeDef *  RTCx)

Get Alarm B Sub seconds value.

Reference Manual to LL API cross reference:
ALRMBSSR SS LL_RTC_ALMB_GetSubSecond
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0x7FFF

Definition at line 2445 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecondMask ( RTC_TypeDef *  RTCx)

Get Alarm B Mask the most-significant bits starting at this bit.

Reference Manual to LL API cross reference:
ALRMBSSR MASKSS LL_RTC_ALMB_GetSubSecondMask
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0xF

Definition at line 2422 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTime ( RTC_TypeDef *  RTCx)

Get Alarm B Time (hour, minute and second) in BCD format.

Note:
helper macros __LL_RTC_GET_HOUR, __LL_RTC_GET_MINUTE and __LL_RTC_GET_SECOND are available to get independently each parameter.
Reference Manual to LL API cross reference:
ALRMBR HT LL_RTC_ALMB_GetTime
ALRMBR HU LL_RTC_ALMB_GetTime
ALRMBR MNT LL_RTC_ALMB_GetTime
ALRMBR MNU LL_RTC_ALMB_GetTime
ALRMBR ST LL_RTC_ALMB_GetTime
ALRMBR SU LL_RTC_ALMB_GetTime
Parameters:
RTCxRTC Instance
Return values:
Combinationof hours, minutes and seconds.

Definition at line 2397 of file stm32f4xx_ll_rtc.h.

References LL_RTC_ALMB_GetHour(), LL_RTC_ALMB_GetMinute(), LL_RTC_ALMB_GetSecond(), RTC_OFFSET_HOUR, and RTC_OFFSET_MINUTE.

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTimeFormat ( RTC_TypeDef *  RTCx)

Get ALARM B time format (AM or PM notation)

Reference Manual to LL API cross reference:
ALRMBR PM LL_RTC_ALMB_GetTimeFormat
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 2257 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetWeekDay ( RTC_TypeDef *  RTCx)

Get ALARM B Weekday.

Reference Manual to LL API cross reference:
ALRMBR DU LL_RTC_ALMB_GetWeekDay
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 2230 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetDay ( RTC_TypeDef *  RTCx,
uint32_t  Day 
)

Set ALARM B Day in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Day from binary to BCD format
Reference Manual to LL API cross reference:
ALRMBR DT LL_RTC_ALMB_SetDay
ALRMBR DU LL_RTC_ALMB_SetDay
Parameters:
RTCxRTC Instance
DayValue between Min_Data=0x01 and Max_Data=0x31
Return values:
None

Definition at line 2176 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_Init().

__STATIC_INLINE void LL_RTC_ALMB_SetHour ( RTC_TypeDef *  RTCx,
uint32_t  Hours 
)

Set ALARM B Hours in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Hours from binary to BCD format
Reference Manual to LL API cross reference:
ALRMBR HT LL_RTC_ALMB_SetHour
ALRMBR HU LL_RTC_ALMB_SetHour
Parameters:
RTCxRTC Instance
HoursValue between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23
Return values:
None

Definition at line 2271 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetMask ( RTC_TypeDef *  RTCx,
uint32_t  Mask 
)

Specify the Alarm B masks.

Reference Manual to LL API cross reference:
ALRMBR MSK4 LL_RTC_ALMB_SetMask
ALRMBR MSK3 LL_RTC_ALMB_SetMask
ALRMBR MSK2 LL_RTC_ALMB_SetMask
ALRMBR MSK1 LL_RTC_ALMB_SetMask
Parameters:
RTCxRTC Instance
MaskThis parameter can be a combination of the following values:
Return values:
None

Definition at line 2120 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_Init().

__STATIC_INLINE void LL_RTC_ALMB_SetMinute ( RTC_TypeDef *  RTCx,
uint32_t  Minutes 
)

Set ALARM B Minutes in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Minutes from binary to BCD format
Reference Manual to LL API cross reference:
ALRMBR MNT LL_RTC_ALMB_SetMinute
ALRMBR MNU LL_RTC_ALMB_SetMinute
Parameters:
RTCxRTC Instance
Minutesbetween Min_Data=0x00 and Max_Data=0x59
Return values:
None

Definition at line 2302 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetSecond ( RTC_TypeDef *  RTCx,
uint32_t  Seconds 
)

Set ALARM B Seconds in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Seconds from binary to BCD format
Reference Manual to LL API cross reference:
ALRMBR ST LL_RTC_ALMB_SetSecond
ALRMBR SU LL_RTC_ALMB_SetSecond
Parameters:
RTCxRTC Instance
SecondsValue between Min_Data=0x00 and Max_Data=0x59
Return values:
None

Definition at line 2333 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetSubSecond ( RTC_TypeDef *  RTCx,
uint32_t  Subsecond 
)

Set Alarm B Sub seconds value.

Reference Manual to LL API cross reference:
ALRMBSSR SS LL_RTC_ALMB_SetSubSecond
Parameters:
RTCxRTC Instance
SubsecondValue between Min_Data=0x00 and Max_Data=0x7FFF
Return values:
None

Definition at line 2434 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetSubSecondMask ( RTC_TypeDef *  RTCx,
uint32_t  Mask 
)

Set Alarm B Mask the most-significant bits starting at this bit.

Note:
This register can be written only when ALRBE is reset in RTC_CR register, or in initialization mode.
Reference Manual to LL API cross reference:
ALRMBSSR MASKSS LL_RTC_ALMB_SetSubSecondMask
Parameters:
RTCxRTC Instance
MaskValue between Min_Data=0x00 and Max_Data=0xF
Return values:
None

Definition at line 2411 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetTimeFormat ( RTC_TypeDef *  RTCx,
uint32_t  TimeFormat 
)

Set ALARM B time format (AM/24-hour or PM notation)

Reference Manual to LL API cross reference:
ALRMBR PM LL_RTC_ALMB_SetTimeFormat
Parameters:
RTCxRTC Instance
TimeFormatThis parameter can be one of the following values:
Return values:
None

Definition at line 2244 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMB_SetWeekDay ( RTC_TypeDef *  RTCx,
uint32_t  WeekDay 
)

Set ALARM B Weekday.

Reference Manual to LL API cross reference:
ALRMBR DU LL_RTC_ALMB_SetWeekDay
Parameters:
RTCxRTC Instance
WeekDayThis parameter can be one of the following values:
Return values:
None

Definition at line 2212 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMB_Init().