项目简介
本项目是专为STM32软件开发者打造的C++实用工具库,目的是简化STM32开发流程,提供高效开发工具与测试框架。借助该库,开发者能快速生成API文档、编写并运行单元测试,还能开展GPIO配置测试,提升代码质量与开发效率。
项目的主要特性和功能
- API文档生成:用简单命令可生成详细API文档,助于开发者理解和使用库函数。
- 单元测试框架:提供完整单元测试系统,支持在主机上编译和运行测试用例,保障代码可靠性与正确性。
- GPIO配置测试:针对STM32微控制器的GPIO进行详细配置测试,确保GPIO模式和寄存器配置正确。
- 其他实用工具:包含用于开发STM32项目的其他实用功能,如正则表达式的输入过滤器。
安装使用步骤
前提条件
已下载本项目的源码文件。
具体步骤
- 安装依赖:确保已安装必要的依赖库和工具,如Doxygen(用于API文档生成)和CppUTest(用于单元测试)。
- 生成API文档:运行以下命令生成API文档:
bash scons api-doc
- 生成单元测试运行器:运行以下命令生成单元测试运行器(需指定
STDPERIPH_BASEDIR
和CMSIS_BASEDIR
路径):bash scons unit-test STDPERIPH_BASEDIR=<path> CMSIS_BASEDIR=<path>
若项目嵌入在cortex-libs
骨架中,则无需指定路径。 - 运行单元测试:找到生成的测试运行器并执行,例如:
bash ./build/test/unit/STM32F10X_MD/run_tests
- 测试GPIO配置:根据项目提供的指导,编写和运行GPIO配置测试用例。
注意事项
- 确保开发环境已正确配置,且安装了所有必要的依赖库和工具。
- 使用API文档生成工具和单元测试系统时,遵循项目的指导和使用说明。
- 对于特定模块的使用,如GPIO配置测试,确保STM32微控制器型号与项目支持的型号相匹配。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】