RTC_Exported_Functions_Group3

Functions
HAL_StatusTypeDef	HAL_RTC_SetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	Sets the specified RTC Alarm. More...
HAL_StatusTypeDef	HAL_RTC_SetAlarm_IT (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	Sets the specified RTC Alarm. More...
HAL_StatusTypeDef	HAL_RTC_DeactivateAlarm (RTC_HandleTypeDef *hrtc)
	Deactivate the specified RTC Alarm. More...
HAL_StatusTypeDef	HAL_RTC_GetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	Gets the RTC Alarm value and masks. More...
void	HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTC_PollForAlarmAEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles AlarmA Polling request. More...
void	HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *hrtc)
	Alarm A callback. More...
HAL_StatusTypeDef	HAL_RTC_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wake up timer with interrupt. More...
uint32_t	HAL_RTC_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Deactivates wake up timer counter. More...
uint32_t	HAL_RTC_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Gets wake up timer counter. More...
void	HAL_RTC_WakeupTimerEventCallback (RTC_HandleTypeDef *hrtc)
	Wakeup Timer callback. More...
void	HAL_RTC_IRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles Alarm interrupt request. More...

Detailed Description

Function Documentation

HAL_RTC_AlarmAEventCallback()

void HAL_RTC_AlarmAEventCallback

(

RTC_HandleTypeDef *

hrtc

)

Alarm A callback.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values

None

HAL_RTC_DeactivateAlarm()

HAL_StatusTypeDef HAL_RTC_DeactivateAlarm

(

RTC_HandleTypeDef *

hrtc

)

Deactivate the specified RTC Alarm.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values

HAL

status

HAL_RTC_DeactivateWakeUpTimer()

uint32_t HAL_RTC_DeactivateWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Deactivates wake up timer counter.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values

HAL

status

HAL_RTC_GetAlarm()

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

Gets the RTC Alarm value and masks.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sAlarm	Pointer to Date 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

HAL

status

HAL_RTC_GetWakeUpTimer()

uint32_t HAL_RTC_GetWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Gets wake up timer counter.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values

Counter

value

HAL_RTC_IRQHandler()

void HAL_RTC_IRQHandler

(

RTC_HandleTypeDef *

hrtc

)

This function handles Alarm interrupt request.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values

None

HAL_RTC_PollForAlarmAEvent()

HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

This function handles AlarmA Polling request.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
Timeout	Timeout duration

Return values

HAL

status

HAL_RTC_SetAlarm()

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

Sets the specified RTC Alarm.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
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

HAL

status

HAL_RTC_SetAlarm_IT()

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

Sets the specified RTC Alarm.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
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

HAL

status

HAL_RTC_SetWakeUpTimer()

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

Sets wake up timer with interrupt.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock, see @RTC_Wakeup_Clock

Return values

HAL

status

HAL_RTC_WakeupTimerEventCallback()

void HAL_RTC_WakeupTimerEventCallback

(

RTC_HandleTypeDef *

hrtc

)

Wakeup Timer callback.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values

None