RTC Alarm functions

RTC Alarm functions. 更多...

函数
HAL_StatusTypeDef	HAL_RTC_SetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	设置指定的RTC闹钟。
HAL_StatusTypeDef	HAL_RTC_SetAlarm_IT (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
	设置指定的RTC闹钟（带中断）。
HAL_StatusTypeDef	HAL_RTC_DeactivateAlarm (RTC_HandleTypeDef *hrtc, uint32_t Alarm)
	禁用指定的RTC闹钟。
HAL_StatusTypeDef	HAL_RTC_GetAlarm (RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format)
	获取RTC闹钟的值和掩码。
void	HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef *hrtc)
	处理闹钟中断请求。
__weak void	HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *hrtc)
	闹钟A回调函数。
HAL_StatusTypeDef	HAL_RTC_PollForAlarmAEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	处理闹钟A轮询请求。

---

详细说明

RTC Alarm functions.

 ===============================================================================
                 ##### RTC Alarm functions #####
 ===============================================================================

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

---

函数文档

void HAL_RTC_AlarmAEventCallback

(

RTC_HandleTypeDef *

hrtc

)

闹钟A回调函数。

参数:

hrtc

RTC句柄

返回值:

无

Definition at line 1723 of file stm32g4xx_hal_rtc.c.

References UNUSED.

Referenced by HAL_RTC_AlarmIRQHandler(), HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

void HAL_RTC_AlarmIRQHandler

(

RTC_HandleTypeDef *

hrtc

)

处理闹钟中断请求。

参数:

hrtc

RTC句柄

返回值:

无

Definition at line 1681 of file stm32g4xx_hal_rtc.c.

References __HAL_RTC_ALARM_EXTI_CLEAR_IT, __RTC_HandleTypeDef::AlarmAEventCallback, __RTC_HandleTypeDef::AlarmBEventCallback, HAL_RTC_AlarmAEventCallback(), HAL_RTC_STATE_READY, HAL_RTCEx_AlarmBEventCallback(), __RTC_HandleTypeDef::Instance, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTC_DeactivateAlarm	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Alarm
	)

禁用指定的RTC闹钟。

参数:

hrtc	RTC句柄
Alarm	指定闹钟。该参数可以是以下值之一： RTC_ALARM_A: 闹钟A RTC_ALARM_B: 闹钟B

返回值:

HAL状态

Definition at line 1529 of file stm32g4xx_hal_rtc.c.

References __HAL_RTC_ALARM_EXTI_CLEAR_IT, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_GetTick(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, __RTC_HandleTypeDef::Instance, IS_RTC_ALARM, RTC_ALARM_A, RTC_TIMEOUT_VALUE, and __RTC_HandleTypeDef::State.

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

获取RTC闹钟的值和掩码。

参数:

hrtc	RTC句柄
sAlarm	指向日期结构的指针
Alarm	指定闹钟。该参数可以是以下值之一： RTC_ALARM_A: 闹钟A RTC_ALARM_B: 闹钟B
Format	指定输入参数的格式。该参数可以是以下值之一： RTC_FORMAT_BIN: 二进制数据格式 RTC_FORMAT_BCD: BCD数据格式

返回值:

HAL状态

Definition at line 1621 of file stm32g4xx_hal_rtc.c.

References RTC_AlarmTypeDef::Alarm, RTC_AlarmTypeDef::AlarmDateWeekDay, RTC_AlarmTypeDef::AlarmDateWeekDaySel, RTC_AlarmTypeDef::AlarmMask, RTC_AlarmTypeDef::AlarmTime, assert_param, RTC_TimeTypeDef::Hours, __RTC_HandleTypeDef::Instance, IS_RTC_ALARM, IS_RTC_FORMAT, RTC_TimeTypeDef::Minutes, RTC_ALARM_A, RTC_ALARM_B, RTC_ALARMMASK_ALL, RTC_Bcd2ToByte(), RTC_FORMAT_BIN, RTC_TimeTypeDef::Seconds, RTC_TimeTypeDef::SubSeconds, and RTC_TimeTypeDef::TimeFormat.

HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

处理闹钟A轮询请求。

参数:

hrtc	RTC句柄
Timeout	超时时间

返回值:

HAL状态

Definition at line 1739 of file stm32g4xx_hal_rtc.c.

References HAL_GetTick(), HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, __RTC_HandleTypeDef::Instance, and __RTC_HandleTypeDef::State.

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

设置指定的RTC闹钟。

参数:

hrtc	RTC句柄
sAlarm	指向闹钟结构的指针
Format	指定输入参数的格式。该参数可以是以下值之一： RTC_FORMAT_BIN: 二进制数据格式 RTC