本文介绍了如何使用STM32F103的HAL库和STM32CubeMX配置工具，通过模块化方法控制LED灯、按键和串口通信，提供详细的驱动代码示例，以提升代码的可读性、可维护性和重用性。
一、开发环境
硬件：正点原子 STM32F1精英版 开发板
单片机：STM32F103ZET6
Keil版本：5.32
STM32CubeMX版本：6.9.2
STM32Cube MCU Packges版本：STM32F1 V1.8.5
虽然这里演示的是STM32F103，但是STM32F407还是STM32H系列等，但是可直接将LED、按键、串口文件复制使用，仅供需改头文件的引脚，这里是用STM32F407实现的介绍（http://t.csdnimg.cn/CWVUM）。之前介绍了很多关于点灯的方法，比如轮询、定时器中断、PWM、按键点灯等方式，这些文章使用的编程方法都不是模块化的编写方式，往往会导致代码可读性差、重用性差、扩展性差以及测试和维护困难等问题。为了避免这些问题，我们实际工作中通常会采用模块化的编写方法，这样可以确保代码结构清晰、功能明确，提高代码的可读性和可维护性，同时降低功能之间的耦合度，增强代码的重用性和扩展性。模块化的编写方式还有助于实现代码的并行开发，提高开发效率，使得整个项目更加易于管理和维护。
基于之前的按键点灯的程序和printf重定向输出进行修改，我将为您详细阐述如何使用STM32F103的HAL库，并结合STM32CubeMX配置工具，通过模块化方法用按键分别控制两个LED灯并通过串口打印按键与灯的状态，即用引脚PE3和PE4按键分别控制PB5和PE5引脚LED，通过USART1打印信息。这一简洁而高效的流程将助您迅速掌握LED、按键、串口模块化编写方法。
1.LED灯
用drv_led.h和drv_led.c作为一个独立的模块，并提供三个LED驱动程序的接口int LedDrvInit(BoardLed led);//初始化指定的LED
int LedDrvWrite(BoardLed led, LedStatus status);//设置指定LED的状态
int LedDrvRead(BoardLed led);//读取指定LED的当前状态
2.按键
用drv_key.h和drv_key.c作为一个独立的模块，并提供两个KEY驱动程序的接口
int KeyDrvInit(BoardKey key);//用于初始化指定的按键。
int KeyDrvRead(BoardKey key);//用于读取指定按键的状态。3.串口USART1
int UartDrvInit(BoardUart uart);// 定义宏，将DbgUart映射到具体的USART（通用同步异步收发器）硬件接口，这里映射到USART1
// 声明UartDrvWrite函数，该函数用于向指定的UART接口写入数据，参数pbuf指向要写入的数据，length表示数据长度
int UartDrvWrite(BoardUart uart, unsigned char *pbuf, unsigned short length);
// 声明UartDrvRead函数，该函数用于从指定的UART接口读取数据，参数pbuf用于存储读取到的数据，length表示读取的数据长度
int UartDrvRead(BoardUart uart, unsigned char *pbuf, unsigned short length);
二、配置STM32CubeMX
- 启动STM32CubeMX，新建STM32CubeMX项目：
- 选择MCU：在软件中选择你的STM32型号-STM32F103ZET6。
- 选择时钟源：
- 配置时钟：
- 使能Debug功能：Serial Wire
- HAL库时基选择：SysTick
- 配置LED引脚：当前硬件的LED灯的引脚是PB5和PE5：在Pinout & Configuration标签页中，找到LED连接的GPIO端口，并设置为输出模式，通常选择Push-Pull，GPIO output level选低电平。
- 配置KEY引脚：当前硬件的KEY的引脚是PE3和PE4：在Pinout & Configuration标签页中，找到KEY连接的GPIO端口，并设置为输入模式，通常选择Pull-up。
- 配置USART1串口：
- 配置工程参数：在Project标签页中，配置项目名称和位置，选择工具链MDK-ARM。
- 生成代码：在Code Generator标签页中，配置工程外设文件与HAL库，勾选头文件.c和.h文件分开，然后点击Project > Generate Code生成代码。
三、代码实现与部署
-
新建文件：在工程目录下建立ModuleDrivers的文件夹，名字随意,用于保存LED灯的驱动drv_led.h和drv_led.c ：
drv_led.h#ifndef __DRV_LED_H #define __DRV_LED_H typedef enum{ LED1 = 1, LED2 }BoardLed; typedef enum{ led_on = 0, led_off = 1 }LedStatus; /* #define LED1_PIN GPIO_PIN_9 #define LED1_PORT GPIOF #define LED2_PIN GPIO_PIN_10 #define LED2_PORT GPIOF */ #define LED1_PIN GPIO_PIN_5 #define LED1_PORT GPIOB #define LED2_PIN GPIO_PIN_5 #define LED2_PORT GPIOE int LedDrvInit(BoardLed led); int LedDrvWrite(BoardLed led, LedStatus status); int LedDrvRead(BoardLed led); #endif /* __DRV_LED_H */drv_led.c
#include "drv_led.h" #include "stm32f1xx_hal.h" int LedDrvInit(BoardLed led) { switch(led) { case LED1: { break; } case LED2: { break; } default:break; } return 0; } int LedDrvWrite(BoardLed led, LedStatus status) { switch(led) { case LED1: { HAL_GPIO_WritePin(LED1_PORT, LED1_PIN, (GPIO_PinState)status); break; } case LED2: { HAL_GPIO_WritePin(LED2_PORT, LED2_PIN, (GPIO_PinState)status); break; } default:break; } return 0; } int LedDrvRead(BoardLed led) { LedStatus status = led_on; switch(led) { case LED1: { status = (LedStatus)HAL_GPIO_ReadPin(LED1_PORT, LED1_PIN); break; } case LED2: { status = (LedStatus)HAL_GPIO_ReadPin(LED2_PORT, LED2_PIN); break; } default:break; } return status; } - 添加路径：将drv_led.c添加到所属组， drv_led.h添加到头文件的路径中。
- 添加按键代码：drv_key.h和drv_key.c，方法与LED的一样。drv_key.h
drv_key.c
// #ifndef __DRV_KEY_H 是预处理指令，用于防止头文件的内容在一个编译单元中被多次包含。 // 如果__DRV_KEY_H还没有被定义，则继续处理此头文件的内容；如果已经定义了，则忽略。 #ifndef __DRV_KEY_H #define __DRV_KEY_H // 定义一个名为BoardKey的枚举类型，用于表示不同的按键。 typedef enum{ K1 = 1,// K1键，其值为1 K2, // K2键，其值为2（因为K1为1，所以K2自动为2） K3, K4 }BoardKey; // 定义一个名为KeyStatus的枚举类型，用于表示按键的状态。 typedef enum{ isPressed = 0, // 按键被按下，其值为0 isReleased = 1 // 按键被释放，其值为1 }KeyStatus; // 定义了一系列的宏，用于表示按键对应的GPIO引脚和端口。 // 例如，K1_PIN代表K1键连接的GPIO引脚，而K1_PORT代表该引脚所在的GPIO端口。 #define K1_PIN GPIO_PIN_0 #define K1_PORT GPIOA #define K2_PIN GPIO_PIN_2 #define K2_PORT GPIOE #define K3_PIN GPIO_PIN_3 #define K3_PORT GPIOE #define K4_PIN GPIO_PIN_4 #define K4_PORT GPIOE int KeyDrvInit(BoardKey key);//用于初始化指定的按键。 int KeyDrvRead(BoardKey key);//用于读取指定按键的状态。 #endif /* __DRV_KEY_H */#include "drv_key.h" #include "stm32f1xx_hal.h" int KeyDrvInit(BoardKey key) { switch(key) { case K1: { break; } case K2: { break; } case K3: { break; } case K4: { break; } default:break; } return 0; } int KeyDrvRead(BoardKey key) { KeyStatus status = isReleased; switch(key) { case K1: { status = (KeyStatus)HAL_GPIO_ReadPin(K1_PORT, K1_PIN); break; } case K2: { status = (KeyStatus)HAL_GPIO_ReadPin(K2_PORT, K2_PIN); break; } case K3: { status = (KeyStatus)HAL_GPIO_ReadPin(K3_PORT, K3_PIN); break; } case K4: { status = (KeyStatus)HAL_GPIO_ReadPin(K4_PORT, K4_PIN); break; } default:break; } return status; } - 添加串口代码：drv_uart.h和drv_uart.c，方法与LED的一样。 drv_uart.h
drv_uart.c
// 防止头文件被重复包含，这是一种常见的预处理指令用法，用来确保头文件在一个编译单元中只被包含一次 #ifndef __DRV_UART_H #define __DRV_UART_H // 定义一个枚举类型BoardUart，用来区分不同功能的UART（通用异步收发器） typedef enum{ DbgUart = 1,// 定义一个枚举类型BoardUart，用来区分不同功能的UART（通用异步收发器） WiFiBTUart // WiFi蓝牙UART,后面会介绍WiFi蓝牙 }BoardUart; // 定义宏，将DbgUart映射到具体的USART（通用同步异步收发器）硬件接口，这里映射到USART1 #define DBGUART USART1 #define WiFiUART USART3 int UartDrvInit(BoardUart uart);// 定义宏，将DbgUart映射到具体的USART（通用同步异步收发器）硬件接口，这里映射到USART1 // 声明UartDrvWrite函数，该函数用于向指定的UART接口写入数据，参数pbuf指向要写入的数据，length表示数据长度 int UartDrvWrite(BoardUart uart, unsigned char *pbuf, unsigned short length); // 声明UartDrvRead函数，该函数用于从指定的UART接口读取数据，参数pbuf用于存储读取到的数据，length表示读取的数据长度 int UartDrvRead(BoardUart uart, unsigned char *pbuf, unsigned short length); // 结束头文件防止重复包含的检查 #endif /* __DRV_UART_H */#include "drv_uart.h" #include "usart.h" #include "stm32f1xx_hal.h" int UartDrvInit(BoardUart uart) { switch(uart) { case DbgUart: { break; } case WiFiBTUart: { break; } default:break; } return 0; } int UartDrvWrite(BoardUart uart, unsigned char *pbuf, unsigned short length) { int ret = -1; switch(uart) { case DbgUart: { HAL_StatusTypeDef status = HAL_UART_Transmit(&huart1, pbuf, length, length*5); if(HAL_OK == status) ret = 0; break; } case WiFiBTUart: { break; } default:break; } return ret; } int UartDrvRead(BoardUart uart, unsigned char *pbuf, unsigned short length) { int ret = -1; switch(uart) { case DbgUart: { HAL_StatusTypeDef status = HAL_UART_Receive(&huart1, pbuf, length, length*5); if(HAL_OK == status) ret = 0; break; } case WiFiBTUart: { break; } default:break; } return ret; } - 添加打印重定向代码：printf.h和printf.c，方法与LED的一样。 printf.h
printf.c
#ifndef __PRINTF_H #define __PRINTF_H #ifndef USE_PRINTF #define USE_PRINTF (1) #endif /* USE_PRINTF */ #if USE_PRINTF #include <stdio.h> #define xprintf(...) printf(__VA_ARGS__) #else #define xprintf(...) #endif /* USE_PRINTF */ #endif /* __PRINTF_H */#include "drv_uart.h" #include <stdio.h> struct __FILE{ int handle; }; FILE __stdout; int fputc(int ch, FILE *f) { (void)f; int ret = UartDrvWrite(DbgUart, (unsigned char*)&ch, 1); if(0 == ret) return ch; return 0; } - 在main.c添加代码：添加头文件
#include "drv_led.h" #include "drv_key.h" #include "drv_uart.h" #include "printf.h" #include <string.h>
/* USER CODE BEGIN 2 */ LedStatus d1_s = led_off; //灯状态 LedStatus d2_s = led_off; LedDrvInit(LED1); LedDrvInit(LED2); KeyDrvInit(K3); KeyDrvInit(K4); UartDrvInit(DbgUart); /* USER CODE END 2 */ /* Infinite loop */ /* USER CODE BEGIN WHILE */ while (1) { /* USER CODE END WHILE */ /* USER CODE BEGIN 3 */ if(KeyDrvRead(K4) == isPressed)/* 检测按键的状态 */ { HAL_Delay(100);/* 消抖处理 */ if(KeyDrvRead(K4) == isPressed) { d1_s =!d1_s; /* 切换LED1状态 */ if(d1_s) { LedDrvWrite(LED1, d1_s); /* 更新LED1的显示状态 */ UartDrvWrite(DbgUart,(unsigned char *)"KEY1 is Pressed,LED1 is Off\r\n", strlen("KEY1 is Pressed,LED1 is Off\r\n")); } else { LedDrvWrite(LED1, d1_s); /* 更新LED1的显示状态 */ UartDrvWrite(DbgUart,(unsigned char *)"KEY1 is Pressed,LED is On\r\n", strlen("KEY1 is Pressed,LED1 is On\r\n")); } } } if(KeyDrvRead(K3) == isPressed) /* 检测按键的状态 */ { HAL_Delay(100);/* 消抖处理 */ if(KeyDrvRead(K3) == isPressed) { d2_s =!d2_s;/* 切换LED1状态 */ if(d2_s) { LedDrvWrite(LED2, d2_s);/* 检测按键的状态 */ UartDrvWrite(DbgUart,(unsigned char *)"KEY2 is Pressed,LED2 is Off\r\n", strlen("KEY2 is Pressed,LED2 is Off\r\n")); } else { LedDrvWrite(LED2, d2_s);/* 检测按键的状态 */ UartDrvWrite(DbgUart,(unsigned char *)"KEY2 is Pressed,LED2 is On\r\n", strlen("KEY2 is Pressed,LED2 is On\r\n")); } } } } /* USER CODE END 3 */ - 编译代码：Keil编译生成的代码。
-
烧录程序：将编译好的程序用ST-LINK烧录到STM32微控制器中。
四、运行结果
观察结果：一旦程序烧录完成并运行，你应该能看到按不同的按键会点亮不同的LED灯，串口打印按键和灯的状态。如果一切正常，恭喜你，你现在已经是一个掌握模块化的编写“点灯大师”了！
五、总结
模块化的编写方式对之前的代码封装了一层，提供了与LED、按键、串口硬件交互的接口，使得软件开发者可以在不直接操作硬件的情况下控制LED灯、按键、串口，将STM32F1（LED灯、按键、串口）的代码直接用到STM32F407、STM32H系列等中，如果引脚不一样，只需修改引脚即可。通过上面的代码，希望你更多的采用模块化的编写方式，确保代码结构清晰、功能明确，提高可读性和可维护性，降低功能耦合，增强重用和扩展性，也促进并行开发（比如A员工做LED灯、B员工做按键、C员工做串口），提升效率，便于项目管理和维护。
六、注意事项
1.确保你的开发环境和工具链已经正确安装和配置。
2.在STM32CubeMX中配置GPIO时，注意选择正确的引脚和模式。
3.在编写代码时，确保使用正确的GPIO端口和引脚宏定义。
4.LED没有按预期点亮，按一下复位键，检查代码、连接和电源是否正确。
6.串口没有打印，检查代码、连接、电源、波特率是否正确，串口是否打开。
七、预告
后面将将LED、按键、串口封装成一个GPIO类，直接3归1，敬请关注！
1836
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
