STM32HAL库常用库函数说明

系统函数

HAL_Delay（延时函数）

• 函数原型：

void HAL_Delay(uint32_t Delay);

参数	说明
Delay	延时时间
	数据类型：unsigned int 32位
返回值	无返回值

GPIO

HAL_GPIO_WritePin（GPIO引脚电平设置）

• 函数原型：

void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);

参数	说明
*GPIOx	引脚选泽，参数范围：GPIOA~GPIOC等
GPIO_Pin	引脚编号选择，参数范围：GPIO_PIN_0~GPIO_PIN_15等
PinState	引脚状态设置，参数范围：GPIO_PIN_SET：高电平
	GPIO_PIN_RESET:低电平
返回值	无返回值

• 应用举例

HAL_GPIO_WritePin(GPIOB,GPIO_PIN_15,GPIO_PIN_SET);//设置PB15引脚为高电平
HAL_Delay(500);//延时500ms
HAL_GPIO_WritePin(GPIOB,GPIO_PIN_15,GPIO_PIN_RESET);//设置PB15引脚为低电平
HAL_Delay(500);//延时500ms

HAL_GPIO_TogglePin（GPIO电平翻转）

• 函数原型：

void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);

参数	说明
*GPIOx	引脚选泽，参数范围：GPIOA~GPIOC等
GPIO_Pin	引脚编号选择，参数范围：GPIO_PIN_0~GPIO_PIN_15等
返回值	无返回值

• 应用举例

HAL_GPIO_TogglePin(GPIOB,GPIO_PIN_15);//翻转GPIO引脚电平
HAL_Delay(500);//延时500ms

HAL_GPIO_ReadPin（获取GPIO引脚状态）

• 函数原型：

GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);

参数	说明
*GPIOx	引脚选泽，参数范围：GPIOA~GPIOC等
GPIO_Pin	引脚编号选择，参数范围：GPIO_PIN_0~GPIO_PIN_15等
返回值	返回GPIO状态
	GPIO_PIN_SET：当前状态为高电平
	GPIO_PIN_RESET：当前状态为低电平

• 应用举例

if(HAL_GPIO_ReadPin(GPIOB,KEY1_Pin)==GPIO_PIN_RESET){//判断PB15引脚是否为低电平
	HAL_GPIO_WritePin(LED0_GPIO_Port,LED0_Pin,GPIO_PIN_SET);//设置PB14引脚为高电平
}else{
	HAL_GPIO_WritePin(LED0_GPIO_Port,LED0_Pin,GPIO_PIN_RESET);//设置PB14引脚为低电平
}

Timer

HAL_TIM_Base_Start_IT（打开定时器）

• 函数原型：

HAL_StatusTypeDef HAL_TIM_Base_Start_IT(TIM_HandleTypeDef *htim);

参数	说明
*htim	定时器选择，范围：&htim1~&htim8等

• 应用举例：

HAL_TIM_Base_Start_IT(&htim2);//开启定时器2中断

HAL_TIM_Base_Stop_IT（关闭定时器中断）

• 函数原型：

HAL_StatusTypeDef HAL_TIM_Base_Stop_IT(TIM_HandleTypeDef *htim);

参数	说明
*htim	定时器选择，范围：&htim1~&htim8等

• 应用举例：

  HAL_TIM_Base_Stop_IT(&htim2);//关闭定时器2中断

USART（串口）

HAL_UART_Transmit（阻塞式发送函数）

• 函数原型：

HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart,uint8_t *pData,uint16_t Size,uint32_t Timeout);

参数	说明
*huart	串口选择，范围：&huart1~&huart3等
*pData	发送的数据
Size	发送数据的长度
Timerout	超时时间

• 应用举例

unsigned char str[]={"hello world"};//需要发送的数据

HAL_UART_Transmit(&huart1,str,sizeof(str)，100);//串口发送数据

HAL_UART_Transmit_IT（非阻塞式发送函数）

• 函数原型：

HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart,uint8_t *pData,uint16_t Size);

参数	说明
*huart	串口选择，范围：&huart1~&huart3等
*pData	发送的数据
Size	发送数据的长度

• 应用举例：

