IDF 组件管理器

IDF 组件管理器用于从 ESP 组件注册表 或 Git 仓库添加和管理 ESP-IDF 第三方组件（如按键驱动、显示屏驱动、传感器驱动或协议栈）。它集成在 ESP-IDF 构建系统中，无需手动下载、复制或在 CMake 中手工接入组件。

---

工作原理

运行 idf.py build 或 idf.py reconfigure 时，构建系统会：

1. 读取各组件目录下的 idf_component.yml 清单文件。
2. 将依赖下载到项目根目录的 managed_components/ 文件夹。
3. 生成 dependencies.lock，锁定已解析的版本，保证可重复构建。

---

清单文件：idf_component.yml

在组件目录（含 main）中创建 idf_component.yml 以声明依赖：

dependencies:
  # 来自 ESP 组件注册表
  espressif/button: "^2.5.0"

  # 来自 Git 仓库
  some_custom_lib:
    git: "https://github.com/user/custom-repo.git"
    path: "sub_directory/my_component"

  # 最低 ESP-IDF 版本
  idf: ">=5.0"

[!NOTE] managed_components/ 目录由工具自动管理，请勿手动修改其中的文件。 执行 idf.py clean 或更新依赖时，手动修改会被覆盖。

---

常用命令

组件管理器已集成在 idf.py 中。

添加依赖

# 为 main 添加依赖
idf.py add-dependency "espressif/button^2.5.0"

# 为自定义组件添加依赖
idf.py add-dependency --component=my_sensor "espressif/button^2.5.0"

创建清单模板

idf.py create-manifest
idf.py create-manifest --component=my_sensor

解析与更新依赖

idf.py reconfigure
idf.py update-dependencies

---

进阶说明

[!NOTE] 私有组件依赖、依赖冲突处理、离线缓存配置及向 ESP 组件注册表发布组件等内容，请参阅 ESP 组件管理和使用说明。