Skip to content

Commit 431f37a

Browse files
committed
defmt support docs!
1 parent 6f90b18 commit 431f37a

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

defmt support.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
With the `defmt` feature enabled, `yap` can decode incoming defmt packets!
2+
3+
The Defmt Parsing setting controls how incoming bytes will be treated:
4+
5+
- Disabled: The default, all incoming bytes are treated as text.
6+
- Raw: All bytes will be treated as raw, uncompressed defmt frames. Any error in parsing will cease further attempts.
7+
- UnframedRzcobs: Assumes all frames will be rzCOBS-encoded, terminated by `0x00`. Errors during parsing will be handled gracefully.
8+
- FramedRzcobs: Expects defmt frames to be framed as `0xFF 0x00 <CONTENT> 0x00` (The terminating 0x00 is the same terminating byte from rzCOBS encoding). Any bytes outside of those frames will be treated as text. **If you're using an ESP32, you probably want this one!**
9+
10+
And when setting up a espflash .ELF profile, you can add the line `defmt = true` to automatically begin using the ELF to decode any packets sent after flashing!
11+
12+
FramedRzcobs matches the framing scheme used by `esp-rs`'s [`espflash`](https://github.com/esp-rs/espflash) and [`esp-println`](https://github.com/esp-rs/esp-hal/tree/main/esp-println)!

example_configs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ usb = ["28DE:2102"] ## Ignore ports by USB VID:PID or VID:PID:Serial
2424
# - Valve Index/Bigscreen Beyond's Bluetooth COM Port (Watchman)
2525
# VID: 28DE, PID: 2102
2626
name = [] ## Ignore ports by name/path
27+
hide_loopback_port = true ## Hide the Lorem Ipsum/Loopback testing port.
2728
```
2829

2930

0 commit comments

Comments
 (0)