diff --git a/README.md b/README.md index 9353c19..fffd86c 100644 --- a/README.md +++ b/README.md @@ -1,185 +1,179 @@ # xserial -**跨平台串口 / TCP / UDP 数据观测工具** — 可配置分帧、协议解码、多会话管理、实时波形绘图,单二进制零依赖。 +**Cross-platform serial / TCP / UDP data inspection tool** with configurable framing, protocol decoding, multi-session management, and real-time waveform plotting — all in a single binary. -基于 Rust + [egui](https://github.com/emilk/egui) 构建,支持 Lua 脚本扩展。 +Built with Rust + [egui](https://github.com/emilk/egui), scriptable with Lua. + +[中文文档](README_zh.md) --- -## 目录 +## Table of Contents -- [功能特性](#功能特性) -- [快速开始](#快速开始) -- [完整示例:无人机遥测解析](#完整示例无人机遥测解析) -- [Lua 脚本开发指南](#lua-脚本开发指南) -- [架构](#架构) -- [配置与持久化](#配置与持久化) -- [开发工具](#开发工具) -- [技术栈](#技术栈) +- [Features](#features) +- [Quick Start](#quick-start) +- [Walkthrough: Drone Telemetry](#walkthrough-drone-telemetry) +- [Lua Scripting Guide](#lua-scripting-guide) +- [Architecture](#architecture) +- [Configuration & Persistence](#configuration--persistence) +- [Development Tools](#development-tools) +- [Tech Stack](#tech-stack) - [License](#license) --- -## 功能特性 +## Features -### 传输层 +### Transport -| 类型 | 说明 | 配置项 | -|------|------|--------| -| **Serial** | 串口通信 | 端口名、波特率 (300–12M)、数据位 (5/6/7/8)、校验位 (None/Odd/Even)、停止位 (1/2)、流控 (None/Software/Hardware)、DTR/RTS 控制 | -| **TCP** | TCP 客户端 | 目标地址 `host:port` | -| **UDP** | UDP 通信 | 绑定地址 `host:port`,可选远端地址 | +| Type | Description | Options | +|------|-------------|---------| +| **Serial** | Serial port communication | Port name, baud rate (300–12M), data bits (5/6/7/8), parity (None/Odd/Even), stop bits (1/2), flow control (None/Software/Hardware), DTR/RTS control | +| **TCP** | TCP client | Target address `host:port` | +| **UDP** | UDP communication | Bind address `host:port`, optional remote address | -### 分帧器(Framer) +### Framers -将原始字节流切分为独立帧。每个 Session 可配置**多条独立管线**,同一字节流并行送入多个 framer→decoder 链路。 +Framers split raw byte streams into discrete frames. Each session supports **multiple independent pipelines** — the same byte stream feeds multiple framer→decoder chains in parallel. -| 分帧器 | 说明 | 配置参数 | -|--------|------|----------| -| **Line** | 按 `\n` 分割文本行 | `strip_cr`(去除 `\r`)、`max_line_len`(最大行长度) | -| **Fixed** | 固定字节数为一帧 | `frame_len`(帧长度) | -| **Length** | 长度前缀协议 | `len_bytes` (1/2/4/8)、`endian` (大小端)、`length_includes_self`、`max_payload` | -| **COBS** | [Consistent Overhead Byte Stuffing](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) 编码 | `max_frame`(最大帧长) | -| **MixedTextPlot** | 单连接混合文本行 + COBS 编码的 plot 帧 | `strip_cr`、`max_line_len`、`max_plot_frame` | -| **Lua** | 用户自定义分帧脚本 | `script_path`(Lua 脚本路径) | +| Framer | Description | Parameters | +|--------|-------------|------------| +| **Line** | Split by `\n` | `strip_cr`, `max_line_len` | +| **Fixed** | Fixed-length frames | `frame_len` | +| **Length** | Length-prefixed protocol | `len_bytes` (1/2/4/8), `endian`, `length_includes_self`, `max_payload` | +| **COBS** | [Consistent Overhead Byte Stuffing](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) | `max_frame` | +| **MixedTextPlot** | Hybrid text lines + COBS-encoded plot frames on one stream | `strip_cr`, `max_line_len`, `max_plot_frame` | +| **Lua** | User-defined framer script | `script_path` | -### 解码器(Decoder) +### Decoders -将帧数据解析为可展示的内容。 +Decoders parse framed data into displayable content. -| 解码器 | 输出类型 | 配置参数 | -|--------|----------|----------| -| **Text** | 文本 | `encoding`(UTF-8 / Latin1 / ASCII) | -| **Hex** | 十六进制 | `uppercase`、`separator`、`bytes_per_group`、`endian` | -| **Plot** | 波形数据 | `sample_type` (i8–f64)、`endian`、`channels` (1–64)、`format` (Interleaved / Block / XY) | -| **MixedTextPlot** | 混合文本 + 波形 | `encoding` | -| **Lua** | 自定义 | `script_path`(Lua 脚本路径) | +| Decoder | Output | Parameters | +|---------|--------|------------| +| **Text** | Text | `encoding` (UTF-8 / Latin1 / ASCII) | +| **Hex** | Hexadecimal | `uppercase`, `separator`, `bytes_per_group`, `endian` | +| **Plot** | Waveform | `sample_type` (i8–f64), `endian`, `channels` (1–64), `format` (Interleaved / Block / XY) | +| **MixedTextPlot** | Hybrid text + waveform | `encoding` | +| **Lua** | Custom | `script_path` | -**Plot 采样格式:** +**Plot sample formats:** -| 格式 | 说明 | 字节排列 | -|------|------|----------| -| **Interleaved** | 多通道交叉排列 | `[ch0_s0, ch1_s0, ch2_s0, ch0_s1, ch1_s1, …]` | -| **Block** | 按通道分块排列 | `[ch0_s0, ch0_s1, …, ch1_s0, ch1_s1, …]` | -| **XY** | 2 通道交替 x/y | `[x0, y0, x1, y1, …]` | +| Format | Description | Byte layout | +|--------|-------------|-------------| +| **Interleaved** | Channels interleaved | `[ch0_s0, ch1_s0, ch2_s0, ch0_s1, ch1_s1, …]` | +| **Block** | Channel-contiguous blocks | `[ch0_s0, ch0_s1, …, ch1_s0, ch1_s1, …]` | +| **XY** | 2-channel x/y pairs | `[x0, y0, x1, y1, …]` | -支持的采样类型:`i8`、`u8`、`i16`、`u16`、`i32`、`u32`、`i64`、`u64`、`f32`、`f64` +Supported sample types: `i8`, `u8`, `i16`, `u16`, `i32`, `u32`, `i64`, `u64`, `f32`, `f64` -### 视图 +### Views -- **文本视图** — 带时间戳、方向标记 (`[IN]`/`[OUT]`)、管线标签的格式化文本流。支持搜索(`Ctrl+F`)、大小写匹配、匹配计数和高亮。 -- **十六进制视图** — hex dump 与 ASCII 侧栏并排展示,可按分组和大小端解析多字节数值。 -- **波形视图** — 基于 [egui_plot](https://github.com/emilk/egui/tree/master/crates/egui_plot) 的实时波形。支持自动缩放、框选缩放、坐标轴锁定、跟随最新数据、浮动窗口、通道图例。 +- **Text View** — formatted text with timestamps, direction markers (`[IN]`/`[OUT]`), and pipeline labels. Built-in search (`Ctrl+F`) with case-sensitive toggle, match counter, and highlighting. +- **Hex View** — hex dump alongside ASCII sidebar. Configurable byte grouping and endianness. +- **Plot View** — real-time waveforms via [egui_plot](https://github.com/emilk/egui/tree/master/crates/egui_plot). Auto-fit, box zoom, axis locking, follow-latest, detached window, channel legend. -### 会话管理 +### Sessions -- **多会话并发** — 标签页切换,每个 Session 独立配置 -- **连接控制** — Connect / Disconnect / Reconnect,支持断线自动重连 -- **运行时重配置** — 修改分帧器/解码器参数无需断开连接 -- **数据发送** — Text 模式(UTF-8,可选换行符)和 Hex 模式(十六进制字节)。支持 `None` / `LF` / `CR` / `CRLF` 四种行尾 -- **环形缓冲** — 默认 10,000 条历史记录,可配置 100–1,000,000 -- **日志到文件** — 每行数据实时写入,1KB 缓冲 + 后台线程,不阻塞 UI -- **搜索** — `Ctrl+F` 呼出搜索栏,大小写敏感切换,F3/Shift+F3 前后跳转 +- **Multi-session** — tabbed interface, each session independently configured +- **Connection control** — Connect / Disconnect / Reconnect with auto-reconnect on drop +- **Live reconfiguration** — change framer/decoder settings without restarting +- **Data sending** — Text mode (UTF-8, configurable line endings) and Hex mode (raw bytes). Four line ending options: None / LF / CR / CRLF +- **Ring buffer** — default 10,000 entries, configurable 100–1,000,000 +- **Log to file** — background writer thread with 1 KB buffer, non-blocking +- **Search** — `Ctrl+F` search bar, case-sensitive toggle, F3/Shift+F3 navigation -### Lua 脚本扩展 +### Lua Scripting -内置 LuaJIT 运行时: +Built-in LuaJIT runtime: -- **自定义分帧器** — 实现 `feed(bytes)`、`flush()`、`reset()`、`pending_len()` 四个函数 -- **自定义解码器** — 实现 `decode(frame)` 函数,返回 text/hex/plot/binary 四种类型 -- **会话 API** — `xserial.open()` 创建 Session、`session:on_data()` 事件回调、`session:send()` 发送数据 -- **工具函数** — `xserial.list_ports()`、`xserial.sleep(ms)`、`xserial.poll(limit)`、`xserial.log(msg)` +- **Custom framers** — implement `feed(bytes)`, `flush()`, `reset()`, `pending_len()` +- **Custom decoders** — implement `decode(frame)`, return text/hex/plot/binary +- **Session API** — `xserial.open()` to create sessions, `session:on_data()` for event callbacks, `session:send()` to transmit data +- **Utilities** — `xserial.list_ports()`, `xserial.sleep(ms)`, `xserial.poll(limit)`, `xserial.log(msg)` -### 快捷键 +### Keyboard Shortcuts -| 快捷键 | 操作 | -|--------|------| -| `Ctrl+N` | 新建会话 | -| `Ctrl+E` | 编辑当前会话 | -| `Ctrl+W` | 删除当前会话 | -| `Ctrl+F5` | 切换连接 | -| `Ctrl+T` / `Ctrl+H` / `Ctrl+P` | 切换到文本 / 十六进制 / 波形视图 | -| `Ctrl+Tab` / `Ctrl+Shift+Tab` | 下一个 / 上一个标签页 | -| `Ctrl+L` | 清空输出 | -| `Ctrl+F` | 搜索 | -| `F3` / `Shift+F3` | 上一个 / 下一个匹配 | -| `Ctrl+,` | UI 设置 | -| `Esc` | 关闭浮层 | +| Shortcut | Action | +|----------|--------| +| `Ctrl+N` | New session | +| `Ctrl+E` | Edit current session | +| `Ctrl+W` | Delete current session | +| `Ctrl+F5` | Toggle connection | +| `Ctrl+T` / `Ctrl+H` / `Ctrl+P` | Switch to Text / Hex / Plot view | +| `Ctrl+Tab` / `Ctrl+Shift+Tab` | Next / Previous tab | +| `Ctrl+L` | Clear output | +| `Ctrl+F` | Search | +| `F3` / `Shift+F3` | Next / Previous match | +| `Ctrl+,` | UI settings | +| `Esc` | Close overlay | --- -## 快速开始 +## Quick Start -### 前置条件 +### Prerequisites -| 平台 | 依赖 | -|------|------| -| **Linux** | `libudev-dev`(`apt install libudev-dev`) | -| **macOS** | 无需额外依赖 | -| **Windows** | 无需额外依赖 | -| **所有平台** | Rust ≥ 1.85、C 编译器(GCC / Clang / MSVC) | +| Platform | Dependencies | +|----------|-------------| +| **Linux** | `libudev-dev` (`apt install libudev-dev`) | +| **macOS** | None | +| **Windows** | None | +| **All** | Rust ≥ 1.85, C compiler (GCC / Clang / MSVC) | -### 构建与运行 +### Build & Run ```bash -# 克隆项目 git clone https://github.com/your-org/xserial.git cd xserial -# 编译运行 cargo run -p xserial-gui -# 运行测试 -cargo test --workspace # ~308 个测试 +# Run tests +cargo test --workspace # ~308 tests cargo clippy --workspace --all-targets -- -D warnings ``` -### 发布构建 +### Release Build ```bash cargo build -p xserial-gui --release -# 二进制位于 target/release/xserial-gui (Linux/macOS) -# 或 target/release/xserial-gui.exe (Windows) +# Binary: target/release/xserial-gui (Linux/macOS) +# target/release/xserial-gui.exe (Windows) ``` --- -## 完整示例:无人机遥测解析 +## Walkthrough: Drone Telemetry -以 Betaflight/INAV 飞控遥测为例,数据格式为: +Parse Betaflight/INAV flight controller telemetry in the format: ``` AHRS q:1.0000,0.0998,0.0499,0.0200|YPR:8.87,4.44,2.96|Gyro:14.78,8.87,5.92|RC:1559,1544,1500,1519|M:1612,1588,1603,1597|L:0 F:1 C:0 ``` -### 步骤 1:启动测试数据源 +### Step 1: Start the data source ```bash python tools/test_drone.py --rate 10 --port 8091 ``` -输出: +### Step 2: Configure the session -``` -Listening on 127.0.0.1:8091, waiting for connections... -``` +In xserial-gui, create a session with two pipelines: -### 步骤 2:配置 Session - -在 xserial-gui 中创建 Session: - -| 配置项 | 值 | -|--------|-----| +| Setting | Value | +|---------|-------| | Transport | `TCP 127.0.0.1:8091` | -| Pipeline 1 | Framer: `Line` → Decoder: `Lua` → 选择 `examples/drone_text.lua` | -| Pipeline 2 | Framer: `Line` → Decoder: `Lua` → 选择 `examples/drone_plot.lua` | +| Pipeline 1 | Framer: `Line` → Decoder: `Lua` → `examples/drone_text.lua` | +| Pipeline 2 | Framer: `Line` → Decoder: `Lua` → `examples/drone_plot.lua` | -### 步骤 3:查看结果 +### Step 3: View the results -- **文本视图** — 显示格式化的传感器数据 -- **波形视图** — 显示 Gyro 三轴实时曲线 (gz/gy/gx) +- **Text View** — formatted sensor readouts +- **Plot View** — real-time gyroscope curves (gz/gy/gx) -`examples/drone_plot.lua` 的核心逻辑: +The decoder in `examples/drone_plot.lua`: ```lua return { @@ -197,63 +191,59 @@ return { --- -## Lua 脚本开发指南 +## Lua Scripting Guide -### 分帧器 API +### Framer API -分帧器将原始字节流切分为帧,Lua 脚本必须返回包含以下函数的 table: +A Lua framer splits raw bytes into frames. The script must return a table with these functions: ```lua return { - -- 输入新到达的字节,返回帧数组(Lua strings) feed = function(bytes) - -- bytes: Lua string(原始字节) - -- 返回: { frame1, frame2, ... } 或 nil + -- bytes: Lua string (raw bytes) + -- Returns: { frame1, frame2, ... } or nil end, - -- 刷新缓冲区中残留的数据 flush = function() - -- 返回: 最后一帧(Lua string)或 nil + -- Returns: last buffered frame (string) or nil end, - -- 重置内部状态 reset = function() end, - -- 返回缓冲区中待处理的字节数 pending_len = function() - -- 返回: number + -- Returns: number of bytes pending in buffer end, } ``` -参考实现:`tests/lua_line_framer.lua`(按 `\n` 分割的行分帧器) +Reference: `tests/lua_line_framer.lua` (line-based framer splitting on `\n`). -### 解码器 API +### Decoder API -解码器将帧解析为结构化数据,Lua 脚本必须返回包含 `decode` 函数的 table: +A Lua decoder parses a frame into structured data. The script must return a table with a `decode` function: ```lua return { decode = function(frame) - -- frame: Lua string(来自分帧器的一帧) - -- 返回 nil → 跳过此帧 - -- 返回 string → 自动视为 Text - -- 返回 table → 必须包含 kind 字段 + -- frame: Lua string (one frame from the framer) + -- Returns nil → skip this frame + -- Returns string → treated as Text + -- Returns table → must contain "kind" field end, } ``` -**返回值格式:** +**Return value formats:** -| `kind` | 必需字段 | 可选字段 | 用途 | -|--------|----------|----------|------| -| `"text"` | `data: string` | — | 文本视图 | -| `"hex"` | `data: string` | — | 十六进制视图 | -| `"binary"` | `data: string` | — | 原始二进制 | -| `"plot"` | `channels: {{number,…},…}` | `sample_type`、`format` | 波形视图 | +| `kind` | Required | Optional | Purpose | +|--------|----------|----------|---------| +| `"text"` | `data: string` | — | Text view | +| `"hex"` | `data: string` | — | Hex view | +| `"binary"` | `data: string` | — | Raw bytes | +| `"plot"` | `channels: {{number,…},…}` | `sample_type`, `format` | Plot view | -**Plot 返回值示例:** +**Plot return value example:** ```lua return { @@ -262,16 +252,16 @@ return { { 1.0, 2.0, 3.0 }, -- channel 0 { 4.0, 5.0, 6.0 }, -- channel 1 }, - sample_type = "F64", -- 默认 F64,可选 I8/U8/I16/U16/I32/U32/I64/U64/F32 - format = "Block", -- 默认 Interleaved,可选 Block/XY + sample_type = "F64", -- default F64; also I8/U8/I16/U32/U64/F32 + format = "Block", -- default Interleaved; also Block/XY } ``` -更多示例见 `examples/` 目录。 +More examples in `examples/`. --- -## 架构 +## Architecture ``` ┌──────────────────────────────────────────────────┐ @@ -286,16 +276,16 @@ return { └──────────────────────────────────────────────────┘ ``` -| Crate | 类型 | 职责 | -|-------|------|------| -| `xserial-core` | library | 传输层(Serial/TCP/UDP)、分帧器(Line/Fixed/Length/COBS/Mixed/Lua)、协议解码器(Text/Hex/Plot)、MultiPipeline | -| `xserial-client` | library | Session 生命周期管理、SessionManager、事件广播(tokio broadcast)、RingBuffer 历史、Lua 运行时及会话 API | -| `xserial-gui` | binary | egui 桌面应用,包含 sidebar/config/console/text/hex/plot 面板、键盘快捷键、字体管理、性能分析 | -| `xserial-tui` | binary | ratatui 终端应用(功能未对齐 GUI,仍在开发中) | +| Crate | Type | Purpose | +|-------|------|---------| +| `xserial-core` | library | Transport (Serial/TCP/UDP), framers (Line/Fixed/Length/COBS/Mixed/Lua), decoders (Text/Hex/Plot), MultiPipeline | +| `xserial-client` | library | Session lifecycle, SessionManager, event broadcast (tokio broadcast), RingBuffer history, Lua runtime & session API | +| `xserial-gui` | binary | egui desktop app: sidebar, config, console, text/hex/plot panels, keyboard shortcuts, font management, profiling | +| `xserial-tui` | binary | ratatui terminal app (feature-incomplete, under development) | -**依赖方向:** `core ← client ← {gui, tui}` +**Dependency flow:** `core ← client ← {gui, tui}` -**数据流:** +**Data flow:** ``` [Transport] → read bytes → [MultiPipeline] @@ -304,88 +294,84 @@ return { → ... ``` -每条管线独立分帧、解码,互不干扰。只有成功解码的管线产生输出。 +Each pipeline frames and decodes independently. Only successful decodes produce output. --- -## 配置与持久化 +## Configuration & Persistence -GUI 状态自动保存,路径遵循各平台规范: +GUI state is saved automatically to platform-standard locations: -| 平台 | 路径 | -|------|------| -| Linux | `$XDG_CONFIG_HOME/xserial/gui-state.json` 或 `~/.config/xserial/gui-state.json` | +| Platform | Path | +|----------|------| +| Linux | `$XDG_CONFIG_HOME/xserial/gui-state.json` or `~/.config/xserial/gui-state.json` | | macOS | `~/Library/Application Support/xserial/gui-state.json` | | Windows | `%APPDATA%\xserial\gui-state.json` | -持久化的内容包括:Session 配置(传输参数、管线设置)、日志开关及路径、活动标签页、显示选项。 +Persisted data includes: session configurations (transport, pipelines), log settings, active tab, and display options. -日志文件默认保存在配置目录的 `logs/` 子目录下,文件命名格式为 `session_{id}_{timestamp}.log`。 +Log files are written to `logs/` under the config directory, named `session_{id}_{timestamp}.log`. --- -## 开发工具 +## Development Tools -### 测试数据生成器 +### Test Data Generators ```bash -# Plot 波形测试数据 +# Plot waveform test data python tools/test_plot.py --wire-format mixed --host 127.0.0.1 --port 8091 python tools/test_plot.py --wire-format mixed --format xy --channels 2 python tools/test_plot.py --wire-format raw --channels 2 --framelen 256 -# 无人机遥测测试数据 +# Drone telemetry test data python tools/test_drone.py --rate 10 --port 8092 ``` -### 性能分析 +### Profiling ```bash RUST_LOG=xserial_gui::perf=info XSERIAL_GUI_PROFILE=1 cargo run -p xserial-gui XSERIAL_GUI_PROFILE_INTERVAL_MS=500 cargo run -p xserial-gui ``` -输出每帧的耗时、事件 drain 耗时、text/hex/plot 渲染耗时、plot 点数统计。 - -### 日志 +### Tracing ```bash -RUST_LOG=info cargo run -p xserial-gui # 应用日志 -RUST_LOG=xserial_gui=debug cargo run -p xserial-gui # 详细日志 +RUST_LOG=info cargo run -p xserial-gui +RUST_LOG=xserial_gui=debug cargo run -p xserial-gui ``` -使用 `tracing-subscriber` + `RUST_LOG` 环境变量控制。 - -### 项目结构 +### Project Structure ``` crates/ - xserial-core/ # 传输、分帧、协议 - xserial-client/ # 会话管理、Lua 运行时 - xserial-gui/ # egui 桌面应用 - xserial-tui/ # ratatui 终端应用 -examples/ # Lua 脚本示例 - drone_plot.lua # 飞控遥测波形解码器 - drone_text.lua # 飞控遥测文本解码器 -tests/ # Lua 测试 fixture -tools/ # 开发辅助工具 - test_plot.py # 波形测试数据生成器 - test_drone.py # 飞控测试数据生成器 - test_plot_serial.c # C 串口波形测试客户端 - test_text_serial.c # C 串口文本测试客户端 - xs_mixed_plot.h # MixedTextPlot 协议参考头文件 + xserial-core/ # Transport, framing, protocol + xserial-client/ # Session management, Lua runtime + xserial-gui/ # egui desktop application + xserial-tui/ # ratatui terminal application +examples/ # Lua script examples + drone_plot.lua # Drone telemetry plot decoder + drone_text.lua # Drone telemetry text decoder +tests/ # Lua test fixtures +tools/ # Development utilities + test_plot.py # Waveform test data generator + test_drone.py # Drone test data generator + test_plot_serial.c # C serial plot test client + test_text_serial.c # C serial text test client + xs_mixed_plot.h # MixedTextPlot protocol reference ``` --- -## 技术栈 +## Tech Stack -- **运行时**:tokio (multi-thread) -- **串口**:`tokio-serial` + `serialport` -- **GUI**:egui + egui_plot -- **Lua**:mlua 0.11, LuaJIT (vendored 编译), async/serde/send -- **事件分发**:`tokio::sync::broadcast`(多订阅者) -- **零 feature flags**、零 build script、零条件编译 +- **Runtime**: tokio (multi-threaded) +- **Serial**: `tokio-serial` + `serialport` +- **GUI**: egui + egui_plot +- **Lua**: mlua 0.11, LuaJIT (vendored), async/serde/send +- **Events**: `tokio::sync::broadcast` (multi-subscriber) +- **Zero feature flags**, zero build scripts, zero conditional compilation ## License diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 0000000..da0c939 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,394 @@ +# xserial + +**跨平台串口 / TCP / UDP 数据观测工具** — 可配置分帧、协议解码、多会话管理、实时波形绘图,单二进制零依赖。 + +基于 Rust + [egui](https://github.com/emilk/egui) 构建,支持 Lua 脚本扩展。 + +[English](README.md) + +--- + +## 目录 + +- [功能特性](#功能特性) +- [快速开始](#快速开始) +- [完整示例:无人机遥测解析](#完整示例无人机遥测解析) +- [Lua 脚本开发指南](#lua-脚本开发指南) +- [架构](#架构) +- [配置与持久化](#配置与持久化) +- [开发工具](#开发工具) +- [技术栈](#技术栈) +- [License](#license) + +--- + +## 功能特性 + +### 传输层 + +| 类型 | 说明 | 配置项 | +|------|------|--------| +| **Serial** | 串口通信 | 端口名、波特率 (300–12M)、数据位 (5/6/7/8)、校验位 (None/Odd/Even)、停止位 (1/2)、流控 (None/Software/Hardware)、DTR/RTS 控制 | +| **TCP** | TCP 客户端 | 目标地址 `host:port` | +| **UDP** | UDP 通信 | 绑定地址 `host:port`,可选远端地址 | + +### 分帧器(Framer) + +将原始字节流切分为独立帧。每个 Session 可配置**多条独立管线**,同一字节流并行送入多个 framer→decoder 链路。 + +| 分帧器 | 说明 | 配置参数 | +|--------|------|----------| +| **Line** | 按 `\n` 分割文本行 | `strip_cr`(去除 `\r`)、`max_line_len`(最大行长度) | +| **Fixed** | 固定字节数为一帧 | `frame_len`(帧长度) | +| **Length** | 长度前缀协议 | `len_bytes` (1/2/4/8)、`endian` (大小端)、`length_includes_self`、`max_payload` | +| **COBS** | [Consistent Overhead Byte Stuffing](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) 编码 | `max_frame`(最大帧长) | +| **MixedTextPlot** | 单连接混合文本行 + COBS 编码的 plot 帧 | `strip_cr`、`max_line_len`、`max_plot_frame` | +| **Lua** | 用户自定义分帧脚本 | `script_path`(Lua 脚本路径) | + +### 解码器(Decoder) + +将帧数据解析为可展示的内容。 + +| 解码器 | 输出类型 | 配置参数 | +|--------|----------|----------| +| **Text** | 文本 | `encoding`(UTF-8 / Latin1 / ASCII) | +| **Hex** | 十六进制 | `uppercase`、`separator`、`bytes_per_group`、`endian` | +| **Plot** | 波形数据 | `sample_type` (i8–f64)、`endian`、`channels` (1–64)、`format` (Interleaved / Block / XY) | +| **MixedTextPlot** | 混合文本 + 波形 | `encoding` | +| **Lua** | 自定义 | `script_path`(Lua 脚本路径) | + +**Plot 采样格式:** + +| 格式 | 说明 | 字节排列 | +|------|------|----------| +| **Interleaved** | 多通道交叉排列 | `[ch0_s0, ch1_s0, ch2_s0, ch0_s1, ch1_s1, …]` | +| **Block** | 按通道分块排列 | `[ch0_s0, ch0_s1, …, ch1_s0, ch1_s1, …]` | +| **XY** | 2 通道交替 x/y | `[x0, y0, x1, y1, …]` | + +支持的采样类型:`i8`、`u8`、`i16`、`u16`、`i32`、`u32`、`i64`、`u64`、`f32`、`f64` + +### 视图 + +- **文本视图** — 带时间戳、方向标记 (`[IN]`/`[OUT]`)、管线标签的格式化文本流。支持搜索(`Ctrl+F`)、大小写匹配、匹配计数和高亮。 +- **十六进制视图** — hex dump 与 ASCII 侧栏并排展示,可按分组和大小端解析多字节数值。 +- **波形视图** — 基于 [egui_plot](https://github.com/emilk/egui/tree/master/crates/egui_plot) 的实时波形。支持自动缩放、框选缩放、坐标轴锁定、跟随最新数据、浮动窗口、通道图例。 + +### 会话管理 + +- **多会话并发** — 标签页切换,每个 Session 独立配置 +- **连接控制** — Connect / Disconnect / Reconnect,支持断线自动重连 +- **运行时重配置** — 修改分帧器/解码器参数无需断开连接 +- **数据发送** — Text 模式(UTF-8,可选换行符)和 Hex 模式(十六进制字节)。支持 `None` / `LF` / `CR` / `CRLF` 四种行尾 +- **环形缓冲** — 默认 10,000 条历史记录,可配置 100–1,000,000 +- **日志到文件** — 每行数据实时写入,1KB 缓冲 + 后台线程,不阻塞 UI +- **搜索** — `Ctrl+F` 呼出搜索栏,大小写敏感切换,F3/Shift+F3 前后跳转 + +### Lua 脚本扩展 + +内置 LuaJIT 运行时: + +- **自定义分帧器** — 实现 `feed(bytes)`、`flush()`、`reset()`、`pending_len()` 四个函数 +- **自定义解码器** — 实现 `decode(frame)` 函数,返回 text/hex/plot/binary 四种类型 +- **会话 API** — `xserial.open()` 创建 Session、`session:on_data()` 事件回调、`session:send()` 发送数据 +- **工具函数** — `xserial.list_ports()`、`xserial.sleep(ms)`、`xserial.poll(limit)`、`xserial.log(msg)` + +### 快捷键 + +| 快捷键 | 操作 | +|--------|------| +| `Ctrl+N` | 新建会话 | +| `Ctrl+E` | 编辑当前会话 | +| `Ctrl+W` | 删除当前会话 | +| `Ctrl+F5` | 切换连接 | +| `Ctrl+T` / `Ctrl+H` / `Ctrl+P` | 切换到文本 / 十六进制 / 波形视图 | +| `Ctrl+Tab` / `Ctrl+Shift+Tab` | 下一个 / 上一个标签页 | +| `Ctrl+L` | 清空输出 | +| `Ctrl+F` | 搜索 | +| `F3` / `Shift+F3` | 上一个 / 下一个匹配 | +| `Ctrl+,` | UI 设置 | +| `Esc` | 关闭浮层 | + +--- + +## 快速开始 + +### 前置条件 + +| 平台 | 依赖 | +|------|------| +| **Linux** | `libudev-dev`(`apt install libudev-dev`) | +| **macOS** | 无需额外依赖 | +| **Windows** | 无需额外依赖 | +| **所有平台** | Rust ≥ 1.85、C 编译器(GCC / Clang / MSVC) | + +### 构建与运行 + +```bash +# 克隆项目 +git clone https://github.com/your-org/xserial.git +cd xserial + +# 编译运行 +cargo run -p xserial-gui + +# 运行测试 +cargo test --workspace # ~308 个测试 +cargo clippy --workspace --all-targets -- -D warnings +``` + +### 发布构建 + +```bash +cargo build -p xserial-gui --release +# 二进制位于 target/release/xserial-gui (Linux/macOS) +# 或 target/release/xserial-gui.exe (Windows) +``` + +--- + +## 完整示例:无人机遥测解析 + +以 Betaflight/INAV 飞控遥测为例,数据格式为: + +``` +AHRS q:1.0000,0.0998,0.0499,0.0200|YPR:8.87,4.44,2.96|Gyro:14.78,8.87,5.92|RC:1559,1544,1500,1519|M:1612,1588,1603,1597|L:0 F:1 C:0 +``` + +### 步骤 1:启动测试数据源 + +```bash +python tools/test_drone.py --rate 10 --port 8091 +``` + +输出: + +``` +Listening on 127.0.0.1:8091, waiting for connections... +``` + +### 步骤 2:配置 Session + +在 xserial-gui 中创建 Session: + +| 配置项 | 值 | +|--------|-----| +| Transport | `TCP 127.0.0.1:8091` | +| Pipeline 1 | Framer: `Line` → Decoder: `Lua` → 选择 `examples/drone_text.lua` | +| Pipeline 2 | Framer: `Line` → Decoder: `Lua` → 选择 `examples/drone_plot.lua` | + +### 步骤 3:查看结果 + +- **文本视图** — 显示格式化的传感器数据 +- **波形视图** — 显示 Gyro 三轴实时曲线 (gz/gy/gx) + +`examples/drone_plot.lua` 的核心逻辑: + +```lua +return { + decode = function(frame) + local gz, gy, gx = frame:match("Gyro:([%d%.%-]+),([%d%.%-]+),([%d%.%-]+)") + return { + kind = "plot", + channels = { { tonumber(gz) }, { tonumber(gy) }, { tonumber(gx) } }, + sample_type = "F64", + format = "Block", + } + end, +} +``` + +--- + +## Lua 脚本开发指南 + +### 分帧器 API + +分帧器将原始字节流切分为帧,Lua 脚本必须返回包含以下函数的 table: + +```lua +return { + -- 输入新到达的字节,返回帧数组(Lua strings) + feed = function(bytes) + -- bytes: Lua string(原始字节) + -- 返回: { frame1, frame2, ... } 或 nil + end, + + -- 刷新缓冲区中残留的数据 + flush = function() + -- 返回: 最后一帧(Lua string)或 nil + end, + + -- 重置内部状态 + reset = function() + end, + + -- 返回缓冲区中待处理的字节数 + pending_len = function() + -- 返回: number + end, +} +``` + +参考实现:`tests/lua_line_framer.lua`(按 `\n` 分割的行分帧器) + +### 解码器 API + +解码器将帧解析为结构化数据,Lua 脚本必须返回包含 `decode` 函数的 table: + +```lua +return { + decode = function(frame) + -- frame: Lua string(来自分帧器的一帧) + -- 返回 nil → 跳过此帧 + -- 返回 string → 自动视为 Text + -- 返回 table → 必须包含 kind 字段 + end, +} +``` + +**返回值格式:** + +| `kind` | 必需字段 | 可选字段 | 用途 | +|--------|----------|----------|------| +| `"text"` | `data: string` | — | 文本视图 | +| `"hex"` | `data: string` | — | 十六进制视图 | +| `"binary"` | `data: string` | — | 原始二进制 | +| `"plot"` | `channels: {{number,…},…}` | `sample_type`、`format` | 波形视图 | + +**Plot 返回值示例:** + +```lua +return { + kind = "plot", + channels = { + { 1.0, 2.0, 3.0 }, -- channel 0 + { 4.0, 5.0, 6.0 }, -- channel 1 + }, + sample_type = "F64", -- 默认 F64,可选 I8/U8/I16/U16/I32/U32/I64/U64/F32 + format = "Block", -- 默认 Interleaved,可选 Block/XY +} +``` + +更多示例见 `examples/` 目录。 + +--- + +## 架构 + +``` +┌──────────────────────────────────────────────────┐ +│ xserial-gui (egui) xserial-tui (ratatui) │ +├──────────────────────────────────────────────────┤ +│ xserial-client │ +│ SessionManager · Session · Config · History │ +│ Lua Runtime (mlua / LuaJIT) │ +├──────────────────────────────────────────────────┤ +│ xserial-core │ +│ Transport ──▶ Frame ──▶ Protocol ──▶ Pipeline │ +└──────────────────────────────────────────────────┘ +``` + +| Crate | 类型 | 职责 | +|-------|------|------| +| `xserial-core` | library | 传输层(Serial/TCP/UDP)、分帧器(Line/Fixed/Length/COBS/Mixed/Lua)、协议解码器(Text/Hex/Plot)、MultiPipeline | +| `xserial-client` | library | Session 生命周期管理、SessionManager、事件广播(tokio broadcast)、RingBuffer 历史、Lua 运行时及会话 API | +| `xserial-gui` | binary | egui 桌面应用,包含 sidebar/config/console/text/hex/plot 面板、键盘快捷键、字体管理、性能分析 | +| `xserial-tui` | binary | ratatui 终端应用(功能未对齐 GUI,仍在开发中) | + +**依赖方向:** `core ← client ← {gui, tui}` + +**数据流:** + +``` +[Transport] → read bytes → [MultiPipeline] + → Pipeline 1: Framer → Decoder → DecodedEntry → broadcast → GUI buffers + → Pipeline 2: Framer → Decoder → DecodedEntry → broadcast → GUI buffers + → ... +``` + +每条管线独立分帧、解码,互不干扰。只有成功解码的管线产生输出。 + +--- + +## 配置与持久化 + +GUI 状态自动保存,路径遵循各平台规范: + +| 平台 | 路径 | +|------|------| +| Linux | `$XDG_CONFIG_HOME/xserial/gui-state.json` 或 `~/.config/xserial/gui-state.json` | +| macOS | `~/Library/Application Support/xserial/gui-state.json` | +| Windows | `%APPDATA%\xserial\gui-state.json` | + +持久化的内容包括:Session 配置(传输参数、管线设置)、日志开关及路径、活动标签页、显示选项。 + +日志文件默认保存在配置目录的 `logs/` 子目录下,文件命名格式为 `session_{id}_{timestamp}.log`。 + +--- + +## 开发工具 + +### 测试数据生成器 + +```bash +# Plot 波形测试数据 +python tools/test_plot.py --wire-format mixed --host 127.0.0.1 --port 8091 +python tools/test_plot.py --wire-format mixed --format xy --channels 2 +python tools/test_plot.py --wire-format raw --channels 2 --framelen 256 + +# 无人机遥测测试数据 +python tools/test_drone.py --rate 10 --port 8092 +``` + +### 性能分析 + +```bash +RUST_LOG=xserial_gui::perf=info XSERIAL_GUI_PROFILE=1 cargo run -p xserial-gui +XSERIAL_GUI_PROFILE_INTERVAL_MS=500 cargo run -p xserial-gui +``` + +输出每帧的耗时、事件 drain 耗时、text/hex/plot 渲染耗时、plot 点数统计。 + +### 日志 + +```bash +RUST_LOG=info cargo run -p xserial-gui # 应用日志 +RUST_LOG=xserial_gui=debug cargo run -p xserial-gui # 详细日志 +``` + +使用 `tracing-subscriber` + `RUST_LOG` 环境变量控制。 + +### 项目结构 + +``` +crates/ + xserial-core/ # 传输、分帧、协议 + xserial-client/ # 会话管理、Lua 运行时 + xserial-gui/ # egui 桌面应用 + xserial-tui/ # ratatui 终端应用 +examples/ # Lua 脚本示例 + drone_plot.lua # 飞控遥测波形解码器 + drone_text.lua # 飞控遥测文本解码器 +tests/ # Lua 测试 fixture +tools/ # 开发辅助工具 + test_plot.py # 波形测试数据生成器 + test_drone.py # 飞控测试数据生成器 + test_plot_serial.c # C 串口波形测试客户端 + test_text_serial.c # C 串口文本测试客户端 + xs_mixed_plot.h # MixedTextPlot 协议参考头文件 +``` + +--- + +## 技术栈 + +- **运行时**:tokio (multi-thread) +- **串口**:`tokio-serial` + `serialport` +- **GUI**:egui + egui_plot +- **Lua**:mlua 0.11, LuaJIT (vendored 编译), async/serde/send +- **事件分发**:`tokio::sync::broadcast`(多订阅者) +- **零 feature flags**、零 build script、零条件编译 + +## License + +MIT