https://github.com/esp-rs/espmonitor
Cargo tool for monitoring ESP32/ESP8266 execution
https://github.com/esp-rs/espmonitor
Last synced: 5 months ago
JSON representation
Cargo tool for monitoring ESP32/ESP8266 execution
- Host: GitHub
- URL: https://github.com/esp-rs/espmonitor
- Owner: esp-rs
- License: gpl-3.0
- Archived: true
- Created: 2021-03-17T10:20:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-21T19:05:32.000Z (about 2 years ago)
- Last Synced: 2025-01-15T13:18:34.323Z (5 months ago)
- Language: Rust
- Size: 203 KB
- Stars: 47
- Watchers: 4
- Forks: 16
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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](RELEASING.md) for instructions.