ESP-IoT-Solution 包含物联网系统开发中常用的外设驱动和代码框架，提供了 ESP-IDF 的扩展组件，方便用户实现更简单的开发。
ESP-IoT-Solution 包含的内容如下:
- 传感器、显示屏、音频设备、输入设备、电机控制等设备驱动；
- 低功耗、安全加密、存储方案等代码框架或说明文档；
- 从实际应用的角度出发，为乐鑫开源解决方案提供了入口指引。
- 中文：https://docs.espressif.com/projects/esp-iot-solution/zh_CN
- English: https://docs.espressif.com/projects/esp-iot-solution/en
自 release/v2.0 起，ESP-IoT-Solution 采用组件化管理，各组件与示例独立迭代，不再绑定仓库分支。具体依赖的 ESP-IDF 版本请查阅组件 idf_component.yml 文件中的声明。Release 分支仅用于维护组件的历史大版本，例如 button v3.x 版本在 release/v2.0 分支中维护，master 分支中维护最新的 button 版本（例如 v4.x）。
| ESP-IoT-Solution | 依赖的 ESP-IDF | 主要变更 | 文档 | 支持状态 |
|---|---|---|---|---|
| master | >= v5.3 | 新芯片支持 | Docs online | 新功能开发分支 |
| release/v2.0 | <= v5.3, >= v4.4 | 支持组件管理器 | Docs online | 仅限组件历史版本 Bugfix，维护到 v5.3 EOL |
| release/v1.1 | v4.0.1 | IDF 版本更新，删除已经移动到其它仓库的代码 | v1.1 Overview | 备份，停止维护 |
| release/v1.0 | v3.2.2 | 历史版本 | v1.0 Overview | 备份，停止维护 |
Note
不同芯片推荐的 ESP-IDF 首选版本也不同，具体可参考 ESP-IDF 版本与乐鑫芯片版本兼容性。
您可以选择任意 ESP 系列开发板使用 ESP-IoT-Solution，或者选择esp-bsp中支持的开发板快速开始。
ESP 系列 SoC 采用先进工艺制程，提供业界领先的射频性能、低功耗特性和稳定可靠性，适用于物联网、工业控制、智能家居、可穿戴设备等多种应用场景。各系列芯片的具体规格和功能请参考 ESP 产品选型工具。
请参考 ESP-IDF 详细安装步骤 先完成 ESP-IDF 开发环境的搭建。
如果您只想使用 ESP-IoT-Solution 中的组件，我们建议您从 ESP 组件注册表 ESP Component Registry 中使用它。
可以在项目根目录下使用 idf.py add-dependency 命令直接将组件从 Component Registry 添加到项目中。例如，执行 idf.py add-dependency "espressif/button" 命令添加 button，该组件将在 CMake 步骤中自动下载。
请参考 IDF Component Manager 查看更多关于组件管理器的细节.
ESP-IoT-Solution 中注册的组件如下:
如果您想为 ESP-IoT-Solution 中的组件或示例贡献代码，或者想基于 ESP-IoT-Solution 中的示例开发项目，您可以通过以下步骤下载 ESP-IoT-Solution 代码仓库:
-
如果选择
master版本，可使用以下指令获取代码：git clone --recursive https://github.com/espressif/esp-iot-solution -
如果选择
release/v2.0版本，可使用以下指令获取代码：git clone -b release/v2.0 --recursive https://github.com/espressif/esp-iot-solution
我们强烈建议您 构建您的第一个项目 以熟悉 ESP-IDF 并确保环境已经设置正确。
在 ESP-IoT-Solution 和 ESP-IDF 中构建和烧录示例没有区别。 在大多数情况下，您可以按照以下步骤在 ESP-IoT-Solution 中构建和烧录示例：
- 将当前目录更改为示例目录，例如
cd examples/usb/host/usb_audio_player； - 运行
idf.py set-target TARGET设置目标芯片。 例如idf.py set-target esp32s3将目标芯片设置为ESP32-S3； - 运行
idf.py build来构建示例； - 运行
idf.py -p PORT flash monitor烧录示例，并查看串口输出。 例如idf.py -p /dev/ttyUSB0 flash monitor将示例烧录到/dev/ttyUSB0端口，并打开串口监视器。
某些示例可能需要额外的步骤来设置
ESP-IoT-Solution环境变量，您可以在 Linux/MacOS 中运行export IOT_SOLUTION_PATH=~/esp/esp-iot-solution或set IOT_SOLUTION_PATH=C:\esp\esp- iot-solution在 Windows 中设置环境。
- 最新版的文档：https://docs.espressif.com/projects/esp-iot-solution/zh_CN ，该文档是由本仓库 docs 目录 构建得到；
- ESP-IDF 编程指南 https://docs.espressif.com/projects/esp-idf/zh_CN ，请参考 ESP-IoT-Solution 依赖的版本；
- 可以在 ESP Component Registry中找到
ESP-IoT-Solution中的组件和其他已注册的组件; - 可以前往 esp32.com 论坛 提问，挖掘社区资源；
- 如果你在使用中发现了错误或者需要新的功能，请先查看 GitHub Issues，确保该问题不会被重复提交；
- 如果你有兴趣为 ESP-IoT-Solution 作贡献，请先阅读贡献指南。