Rust ESP32/ESP8266烧录工具espflash的使用

espflash是一个用于烧录Espressif设备的Rust库和命令行工具，支持ESP32、ESP32-C2/C3/C5/C6、ESP32-H2、ESP32-P4和ESP32-S2/S3等芯片。

安装

从源码安装(使用cargo install)需要系统上安装rustc>=1.85.0:

cargo install espflash --locked

或者使用cargo-binstall下载预编译版本:

cargo binstall espflash

基本使用

espflash提供多个子命令:

Usage: espflash [OPTIONS] <COMMAND>

Commands:
  board-info       打印连接设备的信息
  checksum-md5     计算指定区域的MD5校验和
  completions      为指定shell生成补全脚本
  erase-flash      完全擦除闪存
  erase-parts      擦除指定分区
  erase-region     擦除指定区域
  flash            将ELF格式的应用烧录到连接的设备
  hold-in-reset    保持目标设备在复位状态
  list-ports       列出可用串口
  monitor          打开串口监视器而不烧录设备
  partition-table  在CSV和二进制格式间转换分区表
  read-flash       读取SPI闪存内容
  reset            复位目标设备
  save-image       生成二进制应用镜像并保存到本地
  write-bin        将二进制文件写入设备闪存的指定地址
  help             打印帮助信息

完整示例

1. 作为Cargo Runner使用

在项目.cargo/config.toml中添加:

[target.'cfg(any(target_arch = "riscv32", target_arch = "xtensa"))']
runner = "espflash flash --baud=921600 --monitor /dev/ttyUSB0"

2. 作为库使用

在Cargo.toml中添加依赖:

espflash = { version = "3.3", default-features = false }

或者运行:

cargo add espflash --no-default-features

3. 烧录固件示例

# 烧录ELF文件并打开串口监视器
espflash flash --monitor target/riscv32imc-unknown-none-elf/release/your_app

# 擦除整个闪存
espflash erase-flash

# 读取闪存内容
espflash read-flash 0x0 0x100000 flash_contents.bin

4. 配置文件示例

espflash_ports.toml(端口配置):

[connection]
serial = "/dev/ttyUSB0"

# 或者通过USB VID/PID
[[usb_device]]
vid = "303a"
pid = "1001"

espflash.toml(项目配置):

baudrate = 460800
bootloader = "path/to/custom/bootloader.bin"
partition_table = "path/to/custom/partition-table.bin"

[flash]
mode = "qio"
size = "8MB"
frequency = "80MHz"

完整示例demo

下面是一个完整的ESP32开发项目示例，展示如何使用espflash进行开发：

1. 首先创建一个新项目：

cargo new esp32-example --bin
cd esp32-example

1. 添加必要的依赖到Cargo.toml：

[package]
name = "esp32-example"
version = "0.1.0"
edition = "2021"

[dependencies]
esp32-hal = "0.10.0"  # ESP32硬件抽象层
espflash = { version = "3.3", default-features = false }  # 烧录工具

1. 配置.cargo/config.toml：

[target.'cfg(target_arch = "xtensa")']
runner = "espflash flash --monitor /dev/ttyUSB0"

[build]
target = "xtensa-esp32-espidf"  # ESP32目标架构

1. 创建一个简单的闪烁LED程序src/main.rs：

// 导入必要的库
use esp32_hal::{
    clock_control::ClockControl, 
    gpio::IO,
    peripherals::Peripherals,
    prelude::*,
    timer::TimerGroup,
    Delay,
};

// 主函数
fn main() -> ! {
    // 获取外围设备
    let peripherals = Peripherals::take();
    let mut system = peripherals.DPORT.split();
    
    // 初始化时钟控制
    let clocks = ClockControl::boot_defaults(system.clock_control).freeze();
    
    // 设置GPIO
    let io = IO::new(peripherals.GPIO, peripherals.IO_MUX);
    let mut led = io.pins.gpio2.into_push_pull_output();
    
    // 创建延时实例
    let mut delay = Delay::new(&clocks);
    
    // 主循环 - 闪烁LED
    loop {
        led.set_high().unwrap();
        delay.delay_ms(1000u32);
        led.set_low().unwrap();
        delay.delay_ms(1000u32);
    }
}

1. 编译并烧录程序：

cargo build --release
cargo run --release

注意事项

1. Linux系统需要将用户添加到dialout组以获得串口访问权限:

   sudo usermod -a -G dialout $USER
   

2. WSL1不支持espflash，WSL2仅支持通过UART烧录。

3. 支持两种日志格式:

   • serial: 默认串口日志格式
   • defmt: 使用defmt日志框架

espflash提供了高效稳定的嵌入式设备固件烧录功能，是Rust开发Espressif设备的理想工具。