unsigned char str[]={"hello world"};//需要发送的数据
HAL_UART_Transmit_IT(&huart1,str,sizeof(str)，100);//串口发送数据


//串口发送完毕回调函数
void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart){
  if(huart->Instance==USART1){//判断是否是串口1产生的中断
    HAL_GPIO_TogglePin(LED0_GPIO_Port,LED0_Pin);//翻转PB5电平
  }
}

HAL_UART_Receive（阻塞式接收函数）——不推荐使用

• 函数原型：

HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart,uint8_t *pData,uint16_t Size,uint32_t Timeout);

参数	说明
*huart	串口选择，范围：&huart1~&huart3等
*pData	接收的数据存放位置
Size	需要接收的长度
Timerout	超时时间

• 应用举例：

unsigned char str[1];//接收数据存放位置
HAL_UART_Receive(&huart1,str,1);//串口接收数据

HAL_UART_Receive_IT（非阻塞式接收函数）

• 函数原型：

HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart,uint8_t *pData,uint16_t Size);

参数	说明
*huart	串口选择，范围：&huart1~&huart3等
*pData	接收的数据存放位置
Size	需要接收的长度

• 应用举例：

unsigned char str[1];//接收数据存放位置
HAL_UART_Receive_IT(&huart1,str,1);//串口接收数据


//串口接收完毕回调函数
void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart){
  if(huart->Instance==USART1){//判断是否为串口1产生中断
    if(str[0]==0x80){//判断接收的数据是否为0x80
      HAL_GPIO_TogglePin(LED0_GPIO_Port,LED0_Pin);//翻转PB5电平
    }
  }
}

printf重定向

• 在开始修改代码之前我们需要引用头文件：stdio.h
• 修该fputc函数

int fputc(int c,FILE *stream){
  HAL_UART_Transmit(&huart1,(uint8_t *)&c,1,100);
  return c;
}

ADC

HAL_ADC_Start（阻塞式ADC转换开始）

• 函数原型：

HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc);

参数	说明
*hadc	ADC选择，范围：&hadc1~&hadc3等

HAL_ADC_Stop（阻塞式ADC转换停止）

• 函数原型：

HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef* hadc);

参数	说明
*hadc	ADC选择，范围：&hadc1~&hadc3等

HAL_ADC_Start_IT（非阻塞式ADC转换开始）

• 函数原型：

HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc);

参数	说明
*hadc	ADC选择，范围：&hadc1~&hadc3等

HAL_ADC_Stop_IT（非阻塞式ADC转换停止）

• 函数原型：

HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef* hadc);

参数	说明
*hadc	ADC选择，范围：&hadc1~&hadc3等

HAL_ADC_PollForConversion（等待常规组转换完成）

• 函数原型：

HAL_StatusTypeDef HAL_ADC_PollForConversion(ADC_HandleTypeDef* hadc, uint32_t Timeout)

参数	说明
*hadc	ADC选择，范围：&hadc1~&hadc3等
Timeout	超时时间
返回值	状态
	HAL_ERROR：错误
	HAL_TIMEOUT：超时
	HAL_OK：转换完成

HAL_ADC_GetValue（获取ADC转换结果）

• 函数原型：

uint32_t HAL_ADC_GetValue(ADC_HandleTypeDef* hadc);

参数	说明
*hadc	ADC选择，范围：&hadc1~&hadc3等
返回值	ADC转换结果

ADC单通道应用举例

//阻塞式
HAL_ADC_Start(&hadc1);//开始ADC转换
if(HAL_OK==HAL_ADC_PollForConversion(&hadc1,10)){//判断是否转换成功
	ADC_value=HAL_ADC_GetValue(&hadc1);//获取ADC转换值
   	printf("当前采集值为：%d\r\n",ADC_value);//串口输出值
}


//非阻塞式
HAL_ADC_Start_IT(&hadc1);//开始ADC转换

//ADC的中断回调函数
void HAL_ADC_ConvCpltCallback(ADC_HandleTypeDef* hadc){
  if(hadc->Instance==ADC1){//判断是否为ADC1产生的中断
    ADC_value=HAL_ADC_GetValue(&hadc1);//获取ADC转换值
    printf("当前值：%d\r\n",ADC_value);//串口输出值
  }
}