Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

从模板生成项目

我们目前维护了两个模板仓库:

esp-generate

esp-generate 是一个项目生成工具,可用于生成包含所有必需配置和依赖项的应用程序

  1. 安装 esp-generate

    cargo install esp-generate
    
  2. 基于模板生成项目,选择芯片和项目名称:

    esp-generate --chip=esp32c6 your-project
    

    参见esp-generate 简介了解模板项目的更多详细信息。

    调用 esp-generate 子命令时,它会提示一个 TUI,你可以在其中选择应用程序的配置。完成此过程后,你将获得一个配置正确且可构建的项目。

  3. 构建/运行生成的项目:

    • cargo build 编译项目(使用合适的工具链和目标)。
    • cargo run 编译项目、向目标设备烧写程序、并开启一个串口监视器。

esp-idf-template

esp-idf-template 基于 cargo-generate,这是一个允许你基于现有模板创建新项目的工具。在我们的场景中,esp-idf-template 可用于生成包含所有必需配置和依赖项的应用程序。

  1. 安装 cargo generate

    cargo install cargo-generate
    
  2. 基于模板生成项目:

    cargo generate esp-rs/esp-idf-template cargo
    

    参见esp-idf-template 简介了解模板项目的更多详细信息。

    调用 cargo generate 子命令时,它会询问几个关于应用程序目标的问题。完成这些问题后,就会生成一个配置好的项目,可以直接构建。

  3. 构建/运行生成的项目:

    • cargo build 编译项目(自动使用合适的工具链和目标)。
    • cargo run 编译项目、向目标设备烧写程序、并开启一个串口监视器。

在模板中使用开发容器(Dev Container)

两个模板仓库都支持开发容器。

开发容器使用 idf-rust 镜像,配置开发环境中的使用容器一节对此进行了解释。这个镜像提供了一个无需安装即可为乐鑫芯片开发 Rust 应用程序的环境。开发容器还可以与 Wokwi 模拟器协作,以模拟项目,并允许使用 web-flash 从容器中进行烧写。