esptools

Esp tools (esptool, espsecure, espefuse and espidfnvs) bundler.

Bundles the ESP tools as a Rust library.

Q: Why do I need it? Espressif already provides self-contained pre-built executables for all the major platforms?

A: To use these from a build.rs script or other Rust code, you still have to download the archive corresponding to your OS, extract it and then put the executables in your $PATH before being able to call the tool of your choice. This is exactly what this crate automates!

NOTE: Supported platforms

esptools will only run on those platforms where Espressif supplies pre-built binaries. I.e. Linux / MacOS / Windows X86_64 as well as Linux ARM64 and ARM32.

NOTE: Licensing

While the esptools crate is licensed under Apache + MIT (as usual with Rust), the bundled (and thus distributed) binaries of esptool, espsecure and espefuse are licensed under the GPL v2. (This does not apply to espidfnvs a.k.a. esp-idf-nvs-partition-gen, which is a separate repo licensed under the Apache license.)

With that said, distributing those should be OK, as we are providing a link to the upstream Espressif GIT repo containing the binaries' source code, as well as the download location of the binaries themselves.

Let us know if you think otherwise!

If you distribute - outside of your premises and e.g. the factory flashing your chips - a binary using this library, you might want to include these links in your binary documentation though!

Examples

Command line

cargo install --force --git https://github.com/ivmarkov/esptools
esptools efuse -h

Library

fn main() -> anyhow::Result<()> {
    esptools::Tool::EspEfuse.mount()?.exec(&["-h"])
}