esp: idf.py command

esp-idf

esp-idf是什么？

ESP-IDF 是乐鑫官方的物联网开发框架，适用于 ESP32、ESP32-S、ESP32-C 和 ESP32-H 系列 SoC。

• ESP-IDF 相关资源已在 GitHub 上免费开放。用户可在 Apache 2.0 许可下以源代码形式获取 ESP-IDF 的大多数组件，或通过兼容许可证获取第三方组件。
• ESP-IDF 具有清晰、严格的发布流程和支持策略，确保用户选择使用稳定的发布版本，并可持续获得适用于其应用的重要修复程序。每个稳定的发布版本均经过严格的测试流程，以确保版本稳定，客户可快速实现量产。
• ESP-IDF 集成了大量的软件组件，包括 RTOS、外设驱动程序、网络栈、多种协议实现技术以及常见应用程序的使用助手。它提供了典型应用程序所需的大部分构建块，用户在开发应用时只需专注于业务逻辑即可。 ESP-IDF 不仅具有免费开源的开发工具，还支持 Eclipse 和 VSCode 等 IDE，确保其易于开发人员使用。
• ESP-IDF 提供详尽的软件组件使用和设计文档，有助于开发人员充分理解 ESP-IDF 功能，并从中挑选最适合构建其应用程序的模块。ESP-IDF 包含 100 多个示例，详细说明了其组件及硬件外设的功能和用法。它们经过了严格的测试和维护，是用户开启应用开发的有效参考。

idf常用命令

使用 idf.py 命令即可显示帮助提示。

# Options:
--version				# 显示idf版本信息
--list-targets			# 显示支持的SoC
--ccache / --no-ccache	# 在编译是是否启用ccache环境以加快编译速度，默认是关闭的。
-p PATH 				# 指定串口路径


# Commands:
clean		# 从build目录删除编译输出文件
fullclean	# 删除整个build目录中的文件

set-target	# 设置编译目标SoC
menuconfig	# 打开项目配置菜单
erase-flash	# 擦除整个flash
flash		# 烧录固件
monitor 	# 显示串口日志输出

add-dependency # 在main目录下创建idf_component.yml,并在该文件中写入组件信息
all                          Aliases: build. Build the project.
app                          Build only the app.
app-flash                    Flash the app only.
bootloader                   Build only bootloader.
bootloader-flash             Flash bootloader only.
build-system-targets         Print list of build system targets.

create-component             Create a new component.
create-manifest              Create manifest for specified component.
create-project               Create a new project.
create-project-from-example  Create a project from an example.