A41 STM32_HAL库函数 之 Rtc通用驱动 所有函数的介绍及使用
1 该驱动函数预览
序号 | 函数名 | 描述 |
---|
1 | HAL_RTC_Init() | 初始化RTC(实时时钟)。 |
2 | HAL_RTC_DeInit() | 反初始化RTC。 |
3 | HAL_RTC_MspInit() | 初始化MCU外设相关的RTC引脚或资源。 |
4 | HAL_RTC_MspDeInit() | 反初始化MCU外设相关的RTC引脚或资源。 |
5 | HAL_RTC_SetTime() | 设置RTC的时间。 |
6 | HAL_RTC_GetTime() | 获取RTC的时间。 |
7 | HAL_RTC_SetDate() | 设置RTC的日期。 |
8 | HAL_RTC_GetDate() | 获取RTC的日期。 |
9 | HAL_RTC_SetAlarm() | 设置RTC的闹钟。 |
10 | HAL_RTC_SetAlarm_IT() | 设置RTC的闹钟并启用中断。 |
11 | HAL_RTC_GetAlarm() | 获取RTC的闹钟。 |
12 | HAL_RTC_DeactivateAlarm() | 停用RTC的闹钟。 |
13 | HAL_RTC_AlarmIRQHandler() | RTC闹钟中断处理程序。 |
14 | HAL_RTC_AlarmAEventCallback() | RTC闹钟事件A回调函数。 |
15 | HAL_RTC_PollForAlarmAEvent() | 轮询RTC闹钟事件A。 |
16 | HAL_RTC_GetState() | 获取RTC的状态。 |
17 | HAL_RTC_WaitForSynchro() | 等待RTC的同步。 |
以下是使用模板:
#include "stm32f4xx_hal.h"
int main(void) {
HAL_Init();
HAL_RTC_MspInit();
HAL_RTC_Init();
HAL_RTC_SetTime();
HAL_RTC_SetDate();
HAL_RTC_SetAlarm();
HAL_RTC_SetAlarm_IT();
HAL_RTC_GetTime();
HAL_RTC_GetDate();
HAL_RTC_GetAlarm();
HAL_RTC_DeInit();
HAL_RTC_MspDeInit();
return 0;
}
1.1 HAL_RTC_Init
函数名 | HAL_RTC_Init |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc) |
功能描述 | 初始化RTC |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.2 HAL_RTC_DeInit
函数名 | HAL_RTC_DeInit |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc) |
功能描述 | 复位RTC设置 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.3 HAL_RTC_MspInit
函数名 | HAL_RTC_MspInit |
---|
函数原形 | void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc) |
功能描述 | RTC外设底层驱动初始化 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.4 HAL_RTC_MspDeInit
函数名 | HAL_RTC_MspDeInit |
---|
函数原形 | void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc) |
功能描述 | RTC外设底层驱动去初始化 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.5 HAL_RTC_SetTime
函数名 | HAL_RTC_SetTime |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format) |
功能描述 | 设置RTC时间 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sTime:RTC时间结构体指针 |
输入参数 3 | Format:时间格式 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.6 HAL_RTC_GetTime
函数名 | HAL_RTC_GetTime |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format) |
功能描述 | 获取RTC时间 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sTime:RTC时间结构体指针 |
输入参数 3 | Format:时间格式 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.7 HAL_RTC_SetDate
函数名 | HAL_RTC_SetDate |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate) |
功能描述 | 设置RTC日期 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sDate:RTC日期结构体指针 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.8 HAL_RTC_GetDate
函数名 | HAL_RTC_GetDate |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate) |
功能描述 | 获取RTC日期 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sDate:RTC日期结构体指针 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.9 HAL_RTC_SetAlarm
函数名 | HAL_RTC_SetAlarm |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format) |
功能描述 | 设置RTC报警时间 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sAlarm:RTC报警结构体指针 |
输入参数 3 | Format:时间格式 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.10 HAL_RTC_SetAlarm_IT
函数名 | HAL_RTC_SetAlarm_IT |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format) |
功能描述 | 设置RTC报警时间并使能中断 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sAlarm:RTC报警结构体指针 |
输入参数 3 | Format:时间格式 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.11 HAL_RTC_GetAlarm
函数名 | HAL_RTC_GetAlarm |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format) |
功能描述 | 获取RTC报警时间 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | sAlarm:RTC报警结构体指针 |
输入参数 3 | Format:时间格式 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.12 HAL_RTC_DeactivateAlarm
函数名 | HAL_RTC_DeactivateAlarm |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm) |
功能描述 | 关闭RTC报警 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | Alarm:RTC报警编号 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.13 HAL_RTC_AlarmIRQHandler
函数名 | HAL_RTC_AlarmIRQHandler |
---|
函数原形 | void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc) |
功能描述 | RTC报警中断服务程序 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.14 HAL_RTC_AlarmAEventCallback
函数名 | HAL_RTC_AlarmAEventCallback |
---|
函数原形 | void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc) |
功能描述 | RTC报警事件回调函数 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.15 HAL_RTC_PollForAlarmAEvent
函数名 | HAL_RTC_PollForAlarmAEvent |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
功能描述 | 轮询RTC报警事件 |
输入参数 1 | hrtc:RTC句柄结构体指针 |
输入参数 2 | Timeout:超时时间(毫秒) |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.16 HAL_RTC_GetState
函数名 | HAL_RTC_GetState |
---|
函数原形 | HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc) |
功能描述 | 获取RTC状态 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | HAL_RTCStateTypeDef:RTC状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.17 HAL_RTC_WaitForSynchro
函数名 | HAL_RTC_WaitForSynchro |
---|
函数原形 | HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc) |
功能描述 | 等待RTC时钟同步 |
输入参数 | hrtc:RTC句柄结构体指针 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:函数执行状态 |
先决条件 | 无 |
被调用函数 | 无 |
该文档修改记录:
修改时间 | 修改说明 |
---|
2024年4月30日 | 第一次发布,介绍了该博客驱动所有函数的介绍及使用 |
总结
以上就是该博客驱动所有函数的介绍及使用的内容。
有不明白的地方欢迎留言;有建议欢迎留言,我后面编写文档好改进。
创作不容,如果文档对您有帮助,记得给个赞。