feat/terminal-usability-and-reliability

Cargo.toml

@@ -9,19 +9,17 @@ authors = [
 categories = ["command-line-utilities", "development-tools", "embedded"]
 description = "A simple, clean serial monitor with a clean terminal UI for embedded development"
 license = "MIT"
-readme = "README.md"
 repository = "https://github.com/systemscape/sermonizer"
 keywords = ["serial", "monitor", "embedded", "terminal", "tui"]
 
 [dependencies]
 anyhow = "1.0"
 clap = { version = "4.5", features = ["derive"] }
-crossterm = "0.29"
 ctrlc = "3.4"
 ratatui = "0.29"
 serialport = "4.3"
-tokio = { version = "1.0", features = ["rt-multi-thread", "sync", "time", "macros"] }
-chrono = { version = "0.4", features = ["serde"] }
+tokio = { version = "1.0", features = ["rt-multi-thread", "sync", "macros"] }
+chrono = "0.4"
 unicode-width = "0.2"
 
 # The profile that 'dist' will build with

README.md

@@ -8,16 +8,39 @@ A simple, clean serial monitor with a clean terminal UI for embedded development
 
 Most terminal-based serial monitors are annoying to use - they have clunky interfaces and no sane defaults. We wanted something that could be quickly spun up to interact with embedded devices during firmware development without any hassle.
 
-![Screenshot](./docs/screenshot.png)
+```text
+┌Serial Monitor────────────────────────────────────────────────────────────────────────────────┐
+│[2026-09-10 09:41:02.118] I (312) boot: ESP-IDF v5.2                                          │
+│[2026-09-10 09:41:02.121] I (318) wifi: connecting to lab-iot                                 │
+│[2026-09-10 09:41:03.877] I (2074) wifi: got ip 192.168.4.23                                  │
+│> [2026-09-10 09:41:07.402] AT+GMR                                                            │
+│[2026-09-10 09:41:07.410] AT version:2.4.0.0                                                  │
+│[2026-09-10 09:41:07.411] OK                                                                  │
+│[sermonizer] device disconnected: Broken pipe - reconnecting (Ctrl+C to quit)                 │
+│[sermonizer] device reconnected                                                               │
+│[2026-09-10 09:41:12.006] I (309) boot: ESP-IDF v5.2                                          │
+│[2026-09-10 09:41:12.009] I (315) main: sensor=23.4C hum=41%                                  │
+│                                                                                              │
+│                                                                                              │
+└──────────────────────────────────────────────────────────────────────────────────────────────┘
+┌Input─────────────────────────────────────────────────────────────────────────────────────────┐
+│AT+CWJAP="lab-iot","                                                                          │
+└──────────────────────────────────────────────────────────────────────────────────────────────┘
+ ttyUSB0 115200 8N1  follow | LF | Enter send, Up/Down history, Shift+Up/Down PgUp/PgDn scroll,
+```
+
+*Received lines, a sent line (`>`, shown with `--echo`), sermonizer's own notices and the line still being received. Regenerate with `just update-screenshot`.*
 
 ## Features
 
 - **Smart auto-scroll**: Follows new data, easy to switch to manual scrolling
 - **Auto-reconnect**: Keeps watching the port and resumes when the device comes back
 - **Clean TUI**: Split view with input at bottom, output on top, status bar with connection state
-- **Auto-detect ports**: Just run `sermonizer` and it finds your device
+- **Auto-detect ports**: Just run `sermonizer` and it finds your device; dead onboard UARTs stay out of the way unless you ask for `--all-ports`
 - **Sane defaults**: 115200 baud, 8 data bits, no parity, 1 stop bit
-- **Hex mode**: View binary data as hex bytes
+- **Hex mode**: View binary data as hex bytes with a `hexdump -C` style ASCII column
+- **Clean text**: ANSI colour codes from firmware logs are stripped (keep them with `--raw`)
+- **Local echo**: `--echo` shows what you sent, for devices that do not echo
 - **Logging**: Save RX/TX data with timestamps
 - **Fast**: Built in Rust, handles high baud rates smoothly
 
@@ -57,26 +80,36 @@ sermonizer [OPTIONS]
 Options:
   -p, --port <PORT>        Serial port path
   -b, --baud <BAUD>        Baud rate (default: 115200)
-      --line-ending <E>    Line ending: none|nl|cr|crlf (default: nl)
+      --line-ending <E>    Line ending: none|nl|lf|cr|crlf (default: nl)
       --data-bits <N>      Data bits: 5|6|7|8 (default: 8)
       --parity <P>         Parity: none|odd|even (default: none)
       --stop-bits <N>      Stop bits: 1|2 (default: 1)
       --flow-control <F>   Flow control: none|software|hardware (default: none)
       --dtr <on|off>       Set the DTR line after opening
       --rts <on|off>       Set the RTS line after opening
       --hex                Display data as hex
+      --raw                Keep ANSI escape sequences instead of stripping them
+  -e, --echo               Show sent lines in the output, prefixed with "> "
+  -w, --wrap               Wrap long lines instead of clipping them
+      --mouse              Scroll output with the mouse wheel
       --log <FILE>         Log received data
       --tx-log <FILE>      Log transmitted data
-      --log-ts             Add timestamps to logs and display
+  -t, --timestamps         Add timestamps to display and logs (alias: --log-ts)
       --list               List available ports
+      --all-ports          Also list ports of unknown type (e.g. /dev/ttyS*), hidden by default
 ```
 
 ## Controls
 
 - **Type and press Enter**: Send data to device
+- **Paste**: Multi-line text is sent line by line; an unfinished last line stays in the input box
 - **↑↓**: Browse send history
+- **Home / End, Ctrl+A / Ctrl+E**: Jump to start / end of the input line
+- **Ctrl+U / Ctrl+K / Ctrl+W**: Delete to start of line / to end of line / previous word
 - **Shift+↑↓ / Page Up/Down**: Scroll through output
-- **Home / End**: Jump to top / bottom (End resumes auto-scroll)
+- **Shift+Home / Shift+End** (or Ctrl+Home / Ctrl+End): Jump to top / bottom of output (End resumes auto-scroll)
+- **Mouse wheel**: Scrolls the output when started with `--mouse`. It is off by default because capturing the mouse makes most terminals require Shift+drag to select and copy text
+- **Ctrl+T**: Toggle wrapping of long lines
 - **Ctrl+L**: Clear output
 - **Ctrl+V, then a key**: Send that key as a raw control byte (e.g. Ctrl+V Ctrl+C sends 0x03)
 - **Esc**: Clear input line

justfile

@@ -0,0 +1,20 @@
+# Project tasks. Needs only cargo; update-screenshot also uses awk.
+
+default:
+    @just --list
+
+# Render the README screenshot from the real UI code and print it
+screenshot:
+    @cargo test --quiet readme_screenshot -- --ignored --nocapture | sed -n '/^┌/,/^ ttyUSB0/p'
+
+# Replace the screenshot block in README.md with a fresh render
+update-screenshot:
+    #!/usr/bin/env bash
+    set -euo pipefail
+    SHOT="$(just screenshot)" awk '
+        /^```text$/ && !done { print; print ENVIRON["SHOT"]; skip = 1; next }
+        skip && /^```$/ { skip = 0; done = 1 }
+        !skip { print }
+    ' README.md > README.md.tmp
+    mv README.md.tmp README.md
+    git --no-pager diff --stat -- README.md