cargo-espflash

Cross-compiler and serial flasher cargo subcommand for Espressif devices. Supports ESP32, ESP32-S2, ESP32-C3, and ESP8266.

Prior to flashing, the project is built using the build-std unstable cargo feature. Please refer to the cargo documentation for more information.

Usage

```text cargo-espflash 1.1.0
Cargo subcommand for flashing Espressif devices over serial

USAGE:
cargo espflash [FLAGS] [OPTIONS] [SERIAL] [SUBCOMMAND]

FLAGS:
--board-info Display the connected board's information (deprecated, use the board-info subcommand instead)
-h, --help Prints help information
--monitor Open a serial monitor after flashing
--ram Load the application to RAM instead of Flash
--release Build the application using the release profile
-V, --version Prints version information

OPTIONS:
--bootloader Path to a binary (.bin) bootloader file
--example Example to build and flash
--features Comma delimited list of build features
--format Image format to flash
--partition-table Path to a CSV file containing partition table
--speed Baud rate at which to flash target device

ARGS:
Serial port connected to target device

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

When the --ram option is specified, the provided ELF image will be loaded into ram and executed without touching the flash.

Config

You can also specify the serial port by setting it in the config file located at ~/.config/espflash/espflash.toml or Linux or %APPDATA%/esp/espflash/espflash.toml on Windows.

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

Package metadata

You can also specify the bootloader, partition table or image format for a project in the package metadata in Cargo.toml

toml [package.metadata.espflash] partition_table = "partitions.csv" bootloader = "bootloader.bin" format = "direct-boot"

Example

bash $ cargo espflash --release --example blinky /dev/ttyUSB0

License

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