Cmakelist.txt入门(基于ESP-IDF)

主要参考资料:
乐鑫官网资料链接: https://docs.espressif.com/projects/esp-idf/zh_CN/v5.1/esp32s3/api-guides/build-system.html
Cmake Cookbook链接: https://www.bookstack.cn/read/CMake-Cookbook/README.md
Cmake官网链接: https://cmake.org

idf.py 已经封装了 CMake 命令,因此我们仅需要配置好Cmakelist.txt文件,而在Cmakelist.txt中开发者只需要管理好component就可以.
下面两句话是总结
项目Cmakelist.txt用于新增额外的components目录
组件Cmakelist.txt用于构建一个完整的componets

项目Cmakelist.txt(位于工程目录下)

components相关命令
1.set()命令用于将普通、缓存或环境变量设置为定值.
如set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common),这是新增加了一个组件,默认Cmake会去 IDF_PATH/components、 PROJECT_DIR/components、和 EXTRA_COMPONENT_DIRS下搜索组件.
要注意的是,set() 命令需放在 include(…) 之前,cmake_minimum(…) 之后。

其他命令
(1~3是必要的命令)
1.cmake_minimum_required(VERSION 3.16) 必须放在 CMakeLists.txt 文件的第一行,它会告诉 CMake 构建该项目所需要的最小版本号。ESP-IDF 支持 CMake 3.16 或更高的版本。
2.include($ENV{IDF_PATH}/tools/cmake/project.cmake) 会导入 CMake 的其余功能来完成配置项目、检索组件等任务。
3.project(myProject) 会创建项目本身,并指定项目名称。该名称会作为最终输出的二进制文件的名字,即 myProject.elf 和 myProject.bin。每个 CMakeLists 文件只能定义一个项目。

组件Cmakelist.txt(位于component或者main目录下)

components相关命令
1.有时main目录下会有多个文件夹,每个文件夹里会有多个SRC目录 或者一个目录下有多个SRC文件,可以使用file(GLOB_RECURSE SOURCES xxx/.c xxx/.c)将源文件打包,在idf_component_register使用${SOURCES}调用过来。比较典型的有lvgl组件。
2.idf_component_register命令用于构建components
参数
SRCS填写需要的.c文件
SRC_DIRS填写需要的.c文件所在目录
INCLUDE_DIRS填写需要的.h文件所在目录
REQUIRES填写依赖的其他components
3.add_library()用来添加一个库文件(静态库或动态库)
参数
name表示库文件的名称,可以包含路径信息;
STATIC、SHARED 和 MODULE 表示库文件的类型,分别表示静态库、动态库和可加载模块;CMake 会自动根据库文件的类型来选择正确的编译方式。
EXCLUDE_FROM_ALL 表示该库不会被默认构建,需要手动指定构建。
source库文件可以是一个或多个,这些源文件可以是编译后的二进制文件(例如 .o 文件),也可以是源代码文件。
4.target_link_libraries()作用是将库文件与目标文件进行链接,使得目标文件可以使用库文件中定义的函数和变量。
参数
target 表示要链接库文件的目标文件(可执行文件或库文件);只能由add_library()生成
PRIVATE 表示链接库文件时只在当前目标中使用;PUBLIC 链接库文件时既在当前目标中使用也在该目标的依赖目标中使用,链接属性默认为 PUBLIC;INTERFACE 仅在该目标的依赖目标中使用;
library 表示要链接的库文件的名称
一般add_library()与target_link_libraries()配合使用

其他命令
1.比如spiffs_create_partition_image(storage …/spiffs FLASH_IN_PROJECT)是提示将…/spiffs下的比如mp3或者图片文件烧录进flash中

  • 1
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值