HAL TimeBase RTC Alarm Template

Collaboration diagram for HAL TimeBase RTC Alarm Template:

Functions
void	RTC_Alarm_IRQHandler (void)
	This function handles RTC ALARM interrupt request. More...
HAL_StatusTypeDef	HAL_InitTick (uint32_t TickPriority)
	This function configures the RTC_ALARMA as a time base source. The time source is configured to have 1ms time base with a dedicated Tick interrupt priority. More...
void	HAL_SuspendTick (void)
	Suspend Tick increment. More...
void	HAL_ResumeTick (void)
	Resume Tick increment. More...
void	HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *hrtc)
	ALARM A Event Callback in non blocking mode. More...

Variables
RTC_HandleTypeDef	hRTC_Handle

Detailed Description

Function Documentation

HAL_InitTick()

HAL_StatusTypeDef HAL_InitTick

(

uint32_t

TickPriority

)

This function configures the RTC_ALARMA as a time base source. The time source is configured to have 1ms time base with a dedicated Tick interrupt priority.

Note

This function is called automatically at the beginning of program after reset by HAL_Init() or at any time when clock is configured, by HAL_RCC_ClockConfig().

Parameters

TickPriority

Tick interrupt priority.

Return values

HAL

status

Definition at line 96 of file stm32f4xx_hal_timebase_rtc_alarm_template.c.

HAL_ResumeTick()

void HAL_ResumeTick

(

void

)

Resume Tick increment.

Note

Enable the tick increment by Enabling RTC ALARM interrupt.

Return values

None

Definition at line 255 of file stm32f4xx_hal_timebase_rtc_alarm_template.c.

HAL_RTC_AlarmAEventCallback()

void HAL_RTC_AlarmAEventCallback

(

RTC_HandleTypeDef *

hrtc

)

ALARM A Event Callback in non blocking mode.

Note

This function is called when RTC_ALARM interrupt took place, inside RTC_ALARM_IRQHandler(). It makes a direct call to HAL_IncTick() to increment a global variable "uwTick" used as application time base.

Parameters

hrtc	RTC handle

Return values

None

Definition at line 273 of file stm32f4xx_hal_timebase_rtc_alarm_template.c.

HAL_SuspendTick()

void HAL_SuspendTick

(

void

)

Suspend Tick increment.

Note

Disable the tick increment by disabling RTC ALARM interrupt.

Return values

None

Definition at line 240 of file stm32f4xx_hal_timebase_rtc_alarm_template.c.

RTC_Alarm_IRQHandler()

void RTC_Alarm_IRQHandler

(

void

)

This function handles RTC ALARM interrupt request.

Return values

None

Definition at line 305 of file stm32f4xx_hal_timebase_rtc_alarm_template.c.