Eric Lewiston / STM32L4xx_HAL_Driver

Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

RTC Alarm functions
Functions

RTC Alarm functions
[RTC Exported Functions]

RTC Alarm functions. More...

Functions

HAL_StatusTypeDef HAL_RTC_SetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
 Set the specified RTC Alarm.
HAL_StatusTypeDef HAL_RTC_SetAlarm_IT (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
 Set the specified RTC Alarm with Interrupt.
HAL_StatusTypeDef HAL_RTC_DeactivateAlarm (RTC_HandleTypeDef *hrtc, uint32_t Alarm)
 Deactivate the specified RTC Alarm.
HAL_StatusTypeDef HAL_RTC_GetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format)
 Get the RTC Alarm value and masks.
void HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef *hrtc)
 Handle Alarm interrupt request.
__weak void HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *hrtc)
 Alarm A callback.
HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
 Handle AlarmA Polling request.

Detailed Description

RTC Alarm functions. 

 ===============================================================================
                 ##### RTC Alarm functions #####
 ===============================================================================  
 
 [..] This section provides functions allowing to configure Alarm feature

Function Documentation

__weak void HAL_RTC_AlarmAEventCallback ( RTC_HandleTypeDef *  hrtc )

Alarm A callback.

Parameters:
hrtc,:RTC handle
Return values:
None

Definition at line 1313 of file stm32l4xx_hal_rtc.c.

void HAL_RTC_AlarmIRQHandler ( RTC_HandleTypeDef *  hrtc )

Handle Alarm interrupt request.

Parameters:
hrtc,:RTC handle
Return values:
None

Definition at line 1271 of file stm32l4xx_hal_rtc.c.

HAL_StatusTypeDef HAL_RTC_DeactivateAlarm ( RTC_HandleTypeDef *  hrtc,
uint32_t  Alarm 
)

Deactivate the specified RTC Alarm.

Parameters:
hrtc,:RTC handle
Alarm,:Specifies the Alarm. This parameter can be one of the following values:

  • RTC_ALARM_A: AlarmA
  • RTC_ALARM_B: AlarmB
Return values:
HALstatus

Definition at line 1126 of file stm32l4xx_hal_rtc.c.

HAL_StatusTypeDef HAL_RTC_GetAlarm ( RTC_HandleTypeDef *  hrtc,
RTC_AlarmTypeDef *  sAlarm,
uint32_t  Alarm,
uint32_t  Format 
)

Get the RTC Alarm value and masks.

Parameters:
hrtc,:RTC handle
sAlarm,:Pointer to Date structure
Alarm,:Specifies the Alarm. This parameter can be one of the following values:

  • RTC_ALARM_A: AlarmA
  • RTC_ALARM_B: AlarmB
Format,:Specifies the format of the entered parameters. This parameter can be one of the following values:

  • RTC_FORMAT_BIN: Binary data format
  • RTC_FORMAT_BCD: BCD data format
Return values:
HALstatus

Definition at line 1220 of file stm32l4xx_hal_rtc.c.

HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent ( RTC_HandleTypeDef *  hrtc,
uint32_t  Timeout 
)

Handle AlarmA Polling request.

Parameters:
hrtc,:RTC handle
Timeout,:Timeout duration
Return values:
HALstatus

Definition at line 1326 of file stm32l4xx_hal_rtc.c.

HAL_StatusTypeDef HAL_RTC_SetAlarm ( RTC_HandleTypeDef *  hrtc,
RTC_AlarmTypeDef *  sAlarm,
uint32_t  Format 
)

Set the specified RTC Alarm.

Parameters:
hrtc,:RTC handle
sAlarm,:Pointer to Alarm structure
Format,:Specifies the format of the entered parameters. This parameter can be one of the following values:

  • RTC_FORMAT_BIN: Binary data format
  • RTC_FORMAT_BCD: BCD data format
Return values:
HALstatus

Definition at line 757 of file stm32l4xx_hal_rtc.c.

HAL_StatusTypeDef HAL_RTC_SetAlarm_IT ( RTC_HandleTypeDef *  hrtc,
RTC_AlarmTypeDef *  sAlarm,
uint32_t  Format 
)

Set the specified RTC Alarm with Interrupt.

Parameters:
hrtc,:RTC handle
sAlarm,:Pointer to Alarm structure
Format,:Specifies the format of the entered parameters. This parameter can be one of the following values:

  • RTC_FORMAT_BIN: Binary data format
  • RTC_FORMAT_BCD: BCD data format
Note:
The Alarm register can only be written when the corresponding Alarm is disabled (Use the HAL_RTC_DeactivateAlarm()).
The HAL_RTC_SetTime() must be called before enabling the Alarm feature.
Return values:
HALstatus

Definition at line 941 of file stm32l4xx_hal_rtc.c.

Generated on Tue Jul 12 2022 11:35:30 by  doxygen 1.7.2