esp-idf

ESP-IDF（乐鑫物联网开发框架）是乐鑫SoC的官方开发框架，支持Windows、Linux和macOS。它针对乐鑫芯片；2016年之前发布的SoC（ESP8266和ESP8285）则由独立的RTOS SDK支持。 该仓库记录了发布支持计划、生命周期终止建议以及ESP-IDF版本与芯片修订版之间的兼容性。每个SoC系列和每个ESP-IDF版本都有各自的文档，README指向在线文档的“版本”部分，以查找文档并检出特定版本。 入门需要安装主机构建依赖，运行安装脚本（Windows上为install.bat或install.ps1；Unix shell上为install.sh或install.fish），然后在每个shell中导出环境（Windows上为export.bat，Unix上为source export.sh），之后才能使用ESP-IDF。提供了模板项目（esp-idf-template）和examples目录中的一组示例项目；要从示例开始新项目，需将示例目录复制到ESP-IDF树之外。 主要工作流程使用idf.py命令行工具。`idf.py set-target <chip_name>`选择目标芯片，`idf.py menuconfig`打开基于文本的配置菜单。`idf.py build`编译应用程序和引导加载程序，并根据配置生成分区表。烧录使用`idf.py -p PORT flash`，它将应用程序、引导加载程序和分区表写入新芯片，并自动重建任何需要重建的内容；如果省略端口选项，它会尝试第一个可用的串行端口。串行输出通过`idf.py monitor`查看，该命令使用esp-idf-monitor工具，可以解码崩溃输出并与设备交互；按Ctrl-]退出。`idf.py flash monitor`将构建、烧录和监控合并为一步。对于迭代工作，`idf.py app`仅构建应用程序，`idf.py app-flash`仅烧录应用程序，并在源文件更改时自动重建。`idf.py erase-flash`擦除整个闪存，适用于分区表更改或OTA更新，并可与其他目标组合使用。 对于非GitHub分支，README指出子模块URL是相对的并链接到GitHub；脚本tools/set-submodules-to-github.sh设置绝对URL，以便`git submodule update --init --recursive`能够完成。从GitHub克隆时无需此步骤。 资源包括从docs目录构建的在线文档、初学者指南视频、esp32.com论坛（用于提问和社区资源）、GitHub Issues部分（用于错误和功能请求）以及贡献指南。