小智机器人CMakeLists编译文件解析

在这里插入图片描述
编译完成后，成功烧录！

这段代码是一个CMake脚本，用于配置和构建一个嵌入式项目，特别是针对ESP32系列芯片的项目。CMake是一个跨平台的构建系统，用于管理项目的编译过程。

set(SOURCES "audio_codecs/audio_codec.cc""audio_codecs/no_audio_codec.cc""audio_codecs/box_audio_codec.cc""audio_codecs/es8311_audio_codec.cc""audio_codecs/es8388_audio_codec.cc""audio_codecs/cores3_audio_codec.cc""audio_codecs/tcircles3_audio_codec.cc""led/single_led.cc""led/circular_strip.cc""display/display.cc""display/no_display.cc""display/lcd_display.cc""display/ssd1306_display.cc""boards/lilygo-t-circle-s3/esp_lcd_gc9d01n.c""protocols/protocol.cc""iot/thing.cc""iot/thing_manager.cc""system_info.cc""application.cc""ota.cc""settings.cc""background_task.cc""main.cc")set(INCLUDE_DIRS "." "display" "audio_codecs" "protocols" "audio_processing")# 添加 IOT 相关文件
file(GLOB IOT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/iot/things/*.cc)
list(APPEND SOURCES ${IOT_SOURCES})# 添加板级公共文件
file(GLOB BOARD_COMMON_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/boards/common/*.cc)
list(APPEND SOURCES ${BOARD_COMMON_SOURCES})
list(APPEND INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/boards/common)# 根据 BOARD_TYPE 配置添加对应的板级文件
if(CONFIG_BOARD_TYPE_BREAD_COMPACT_WIFI)set(BOARD_TYPE "bread-compact-wifi")
elseif(CONFIG_BOARD_TYPE_BREAD_COMPACT_ML307)set(BOARD_TYPE "bread-compact-ml307")
elseif(CONFIG_BOARD_TYPE_BREAD_COMPACT_ESP32)set(BOARD_TYPE "bread-compact-esp32")    
elseif(CONFIG_BOARD_TYPE_ESP_BOX_3)set(BOARD_TYPE "esp-box-3")
elseif(CONFIG_BOARD_TYPE_KEVIN_BOX_1)set(BOARD_TYPE "kevin-box-1")
elseif(CONFIG_BOARD_TYPE_KEVIN_BOX_2)set(BOARD_TYPE "kevin-box-2")
elseif(CONFIG_BOARD_TYPE_KEVIN_C3)set(BOARD_TYPE "kevin-c3") 
elseif(CONFIG_BOARD_TYPE_KEVIN_SP_V3_DEV)set(BOARD_TYPE "kevin-sp-v3-dev")
elseif(CONFIG_BOARD_TYPE_LICHUANG_DEV)set(BOARD_TYPE "lichuang-dev")
elseif(CONFIG_BOARD_TYPE_LICHUANG_C3_DEV)set(BOARD_TYPE "lichuang-c3-dev")
elseif(CONFIG_BOARD_TYPE_MAGICLICK_2P4)set(BOARD_TYPE "magiclick-2p4")
elseif(CONFIG_BOARD_TYPE_MAGICLICK_C3)set(BOARD_TYPE "magiclick-c3")
elseif(CONFIG_BOARD_TYPE_M5STACK_CORE_S3)set(BOARD_TYPE "m5stack-core-s3")
elseif(CONFIG_BOARD_TYPE_ATOMS3_ECHO_BASE)set(BOARD_TYPE "atoms3-echo-base")
elseif(CONFIG_BOARD_TYPE_ATOMS3R_ECHO_BASE)set(BOARD_TYPE "atoms3r-echo-base")
elseif(CONFIG_BOARD_TYPE_ATOMMATRIX_ECHO_BASE)set(BOARD_TYPE "atommatrix-echo-base") 
elseif(CONFIG_BOARD_TYPE_XMINI_C3)set(BOARD_TYPE "xmini-c3")
elseif(CONFIG_BOARD_TYPE_ESP32S3_KORVO2_V3)set(BOARD_TYPE "esp32s3-korvo2-v3")
elseif(CONFIG_BOARD_TYPE_ESP_SPARKBOT)set(BOARD_TYPE "esp-sparkbot")    
elseif(CONFIG_BOARD_TYPE_ESP32S3_Touch_AMOLED_1_8)set(BOARD_TYPE "esp32-s3-touch-amoled-1.8")
elseif(CONFIG_BOARD_TYPE_ESP32S3_Touch_LCD_1_85C)set(BOARD_TYPE "esp32-s3-touch-lcd-1.85c")
elseif(CONFIG_BOARD_TYPE_ESP32S3_Touch_LCD_1_85)set(BOARD_TYPE "esp32-s3-touch-lcd-1.85")
elseif(CONFIG_BOARD_TYPE_ESP32S3_Touch_LCD_1_46)set(BOARD_TYPE "esp32-s3-touch-lcd-1.46")
elseif(CONFIG_BOARD_TYPE_BREAD_COMPACT_WIFI_LCD)set(BOARD_TYPE "bread-compact-wifi-lcd")    
elseif(CONFIG_BOARD_TYPE_TUDOUZI)set(BOARD_TYPE "tudouzi") 
elseif(CONFIG_BOARD_TYPE_LILYGO_T_CIRCLE_S3)set(BOARD_TYPE "lilygo-t-circle-s3") 
elseif(CONFIG_BOARD_TYPE_MOVECALL_MOJI_ESP32S3)set(BOARD_TYPE "movecall-moji-esp32s3") 
elseif(CONFIG_BOARD_TYPE_ATK_DNESP32S3)set(BOARD_TYPE "atk-dnesp32s3")
elseif(CONFIG_BOARD_TYPE_ATK_DNESP32S3_BOX)set(BOARD_TYPE "atk-dnesp32s3-box") 
elseif(CONFIG_BOARD_TYPE_DU_CHATX)set(BOARD_TYPE "du-chatx")     
elseif(CONFIG_BOARD_TYPE_ESP32S3_Taiji_Pi)set(BOARD_TYPE "taiji-pi-s3")
elseif(CONFIG_BOARD_TYPE_XINGZHI_Cube_OLED)set(BOARD_TYPE "xingzhi-cube-oled")
elseif(CONFIG_BOARD_TYPE_XINGZHI_Cube_TFT)set(BOARD_TYPE "xingzhi-cube-tft")
endif()
file(GLOB BOARD_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/boards/${BOARD_TYPE}/*.cc)
list(APPEND SOURCES ${BOARD_SOURCES})if(CONFIG_CONNECTION_TYPE_MQTT_UDP)list(APPEND SOURCES "protocols/mqtt_protocol.cc")
elseif(CONFIG_CONNECTION_TYPE_WEBSOCKET)list(APPEND SOURCES "protocols/websocket_protocol.cc")
endif()if(CONFIG_USE_AUDIO_PROCESSING)list(APPEND SOURCES "audio_processing/audio_processor.cc" "audio_processing/wake_word_detect.cc")
endif()# 根据Kconfig选择语言目录
if(CONFIG_LANGUAGE_ZH_CN)set(LANG_DIR "zh-CN")
elseif(CONFIG_LANGUAGE_EN_US)set(LANG_DIR "en-US")
endif()# 定义生成路径
set(LANG_JSON "${CMAKE_CURRENT_SOURCE_DIR}/assets/${LANG_DIR}/language.json")
set(LANG_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/assets/lang_config.h")
file(GLOB ASSETS ${CMAKE_CURRENT_SOURCE_DIR}/assets/${LANG_DIR}/*.p3)# 如果目标芯片是 ESP32，则排除特定文件
if(CONFIG_IDF_TARGET_ESP32)# 排除 "audio_codecs/box_audio_codec.cc" 和 "audio_codecs/cores3_audio_codec.cc"list(REMOVE_ITEM SOURCES "audio_codecs/box_audio_codec.cc""audio_codecs/cores3_audio_codec.cc""audio_codecs/es8388_audio_codec.cc")
endif()idf_component_register(SRCS ${SOURCES}EMBED_FILES ${ASSETS}INCLUDE_DIRS ${INCLUDE_DIRS}WHOLE_ARCHIVE)# 使用 target_compile_definitions 来定义 BOARD_TYPE
target_compile_definitions(${COMPONENT_LIB}PRIVATE BOARD_TYPE=\"${BOARD_TYPE}\")# 添加生成规则
add_custom_command(OUTPUT ${LANG_HEADER}COMMAND python3 ${PROJECT_DIR}/scripts/gen_lang.py--input "${LANG_JSON}"--output "${LANG_HEADER}"DEPENDS ${LANG_JSON}${PROJECT_DIR}/scripts/gen_lang.pyCOMMENT "Generating ${LANG_DIR} language config"
)# 强制建立生成依赖
add_custom_target(lang_header ALLDEPENDS ${LANG_HEADER}
)

以下是对代码的详细解释：

1. 设置源文件列表

set(SOURCES "audio_codecs/audio_codec.cc""audio_codecs/no_audio_codec.cc""audio_codecs/box_audio_codec.cc""audio_codecs/es8311_audio_codec.cc""audio_codecs/es8388_audio_codec.cc""audio_codecs/cores3_audio_codec.cc""audio_codecs/tcircles3_audio_codec.cc""led/single_led.cc""led/circular_strip.cc""display/display.cc""display/no_display.cc""display/lcd_display.cc""display/ssd1306_display.cc""boards/lilygo-t-circle-s3/esp_lcd_gc9d01n.c""protocols/protocol.cc""iot/thing.cc""iot/thing_manager.cc""system_info.cc""application.cc""ota.cc""settings.cc""background_task.cc""main.cc")

这里定义了一个变量 SOURCES，它包含了项目中所有的C/C++源文件路径。这些文件包括音频编解码器、LED控制、显示控制、协议处理、IoT设备管理、系统信息、应用程序逻辑等。

2. 设置包含目录

set(INCLUDE_DIRS "." "display" "audio_codecs" "protocols" "audio_processing")

INCLUDE_DIRS 变量定义了编译器在查找头文件时应该搜索的目录。

3. 添加IoT相关文件

file(GLOB IOT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/iot/things/*.cc)
list(APPEND SOURCES ${IOT_SOURCES})

使用 file(GLOB ...) 命令将 iot/things/ 目录下的所有 .cc 文件添加到 SOURCES 列表中。

4. 添加板级公共文件

file(GLOB BOARD_COMMON_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/boards/common/*.cc)
list(APPEND SOURCES ${BOARD_COMMON_SOURCES})
list(APPEND INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/boards/common)

将 boards/common/ 目录下的所有 .cc 文件添加到 SOURCES 列表中，并将该目录添加到 INCLUDE_DIRS 中。

5. 根据 `BOARD_TYPE` 配置添加对应的板级文件

if(CONFIG_BOARD_TYPE_BREAD_COMPACT_WIFI)set(BOARD_TYPE "bread-compact-wifi")
elseif(CONFIG_BOARD_TYPE_BREAD_COMPACT_ML307)set(BOARD_TYPE "bread-compact-ml307")
...
endif()
file(GLOB BOARD_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/boards/${BOARD_TYPE}/*.cc)
list(APPEND SOURCES ${BOARD_SOURCES})

根据 CONFIG_BOARD_TYPE_* 的配置，设置 BOARD_TYPE 变量，并将对应板级目录下的 .cc 文件添加到 SOURCES 列表中。

6. 根据连接类型添加协议文件

if(CONFIG_CONNECTION_TYPE_MQTT_UDP)list(APPEND SOURCES "protocols/mqtt_protocol.cc")
elseif(CONFIG_CONNECTION_TYPE_WEBSOCKET)list(APPEND SOURCES "protocols/websocket_protocol.cc")
endif()

根据连接类型（MQTT或WebSocket），将相应的协议实现文件添加到 SOURCES 列表中。

7. 根据音频处理配置添加文件

if(CONFIG_USE_AUDIO_PROCESSING)list(APPEND SOURCES "audio_processing/audio_processor.cc" "audio_processing/wake_word_detect.cc")
endif()

如果启用了音频处理，将音频处理相关的源文件添加到 SOURCES 列表中。

8. 根据语言配置设置语言目录

if(CONFIG_LANGUAGE_ZH_CN)set(LANG_DIR "zh-CN")
elseif(CONFIG_LANGUAGE_EN_US)set(LANG_DIR "en-US")
endif()

根据语言配置（中文或英文），设置 LANG_DIR 变量。

9. 定义生成路径

set(LANG_JSON "${CMAKE_CURRENT_SOURCE_DIR}/assets/${LANG_DIR}/language.json")
set(LANG_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/assets/lang_config.h")
file(GLOB ASSETS ${CMAKE_CURRENT_SOURCE_DIR}/assets/${LANG_DIR}/*.p3)

定义语言配置文件和生成的头文件路径，并收集语言资源文件。

10. 排除特定文件（针对ESP32芯片）

if(CONFIG_IDF_TARGET_ESP32)list(REMOVE_ITEM SOURCES "audio_codecs/box_audio_codec.cc""audio_codecs/cores3_audio_codec.cc""audio_codecs/es8388_audio_codec.cc")
endif()

如果目标芯片是ESP32，排除不兼容的音频编解码器文件。

11. 注册组件

idf_component_register(SRCS ${SOURCES}EMBED_FILES ${ASSETS}INCLUDE_DIRS ${INCLUDE_DIRS}WHOLE_ARCHIVE)

使用 idf_component_register 函数注册组件，指定源文件、嵌入的资源文件、包含目录等。

12. 定义编译宏

target_compile_definitions(${COMPONENT_LIB}PRIVATE BOARD_TYPE=\"${BOARD_TYPE}\")

为组件库定义编译宏 BOARD_TYPE，以便在代码中使用。这行代码的作用是为 ${COMPONENT_LIB} 目标添加一个编译定义 BOARD_TYPE，其值是 ${BOARD_TYPE} 变量的内容。

13. 添加自定义命令生成语言配置文件

add_custom_command(OUTPUT ${LANG_HEADER}COMMAND python3 ${PROJECT_DIR}/scripts/gen_lang.py--input "${LANG_JSON}"--output "${LANG_HEADER}"DEPENDS ${LANG_JSON}${PROJECT_DIR}/scripts/gen_lang.pyCOMMENT "Generating ${LANG_DIR} language config"
)

定义一个自定义命令，使用Python脚本 gen_lang.py 从 language.json 生成 lang_config.h 头文件。

14. 强制建立生成依赖

add_custom_target(lang_header ALLDEPENDS ${LANG_HEADER}
)

创建一个自定义目标 lang_header，确保在构建时生成语言配置文件。

总结

这段CMake脚本主要用于配置和构建一个嵌入式项目，特别是针对ESP32系列芯片。它根据不同的配置选项（如板级类型、连接类型、语言等）动态地添加或排除源文件，并生成必要的配置文件。通过这种方式，项目可以灵活地适应不同的硬件和功能需求。