ESP-IDF Kconfig文件配置
IDF开发环境的工程目录下,有一个sdkconfig文件,这个文件中包含了一些预设的参数,可以通过menuconfig进行可视化调节参数,十分方便。但是如果我们要修改这个文件,会发现编译的时候,我们修改的文件会被编译器改写,因此,下面就教大家如何修改Kconfig文件。
1.建立Kconfig.projbuild文件
在工程的main路径中建立Kconfig.projbuild文本文件
2.改写Kconfig文件
这里是Kconfig文件格式的介绍
下面是一个I2C自定义组件里的例子,在Kconfig中增加关于I2C总线SCL引脚的定义:
menu "Example Configuration"
menu "I2C Master"
config I2C_MASTER_SCL
int "SCL GPIO Num"
default 6 if IDF_TARGET_ESP32C3
default 19 if IDF_TARGET_ESP32 || IDF_TARGET_ESP32S2 || IDF_TARGET_ESP32S3
help
GPIO number for I2C Master clock line.
menu "I2C Master"是生成菜单的名字,内部包含N个关键字或者配置选项,可以进行嵌套,时间效果如下图:
config是关键字,表示一组配置选项的开始,内部包含N个配置选项
int "SCL GPIO Num"这个为所配置选项的名称,前面跟该变量的数据类型。
default 跟该条目的初始变量值,可用if进行预值判断。
help就是在UI界面中,点击问号,会出现的文本,给用户做配置选项的说明。
实际的最后配置界面中,就会出现这样子的目录结构:
具体的Kconfig语言还有很多其他的语法,它使我们可以使用menuconfig时能快速配置各个选项,十分方便,其他的写法可以举一反三。
修改完Kconfig,projbuild文件后,点击保存,进入下一步。
3.清空工程(Full Clean)并编译
猴急的小伙伴修改完肯定迫不及待地点了编译,这时候你会发现,你的Kconfig文件还是没有任何更改,因为编译器二次编译的检索文件更新,检测不到我们新增的Kconfig.projbuild,因此我们需要点击VSCODE下方的垃圾桶图标(也可用idf.py的clean命令):
然后再点击右侧的编译,等待漫长的编译过程后,再点击下方的menuconfig的齿轮图标,可以看到成果了:
4.CONFIG变量使用
配置完可视化界面修改变量后,我们要怎么使用这个变量呢?
这个时候,这个CONFIG变量已经转换成了常量,只能读取,不能进行修改,因此我们可以很方便地进行操作。
首先在我们之前定义的CONFIG变量名前加上前缀CONFIG_,这个是编译器帮我们加的,具体的变量可以在sdkconfig文件中找到:
可以发现我们使用的是IDF_TARGET_ESP32平台,因此编译器将此数值定义为了19。
我们可以使用#define关键字,将改预定义变量,与实际程序中的接口变量进行替换:
当然也可以直接将该常量赋值给其他的变量: