基于ESP-IDF多组件创建ESP32静态库找不到头文件如何解决？

问题根源 #

你修改根目录CMakeLists.txt手动添加add_library的方式完全不符合ESP-IDF构建系统的设计逻辑，会破坏原有构建链：

• 你手动定义的MyStaticLib没有关联my_component的头文件路径（components/my_component/include），也没有继承esp-dsp、ESP-IDF内置组件的头文件和编译参数，必然会出现头文件找不到的报错，即便手动补全头文件路径，后续也会出现依赖库找不到、编译参数不匹配等更多问题。
• ESP-IDF的构建系统会自动为所有通过idf_component_register注册的组件生成静态库，完全不需要你手动写add_library逻辑。

正确操作步骤 #

1. 回滚根目录CMakeLists.txt到你修改前的原始版本，删除你额外添加的add_library、add_executable、target_link_libraries相关代码。
2. 正常执行idf.py build编译项目，编译成功后即可在构建目录下找到自动生成的静态库：
   • 自定义组件的静态库路径：build/esp-idf/my_component/libmy_component.a
   • 依赖的esp-dsp组件静态库路径：build/esp-idf/esp-dsp/libesp-dsp.a
3. 其他项目使用该静态库的配置方法：
   如果你需要把编译好的静态库给其他ESP-IDF项目使用，按照如下结构创建预编译组件即可：

   my_lib_component/
   ├─ CMakeLists.txt
   ├─ libmy_component.a
   ├─ libesp-dsp.a
   └─ include/
      └─ my_component.h
   

   组件内的CMakeLists.txt配置如下：

   idf_component_register(
       INCLUDE_DIRS "include"
       # 如果使用静态库的项目已经单独集成了esp-dsp，这里可以去掉esp-dsp依赖
       REQUIRES esp-dsp
   )
   
   add_prebuilt_library(my_component_prebuilt libmy_component.a
       PRIV_REQUIRES ${COMPONENT_REQUIRES}
   )
   target_link_libraries(${COMPONENT_LIB} INTERFACE my_component_prebuilt)
   

注意事项 #

• 静态库编译时使用的ESP-IDF版本、sdkconfig配置需要和使用该库的项目保持一致，否则可能出现兼容性问题。
• 最优交付方案是直接把my_component整个组件目录提供给其他项目使用，ESP-IDF会自动处理编译和依赖逻辑，不需要提前编译静态库。

内容的提问来源于stack exchange，提问作者JulienWeber