espmonitor

Crates.ioespmonitor
lib.rsespmonitor
version0.10.0
sourcesrc
created_at2021-03-19 09:22:38.419952
updated_at2022-06-10 20:38:29.198185
descriptionMonitors ESP8266 and ESP32 execution over serial
homepagehttps://github.com/esp-rs/espmonitor
repositoryhttps://github.com/esp-rs/espmonitor
max_upload_size
id370914
size35,280
espressif (github:esp-rs:espressif)

documentation

README

ESPMonitor

ESP32 and ESP8266 serial monitor.

Features

  • Resets chip on startup.
  • Can match hex sequences in output to function names in a binary.
  • Optionally builds and flashes before starting the monitor.
  • cargo integration.

Usage

Install with:

cargo install cargo-espmonitor

Run cargo espmonitor --help for details.

If you prefer the standalone monitor app without cargo integration, you can instead install espmonitor.

Keyboard Commands

While monitoring, ESPMonitor accepts the following keyboard commands:

  • CTRL+R: Reset chip
  • CTRL+C: Quit

Contributing

Hooks

Before you start writing code, run this in the root of the repo:

mkdir -p .git/hooks && (cd .git/hooks && ln -s ../../hooks/* .)

This will set up a pre-commit hook that will run cargo clippy and cargo fmt before each commit, to save you some time getting frustrated with failed PR checks.

Releasing

See RELEASING for instructions.

Commit count: 168

cargo fmt