Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions cargo-espflash/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
[package]
name = "cargo-espflash"
version = "0.1.4"
description = "Cargo subcommand for flashing the ESP8266 and ESP32 over serial"
license = "GPL-2.0"
authors = [
"Robin Appelman <robin@icewind.nl>",
"Jesse Braham <jesse@beta7.io>",
]
repository = "https://github.com/esp-rs/espflash"
edition = "2018"
description = "Cargo subcommand for flashing Espressif devices over serial"
repository = "https://github.com/esp-rs/espflash"
license = "GPL-2.0"
keywords = [
"cargo",
"cli",
"embedded",
"esp",
"xtensa",
]
categories = [
"command-line-utilities",
"development-tools",
"development-tools::cargo-plugins",
"embedded",
]

[dependencies]
espflash = { version = "0.1.3", path = "../espflash" }
pico-args = "0.4.0"
anyhow = "1.0"
cargo_metadata = "0.14"
clap = "2.33"
espflash = { version = "*", path = "../espflash" }
guess_host_triple = "0.1"
serde = { version = "1.0", features = ["derive"] }
serial = "0.4"
serde = { version = "1", features = ["derive"] }
toml = "0.5"
cargo_metadata = "0.14.0"
guess_host_triple = "0.1.2"
anyhow = "1.0"
25 changes: 22 additions & 3 deletions cargo-espflash/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
# `cargo-espflash`

_ESP8266_ and _ESP32_ cross-compiler and serial flasher cargo subcommand.
Cross-compiler and serial flasher cargo subcommand for Espressif devices. Currently supports __ESP32__, __ESP32-C3__, and __ESP8266__.

Prior to flashing, the project is built using the `build-std` unstable cargo feature. Please refer to the [cargo documentation](https://doc.rust-lang.org/cargo/reference/unstable.html#build-std) for more information.

## Usage

```bash
$ cargo espflash [--board-info] [--ram] [--release] [--example EXAMPLE] [--chip {esp32,esp8266}] <serial>
```text
cargo-espflash 0.1.4
Cargo subcommand for flashing Espressif devices over serial

USAGE:
cargo espflash [FLAGS] [OPTIONS] [SERIAL]

FLAGS:
--board-info Display the connected board's information
-h, --help Prints help information
--ram Load the application to RAM instead of Flash
--release Build the application using the release profile
-V, --version Prints version information

OPTIONS:
--example <EXAMPLE> Example to build and flash
--features <FEATURES> Comma delimited list of build features
--speed <SPEED> Baud rate at which to flash target device

ARGS:
<SERIAL> Serial port connected to target device
```

When the `--ram` option is specified, the provided ELF image will be loaded into ram and executed without touching the flash.
Expand Down
Loading