STM32F4xx_HAL_Driver  1.8.3
+ Collaboration diagram for ALARMB:

Functions

__STATIC_INLINE void LL_RTC_ALMB_Enable (RTC_TypeDef *RTCx)
 Enable Alarm B. More...
 
__STATIC_INLINE void LL_RTC_ALMB_Disable (RTC_TypeDef *RTCx)
 Disable Alarm B. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetMask (RTC_TypeDef *RTCx, uint32_t Mask)
 Specify the Alarm B masks. @rmtoll ALRMBR MSK4 LL_RTC_ALMB_SetMask
ALRMBR MSK3 LL_RTC_ALMB_SetMask
ALRMBR MSK2 LL_RTC_ALMB_SetMask
ALRMBR MSK1 LL_RTC_ALMB_SetMask. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMask (RTC_TypeDef *RTCx)
 Get the Alarm B masks. @rmtoll ALRMBR MSK4 LL_RTC_ALMB_GetMask
ALRMBR MSK3 LL_RTC_ALMB_GetMask
ALRMBR MSK2 LL_RTC_ALMB_GetMask
ALRMBR MSK1 LL_RTC_ALMB_GetMask. More...
 
__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) @rmtoll ALRMBR WDSEL LL_RTC_ALMB_EnableWeekday. More...
 
__STATIC_INLINE void LL_RTC_ALMB_DisableWeekday (RTC_TypeDef *RTCx)
 Disable AlarmB Week day selection (DU[3:0] represents the date ) @rmtoll ALRMBR WDSEL LL_RTC_ALMB_DisableWeekday. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetDay (RTC_TypeDef *RTCx, uint32_t Day)
 Set ALARM B Day in BCD format. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetDay (RTC_TypeDef *RTCx)
 Get ALARM B Day in BCD format. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetWeekDay (RTC_TypeDef *RTCx, uint32_t WeekDay)
 Set ALARM B Weekday @rmtoll ALRMBR DU LL_RTC_ALMB_SetWeekDay. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetWeekDay (RTC_TypeDef *RTCx)
 Get ALARM B Weekday @rmtoll ALRMBR DU LL_RTC_ALMB_GetWeekDay. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetTimeFormat (RTC_TypeDef *RTCx, uint32_t TimeFormat)
 Set ALARM B time format (AM/24-hour or PM notation) @rmtoll ALRMBR PM LL_RTC_ALMB_SetTimeFormat. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTimeFormat (RTC_TypeDef *RTCx)
 Get ALARM B time format (AM or PM notation) @rmtoll ALRMBR PM LL_RTC_ALMB_GetTimeFormat. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetHour (RTC_TypeDef *RTCx, uint32_t Hours)
 Set ALARM B Hours in BCD format. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetHour (RTC_TypeDef *RTCx)
 Get ALARM B Hours in BCD format. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetMinute (RTC_TypeDef *RTCx, uint32_t Minutes)
 Set ALARM B Minutes in BCD format. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMinute (RTC_TypeDef *RTCx)
 Get ALARM B Minutes in BCD format. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetSecond (RTC_TypeDef *RTCx, uint32_t Seconds)
 Set ALARM B Seconds in BCD format. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSecond (RTC_TypeDef *RTCx)
 Get ALARM B Seconds in BCD format. More...
 
__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 @rmtoll 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. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTime (RTC_TypeDef *RTCx)
 Get Alarm B Time (hour, minute and second) in BCD format. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetSubSecondMask (RTC_TypeDef *RTCx, uint32_t Mask)
 Mask the most-significant bits of the subseconds field starting from the bit specified in parameter Mask. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecondMask (RTC_TypeDef *RTCx)
 Get Alarm B subseconds mask @rmtoll ALRMBSSR MASKSS LL_RTC_ALMB_GetSubSecondMask. More...
 
