Docs.rs
  • espflash-3.3.0
    • espflash 3.3.0
    • Permalink
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Repository
    • crates.io
    • Source
    • Owners
    • icewind1991
    • jessebraham
    • github:esp-rs:espressif
    • Dependencies
      • addr2line ^0.22.0 normal optional
      • base64 ^0.22.1 normal
      • bytemuck ^1.21.0 normal
      • clap ^4.5.24 normal optional
      • clap_complete ^4.5.41 normal optional
      • comfy-table ^7.1.3 normal optional
      • crossterm ^0.25.0 normal optional
      • ctrlc ^3.4.5 normal optional
      • defmt-decoder =0.4.0 normal optional
      • defmt-parser =0.4.1 normal optional
      • dialoguer ^0.11.0 normal optional
      • directories ^5.0.1 normal optional
      • env_logger ^0.11.6 normal optional
      • esp-idf-part ^0.5.0 normal
      • flate2 ^1.0.35 normal
      • hex ^0.4.3 normal optional
      • indicatif ^0.17.9 normal optional
      • lazy_static ^1.5.0 normal optional
      • log ^0.4.22 normal
      • md-5 ^0.10.6 normal
      • miette ^7.4.0 normal
      • parse_int ^0.6.0 normal optional
      • regex ^1.11.1 normal optional
      • serde ^1.0.217 normal
      • serialport ^4.6.1 normal optional
      • sha2 ^0.10.8 normal
      • slip-codec ^0.4.0 normal optional
      • strum ^0.26.3 normal
      • thiserror ^2.0.10 normal
      • toml ^0.8.19 normal optional
      • update-informer ^1.2.0 normal optional
      • xmas-elf ^0.9.1 normal
      • libc ^0.2.169 normal
    • Versions
    • 50% of the crate is documented
  • Platform
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate espflash

espflash3.3.0

  • All Items

Sections

  • As an application
  • As a library

Crate Items

  • Modules

Crates

  • espflash

Crate espflash

Source
Expand description

A library and application for flashing Espressif devices over Serial

§As an application

espflash can be installed using cargo install, and additionally supports installation via cargo-binstall:

$ cargo install espflash
$ cargo binstall espflash

§As a library

espflash can also be used as a library:

espflash = { version = "2.1", default-features = false }

We add default-features here to disable the cli feature, which is enabled by default. Its important to note that the cli module does not provide SemVer guarantees. You likely will not need any of these types or functions in your application so there’s no use pulling in the extra dependencies.

Modules§

clicli
Types and functions for the command-line interface
command
Commands to work with a flasher stub running on a target device
connectionserialport
Establish a connection with a target device
elf
ELF (Executable and Linkable Format) file operations
error
Library and application errors
flasher
Write a binary application to a target device
image_format
ESP-IDF application binary image format
loggingcli
Logging utilities
targets
Flashable target devices
updatecli
Check for updates

Results

Settings
Help
    struct field
    espflash::flasher::FlashSettings::mode
    enum
    espflash::flasher::FlashMode
    Supported flash modes
    struct field
    espflash::cli::FlashConfigArgs::flash_mode
    Flash mode to use
    enum variant
    espflash::error::ConnectionError::WrongBootMode
    enum variant
    espflash::error::RomErrorKind::NotInFlashMode
No results :(
Try on DuckDuckGo?

Or try looking in one of these:
  • The Rust Reference for technical details about the language.
  • Rust By Example for expository code examples.
  • The Rust Book for introductions to language features and the language itself.
  • Docs.rs for documentation of crates released on crates.io.
No results :(
Try on DuckDuckGo?

Or try looking in one of these:
  • The Rust Reference for technical details about the language.
  • Rust By Example for expository code examples.
  • The Rust Book for introductions to language features and the language itself.
  • Docs.rs for documentation of crates released on crates.io.