esp-rs / espflash

Serial flasher utility for Espressif SoCs and modules based on esptool.py
Apache License 2.0
492 stars 119 forks source link

espflash

GitHub Workflow Status Crates.io Matrix

Serial flasher utilities for Espressif devices, based loosely on esptool.py.

Supports the ESP32, ESP32-C2/C3/C6, ESP32-H2, ESP32-P4, and ESP32-S2/S3.

[!IMPORTANT] Espressif considers espflash and cargo-espflash to be feature-complete at this time. This does not mean we will stop maintaining them; contributions are still welcome. However, we do not plan to pursue further development at this point in time.

cargo-espflash

A cargo extension for flashing Espressif devices.

For more information and installation instructions, please refer to the cargo-espflash package's README.

espflash

A library and command-line tool for flashing Espressif devices.

For more information and installation instructions, please refer to the espflash package's README.

Git Hooks

We provide a simple pre-commit hook to verify the formatting of each package prior to committing changes. This can be enabled by placing it in the .git/hooks/ directory:

$ cp pre-commit .git/hooks/pre-commit

When using this hook, you can choose to ignore its failure on a per-commit basis by committing with the --no-verify flag; however, you will need to be sure that all packages are formatted when submitting a pull request.

License

Licensed under either of:

at your option.

Contribution

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.