https://github.com/ivmarkov/esptools

https://github.com/ivmarkov/esptools

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ivmarkov/esptools
• Owner: ivmarkov
• License: apache-2.0
• Created: 2024-12-06T23:07:31.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-12-07T09:02:38.000Z (30 days ago)
• Last Synced: 2024-12-07T10:17:08.277Z (30 days ago)
• Language: Rust
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# esptools

[Esp tools](https://github.com/espressif/esptool) (`esptool`, `espsecure` and `espefuse`) bundler.

[![CI](https://github.com/ivmarkov/esptools/actions/workflows/ci.yml/badge.svg)](https://github.com/ivmarkov/esptools/actions/workflows/ci.yml)

[![crates.io](https://img.shields.io/crates/v/esptools.svg)](https://crates.io/crates/esptools)

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

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](https://github.com/espressif/esptool/releases/tag/v4.8.1)?

**A:** To use these from a `build.rs` script or other Rust code, you still have to download the .ZIP 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**](https://github.com/espressif/esptool/blob/master/LICENSE).

With that said, [distributing those should be OK](https://www.reddit.com/r/opensource/comments/nok8lg/include_binaries_of_a_gpl_licensed_program/), as we are providing a [link](https://github.com/espressif/esptool) to the upstream Espressif GIT repo containing the binaries' source code, as well as [the download location of the binaries themselves](https://github.com/espressif/esptool/releases/tag/v4.8.1).

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

```sh

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

esptools efuse -h

```

### Library

```rust

use esptools::{Tool, Tools};

fn main() -> anyhow::Result<()> {

    let tools = Tools::mount()?;

    tools.exec(Tool::EspEfuse, &["-h"])?;

    Ok(())

}

```