TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

RTC Wake-up functions

RTC Wake-up functions
[RTCEx Exported Functions]

RTC Wake-up functions. More...

Functions

HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
 Set wake up timer.
HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
 Set wake up timer with interrupt.
uint32_t HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
 Deactivate wake up timer counter.
uint32_t HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
 Get wake up timer counter.
void HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
 Handle Wake Up Timer interrupt request.
__weak void HAL_RTCEx_WakeUpTimerEventCallback (RTC_HandleTypeDef *hrtc)
 Wake Up Timer callback.
HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
 Handle Wake Up Timer Polling.

Detailed Description

RTC Wake-up functions.

 ===============================================================================
                        ##### RTC Wake-up functions #####
 ===============================================================================  

 [..] This section provide functions allowing to configure Wake-up feature


Function Documentation

uint32_t HAL_RTCEx_DeactivateWakeUpTimer ( RTC_HandleTypeDef *  hrtc )

Deactivate wake up timer counter.

Parameters:
hrtc,:RTC handle
Return values:
HALstatus

Definition at line 1184 of file stm32l4xx_hal_rtc_ex.c.

uint32_t HAL_RTCEx_GetWakeUpTimer ( RTC_HandleTypeDef *  hrtc )

Get wake up timer counter.

Parameters:
hrtc,:RTC handle
Return values:
Countervalue

Definition at line 1236 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent ( RTC_HandleTypeDef *  hrtc,
uint32_t  Timeout 
)

Handle Wake Up Timer Polling.

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

Definition at line 1288 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer ( RTC_HandleTypeDef *  hrtc,
uint32_t  WakeUpCounter,
uint32_t  WakeUpClock 
)

Set wake up timer.

Parameters:
hrtc,:RTC handle
WakeUpCounter,:Wake up counter
WakeUpClock,:Wake up clock
Return values:
HALstatus

Definition at line 998 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT ( RTC_HandleTypeDef *  hrtc,
uint32_t  WakeUpCounter,
uint32_t  WakeUpClock 
)

Set wake up timer with interrupt.

Parameters:
hrtc,:RTC handle
WakeUpCounter,:Wake up counter
WakeUpClock,:Wake up clock
Return values:
HALstatus

Definition at line 1088 of file stm32l4xx_hal_rtc_ex.c.

void HAL_RTCEx_WakeUpTimerEventCallback ( RTC_HandleTypeDef *  hrtc )

Wake Up Timer callback.

Parameters:
hrtc,:RTC handle
Return values:
None

Definition at line 1272 of file stm32l4xx_hal_rtc_ex.c.

void HAL_RTCEx_WakeUpTimerIRQHandler ( RTC_HandleTypeDef *  hrtc )

Handle Wake Up Timer interrupt request.

Parameters:
hrtc,:RTC handle
Return values:
None

Definition at line 1247 of file stm32l4xx_hal_rtc_ex.c.