__STATIC_INLINE void LL_RTC_ALMB_SetSubSecond (RTC_TypeDef *RTCx, uint32_t Subsecond)
 Set Alarm B subseconds value @rmtoll ALRMBSSR SS LL_RTC_ALMB_SetSubSecond. More...
 
__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecond (RTC_TypeDef *RTCx)
 Get Alarm B subseconds value @rmtoll ALRMBSSR SS LL_RTC_ALMB_GetSubSecond. More...
 

Detailed Description

Function Documentation

◆ LL_RTC_ALMB_ConfigTime()

__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 @rmtoll 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:
  • LL_RTC_ALMB_TIME_FORMAT_AM
  • LL_RTC_ALMB_TIME_FORMAT_PM
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 2197 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_Disable()

__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. @rmtoll CR ALRBE LL_RTC_ALMB_Disable
Parameters
RTCxRTC Instance
Return values
None

Definition at line 1935 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_DisableWeekday()

__STATIC_INLINE void LL_RTC_ALMB_DisableWeekday ( RTC_TypeDef *  RTCx)

Disable AlarmB Week day selection (DU[3:0] represents the date ) @rmtoll ALRMBR WDSEL LL_RTC_ALMB_DisableWeekday.

Parameters
RTCxRTC Instance
Return values
None

Definition at line 1998 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_Enable()

__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. @rmtoll CR ALRBE LL_RTC_ALMB_Enable
Parameters
RTCxRTC Instance
Return values
None

Definition at line 1923 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_EnableWeekday()

__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) @rmtoll ALRMBR WDSEL LL_RTC_ALMB_EnableWeekday.

Parameters
RTCxRTC Instance
Return values
None

Definition at line 1987 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetDay()

__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 @rmtoll 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 2026 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetHour()

__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 @rmtoll 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 2118 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetMask()

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetMask ( RTC_TypeDef *  RTCx)

Get the Alarm B masks. @rmtoll 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:
  • LL_RTC_ALMB_MASK_NONE
  • LL_RTC_ALMB_MASK_DATEWEEKDAY
  • LL_RTC_ALMB_MASK_HOURS
  • LL_RTC_ALMB_MASK_MINUTES
  • LL_RTC_ALMB_MASK_SECONDS
  • LL_RTC_ALMB_MASK_ALL

Definition at line 1976 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetMinute()

__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 @rmtoll 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 2146 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetSecond()

__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 @rmtoll 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 2174 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetSubSecond()

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecond ( RTC_TypeDef *  RTCx)

Get Alarm B subseconds value @rmtoll ALRMBSSR SS LL_RTC_ALMB_GetSubSecond.

Parameters
RTCxRTC Instance
Return values
Valuebetween Min_Data=0x00 and Max_Data=0x7FFF

Definition at line 2271 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetSubSecondMask()

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetSubSecondMask ( RTC_TypeDef *  RTCx)

Get Alarm B subseconds mask @rmtoll ALRMBSSR MASKSS LL_RTC_ALMB_GetSubSecondMask.

Parameters
RTCxRTC Instance
Return values
Valuebetween Min_Data=0x00 and Max_Data=0xF

Definition at line 2248 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetTime()

__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. @rmtoll 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 2222 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetTimeFormat()

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetTimeFormat ( RTC_TypeDef *  RTCx)

Get ALARM B time format (AM or PM notation) @rmtoll ALRMBR PM LL_RTC_ALMB_GetTimeFormat.

Parameters
RTCxRTC Instance
Return values
Returnedvalue can be one of the following values:
  • LL_RTC_ALMB_TIME_FORMAT_AM
  • LL_RTC_ALMB_TIME_FORMAT_PM

Definition at line 2090 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_GetWeekDay()

__STATIC_INLINE uint32_t LL_RTC_ALMB_GetWeekDay ( RTC_TypeDef *  RTCx)

Get ALARM B Weekday @rmtoll ALRMBR DU LL_RTC_ALMB_GetWeekDay.

