Cross-compiler and Cargo extension for flashing Espressif devices over serial.
Supports the ESP32, ESP32-C2/C3, ESP32-S2/S3, and ESP8266.
If you are installing cargo-espflash from source (ie. using cargo install) then you must have rustc>=1.63.0 installed on your system.
If you are running macOS or Linux then [libuv] must also be installed; this is available via most popular package managers. If you are running Windows you can ignore this step.
```bash
brew install libuv
apt-get install libuv-dev
dnf install systemd-devel ```
To install:
bash
cargo install cargo-espflash
Alternatively, you can use [cargo-binstall] to download pre-compiled artifacts from the [releases] and use them instead:
bash
cargo binstall cargo-espflash
If you would like to flash from a Raspberry Pi using the built-in UART peripheral, you can enable the raspberry feature (note that this is not available if using [cargo-binstall]):
bash
cargo install cargo-espflash --features=raspberry
```text Cargo subcommand for flashing Espressif devices over serial
Usage: cargo espflash
Commands: board-info Display information about the connected board and exit without flashing flash Flash an application to a target device monitor Open the serial monitor without flashing partition-table Operations for partitions tables save-image Save the image to disk instead of flashing to device help Print this message or the help of the given subcommand(s)
Options: -h, --help Print help information -V, --version Print version information ```
You're able to specify paths to bootloader and partition table files ands image format in your package's Cargo metadata for per-project configuration:
toml
[package.metadata.espflash]
bootloader = "bootloader.bin" # Must be a binary file
partition_table = "partitions.csv" # Supports CSV and binary formats
format = "direct-boot" # Can be 'esp-bootloader' or 'direct-boot'
It's possible to specify a serial port and/or USB VID/PID values by setting them in a configuration file. The location of this file differs based on your operating system:
| Operating System | Configuration Path |
| :--------------- | :---------------------------------------------------------------- |
| Linux | $HOME/.config/espflash/espflash.toml |
| macOS | $HOME/Library/Application Support/rs.esp.espflash/espflash.toml |
| Windows | %APPDATA%\esp\espflash\espflash.toml |
It is not currently possible to use cargo-espflash from within WSL1.
It is not possible to flash chips using the built-in USB_SERIAL_JTAG when using WSL2, because the reset also resets USB_SERIAL_JTAG peripheral which then disconnects the chip from WSL2. Chips can be flashed via UART using WSL2, however.
Licensed under either of:
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.