espflash

Serial flasher utility for Espressif SoCs and modules.

Currently supports the ESP32, ESP32-C3, ESP32-S2, ESP32-S3, and ESP8266.

asciicast

Installation

shell $ cargo install espflash

Usage

```text espflash 1.3.0

USAGE: espflash [OPTIONS] [ARGS] [SUBCOMMAND]

ARGS: Serial port connected to target device ELF image to flash

OPTIONS: --bootloader Path to a binary (.bin) bootloader file

    --format <FORMAT>
        Image format to flash [possible values: bootloader, direct-boot]

-h, --help
        Print help information

    --monitor
        Open a serial monitor after flashing

    --partition-table <PARTITION_TABLE>
        Path to a CSV file containing partition table

    --ram
        Load the application to RAM instead of Flash

    --speed <SPEED>
        Baud rate at which to flash target device

-V, --version
        Print version information

SUBCOMMANDS: board-info Display information about the connected board and exit without flashing help Print this message or the help of the given subcommand(s) save-image Save the image to disk instead of flashing to device ```

Configuration

You can also specify the serial port and/or expected VID/PID values by setting them in the configuration file. This file is in different locations depending on your operating system:

| Operating System | Configuration Path | | :--------------- | :----------------------------------------------------------------------- | | Linux: | /home/alice/.config/espflash/espflash.toml | | Windows: | C:\Users\Alice\AppData\Roaming\esp\espflash\espflash.toml | | macOS: | /Users/Alice/Library/Application Support/rs.esp.espflash/espflash.toml |

An example configuration file may look as follows (note that TOML does not support hexadecimal literals):

```toml [connection] serial = "/dev/ttyUSB0"

[usb_device] vid = 12346 # 0x303A pid = 32768 # 0x8000 ```

Use as a Cargo Runner

You can also use espflash as a Cargo runner by adding the followin to your project's .cargo/config file:

[target.'cfg(all(target_arch = "xtensa", target_os = "none"))'] runner = "espflash --ram /dev/ttyUSB0"

This then allows you to run your project using cargo run.

License

Licensed under the GNU General Public License Version 2. See LICENSE for more details.