https://github.com/esp-rs/espflash

Serial flasher utility for Espressif SoCs and modules based on esptool.py
https://github.com/esp-rs/espflash

Last synced: about 2 months ago
JSON representation

Serial flasher utility for Espressif SoCs and modules based on esptool.py

• Host: GitHub
• URL: https://github.com/esp-rs/espflash
• Owner: esp-rs
• License: apache-2.0
• Created: 2020-09-01T20:51:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T18:33:58.000Z (7 months ago)
• Last Synced: 2024-05-20T13:34:15.411Z (7 months ago)
• Language: Rust
• Homepage:
• Size: 6.75 MB
• Stars: 441
• Watchers: 11
• Forks: 109
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

• awesome-esp-rust - espflash - Serial flasher utility for Espressif SoCs and modules based on [esptool](https://github.com/espressif/esptool). (Tools)
• awesome-embedded-rust - espflash - [](https://crates.io/crates/espflash) (Tools / Paid and commercially available materials)
• rust-embedded - espflash - [](https://crates.io/crates/espflash) (Tools / Paid and commercially available materials)

README

        
# espflash

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/esp-rs/espflash/ci.yml?branch=main&labelColor=1C2C2E&logo=github&style=flat-square)](https://github.com/esp-rs/espflash/actions/workflows/ci.yml)

![Crates.io](https://img.shields.io/crates/l/espflash?labelColor=1C2C2E&style=flat-square)

[![Matrix](https://img.shields.io/matrix/esp-rs:matrix.org?label=join%20matrix&color=BEC5C9&labelColor=1C2C2E&logo=matrix&style=flat-square)](https://matrix.to/#/#esp-rs:matrix.org)

Serial flasher utilities for Espressif devices, based loosely on [esptool.py](https://github.com/espressif/esptool/).

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](./cargo-espflash/)

A cargo extension for flashing Espressif devices.

For more information and installation instructions, please refer to the `cargo-espflash` package's [README](./cargo-espflash/README.md).

## [espflash](./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](./espflash/README.md).

## 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:

```bash

$ 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:

- Apache License, Version 2.0 ([LICENSE-APACHE](./LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](./LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.