Parameters
RTCxRTC Instance
Return values
Returnedvalue can be one of the following values:
  • LL_RTC_WEEKDAY_MONDAY
  • LL_RTC_WEEKDAY_TUESDAY
  • LL_RTC_WEEKDAY_WEDNESDAY
  • LL_RTC_WEEKDAY_THURSDAY
  • LL_RTC_WEEKDAY_FRIDAY
  • LL_RTC_WEEKDAY_SATURDAY
  • LL_RTC_WEEKDAY_SUNDAY

Definition at line 2063 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetDay()

__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 @rmtoll 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 2012 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetHour()

__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 @rmtoll 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 2104 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetMask()

__STATIC_INLINE void LL_RTC_ALMB_SetMask ( RTC_TypeDef *  RTCx,
uint32_t  Mask 
)

Specify the Alarm B masks. @rmtoll 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:
  • LL_RTC_ALMB_MASK_NONE
  • LL_RTC_ALMB_MASK_DATEWEEKDAY
  • LL_RTC_ALMB_MASK_HOURS
  • LL_RTC_ALMB_MASK_MINUTES
  • LL_RTC_ALMB_MASK_SECONDS
  • LL_RTC_ALMB_MASK_ALL
Return values
None

Definition at line 1956 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetMinute()

__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 @rmtoll 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 2132 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetSecond()

__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 @rmtoll 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 2160 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetSubSecond()

__STATIC_INLINE void LL_RTC_ALMB_SetSubSecond ( RTC_TypeDef *  RTCx,
uint32_t  Subsecond 
)

Set Alarm B subseconds value @rmtoll ALRMBSSR SS LL_RTC_ALMB_SetSubSecond.

Parameters
RTCxRTC Instance
SubsecondValue between Min_Data=0x00 and Max_Data=0x7FFF
Return values
None

Definition at line 2260 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetSubSecondMask()

__STATIC_INLINE void LL_RTC_ALMB_SetSubSecondMask ( RTC_TypeDef *  RTCx,
uint32_t  Mask 
)

Mask the most-significant bits of the subseconds field starting from the bit specified in parameter Mask.

Note
This register can be written only when ALRBE is reset in RTC_CR register, or in initialization mode. @rmtoll ALRMBSSR MASKSS LL_RTC_ALMB_SetSubSecondMask
Parameters
RTCxRTC Instance
MaskValue between Min_Data=0x00 and Max_Data=0xF
Return values
None

Definition at line 2237 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetTimeFormat()

__STATIC_INLINE void LL_RTC_ALMB_SetTimeFormat ( RTC_TypeDef *  RTCx,
uint32_t  TimeFormat 
)

Set ALARM B time format (AM/24-hour or PM notation) @rmtoll ALRMBR PM LL_RTC_ALMB_SetTimeFormat.

Parameters
RTCxRTC Instance
TimeFormatThis parameter can be one of the following values:
  • LL_RTC_ALMB_TIME_FORMAT_AM
  • LL_RTC_ALMB_TIME_FORMAT_PM
Return values
None

Definition at line 2077 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_ALMB_SetWeekDay()

__STATIC_INLINE void LL_RTC_ALMB_SetWeekDay ( RTC_TypeDef *  RTCx,
uint32_t  WeekDay 
)

Set ALARM B Weekday @rmtoll ALRMBR DU LL_RTC_ALMB_SetWeekDay.

Parameters
RTCxRTC Instance
WeekDayThis parameter can be one of the following values:
  • LL_RTC_WEEKDAY_MONDAY
  • LL_RTC_WEEKDAY_TUESDAY
  • LL_RTC_WEEKDAY_WEDNESDAY
  • LL_RTC_WEEKDAY_THURSDAY
  • LL_RTC_WEEKDAY_FRIDAY
  • LL_RTC_WEEKDAY_SATURDAY
  • LL_RTC_WEEKDAY_SUNDAY
Return values
None

Definition at line 2045 of file stm32f4xx_ll_rtc.h.