Compare commits

..

2 Commits

Author SHA1 Message Date
227a459712 Add drone telemetry Lua decoder examples and test data generator
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
2026-06-12 21:28:04 +08:00
367800a426 update README.md
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
2026-06-12 21:15:48 +08:00
65 changed files with 483 additions and 964 deletions

134
AGENTS.md Normal file
View File

@@ -0,0 +1,134 @@
# Repository Guidelines
## Build Prerequisites
- **Linux**: `libudev-dev` (for `serialport`).
- **All platforms**: a C compiler (`cc`, `gcc`, `clang`, or MSVC) — `mlua` uses `features = ["vendored"]` which compiles LuaJIT from source at build time.
- **No pinned toolchain**: all crates use `edition = "2024"` (requires Rust ≥ 1.85). No `rust-toolchain.toml`; builds with whatever `rustc` is on `PATH`.
## Project Structure
`xserial` is a Rust workspace. The root `Cargo.toml` defines four crates in `crates/`, with dependencies flowing:
```
xserial-core (no internal deps — transport, framing, protocol, pipeline)
xserial-client (depends on xserial-core — sessions, history, commands, Lua)
↑ ↑
xserial-gui xserial-tui
(both depend on xserial-core AND xserial-client)
```
| Crate | Type | What goes here |
|-------|------|---------------|
| `xserial-core` | library (`src/lib.rs`) | `transport/`, `frame/`, `protocol/`, `pipeline.rs` — protocol and I/O. Integration tests: `tests/pipeline.rs`. |
| `xserial-client` | library (`src/lib.rs`) | `session.rs`, `manager.rs`, `config.rs`, `history.rs`, `lua/` — state management and Lua bindings. Integration tests: `tests/session_lifecycle.rs`, `tests/lua_tests.rs`. |
| `xserial-gui` | binary (`src/main.rs`) | egui/eframe app. Panels in `src/panels/`. Font helpers in `src/ui_fonts.rs`. Profiling in `src/perf.rs`. |
| `xserial-tui` | binary (`src/main.rs`) | ratatui/crossterm app. **Still a placeholder** — zero tests, not at feature parity with GUI. |
**Module boundaries**: transport/protocol → `xserial-core`. Session/Lua → `xserial-client`. UI state → `xserial-gui` or `xserial-tui`. Never put I/O logic in the UI crates, never put UI state in the client crate.
## Build, Test, and Development Commands
```bash
cargo check --workspace # fast compile check (all crates)
cargo test --workspace # full suite (~266 tests)
cargo fmt --all # standard Rust formatting
cargo clippy --workspace --all-targets -- -D warnings # lint gate
```
**Run specific tests:**
```bash
cargo test -p xserial-core -- tcp_line_text_utf8
cargo test -p xserial-client -- session_echo_send_and_read
cargo test -p xserial-core -- --nocapture # show test output
# Integration tests only
cargo test -p xserial-core --test pipeline
cargo test -p xserial-client --test session_lifecycle
cargo test -p xserial-client --test lua_tests
```
**Launch:**
```bash
cargo run -p xserial-gui
cargo run -p xserial-tui
```
## Environment & Configuration
### Tracing (all entrypoints)
```bash
RUST_LOG=info cargo run -p xserial-gui
RUST_LOG=xserial_gui::perf=debug cargo run -p xserial-gui
```
`tracing_subscriber::EnvFilter::from_default_env()` reads `RUST_LOG`. The workspace dep `tracing-subscriber` has `features = ["env-filter"]`.
### GUI 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 # custom interval (default 1s)
```
Profiling logs go to target `xserial_gui::perf`.
### State & Config File Paths (runtime, not compile-time)
Uses `env::consts::OS` + env vars — no `cfg(target_os)` gating for path resolution:
| Platform | Root config path |
|----------|-----------------|
| Linux | `$XDG_CONFIG_HOME/xserial/` or `~/.config/xserial/` |
| macOS | `~/Library/Application Support/xserial/` |
| Windows | `%APPDATA%\xserial\` |
State files: `gui-state.json`, `tui-state.json`, `font-settings.json`.
### GUI Plot Testing
```bash
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
```
Configure in GUI: Transport `TCP 127.0.0.1:8091`, Framer `MixedTextPlot`, Decoder `MixedTextPlot`.
The wire format spec lives in `tools/xs_mixed_plot.h` (C header, reference only — not compiled into Rust).
## Coding Style
Standard Rust conventions (`cargo fmt`). No crate-level lint attrs, no `[lints]` table in any `Cargo.toml`. Names: `snake_case` for modules/files/functions/tests, `PascalCase` for types, `SCREAMING_SNAKE_CASE` for constants.
## Testing Guidelines
- **Inline unit tests** (`#[cfg(test)] mod tests`) next to implementation — 24 source files with `#[test]` or `#[tokio::test]`.
- **Integration tests** in `crates/<crate>/tests/*.rs` — 3 files covering pipeline, session lifecycle, and Lua bindings.
- **~266 tests total** — all active (zero `#[ignore]`). Single `#[should_panic]` in `frame/fixed.rs`.
- **All tests are self-contained**: TCP/UDP bind to `127.0.0.1:0` (OS-assigned port). No hardcoded ports. No external services. Serial tests use dummy port names and never open real hardware.
- **Async tests** use `#[tokio::test]` (no `async-std`). **No benchmarks** exist.
- Run `cargo test --workspace` before opening PRs. Add targeted regression tests for transport, framing, parsing, and session-state fixes.
## Known Quirks & Constraints
- **No CI** — no `.github/workflows` or other CI config. Agents must self-verify with `cargo test --workspace` and `cargo clippy --workspace --all-targets -- -D warnings`.
- **No feature flags** — zero `[features]` in any `Cargo.toml`. No `#[cfg(feature)]` in any source.
- **No build scripts** — zero `build.rs` files. No codegen. No `include!`/`include_str!`/`include_bytes!`.
- **All `unsafe` is test-only** — constructing noop wakers for poll-based unit tests in `transport/`. No non-test `unsafe` anywhere.
- **`xserial-tui` is a stub** — no tests, minimal implementation. GUI is the primary target.
- **Platform font directories** use `#[cfg(target_os)]` in `ui_fonts.rs` (three blocks: Windows, macOS, Linux/BSD).
- **`tokio` features differ by build**: `xserial-client` uses `["sync", "time"]` for production, `["full"]` for dev-dependencies (tests need net/IO).
## Commit & PR Guidelines
Short, imperative subjects (`Persist GUI font settings`), occasional `feat:` prefix for major additions. PRs: state which crate(s) changed, list validation commands, include screenshots/recordings for GUI/TUI changes. Explicitly call out protocol, transport, or Lua API compatibility impacts.
## Reference
- `tools/test_plot.py --help` — TCP plot-frame generator options.
- `tools/xs_mixed_plot.h` — wire format spec for MixedTextPlot (COBS-framed binary plot + text on one stream).

136
Cargo.lock generated
View File

@@ -3262,74 +3262,6 @@ dependencies = [
"futures-io", "futures-io",
] ]
[[package]]
name = "pipeview-client"
version = "0.1.0"
dependencies = [
"mlua",
"pipeview-core",
"serde",
"serde_json",
"thiserror 2.0.18",
"tokio",
"tracing",
"tracing-subscriber",
]
[[package]]
name = "pipeview-core"
version = "0.1.0"
dependencies = [
"async-trait",
"bytes",
"hex",
"nom 8.0.0",
"serde",
"serde_json",
"serialport",
"thiserror 2.0.18",
"tokio",
"tokio-serial",
"tracing",
]
[[package]]
name = "pipeview-gui"
version = "0.1.0"
dependencies = [
"eframe",
"egui",
"egui_plot",
"hex",
"pipeview-client",
"pipeview-core",
"serde",
"serde_json",
"tokio",
"tracing",
"tracing-subscriber",
]
[[package]]
name = "pipeview-tui"
version = "0.1.0"
dependencies = [
"clap",
"crossterm 0.28.1",
"hex",
"image",
"mlua",
"pipeview-client",
"pipeview-core",
"ratatui",
"serde",
"serde_json",
"tokio",
"tracing",
"tracing-appender",
"tracing-subscriber",
]
[[package]] [[package]]
name = "pkg-config" name = "pkg-config"
version = "0.3.33" version = "0.3.33"
@@ -5818,6 +5750,74 @@ version = "0.8.28"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3ae8337f8a065cfc972643663ea4279e04e7256de865aa66fe25cec5fb912d3f" checksum = "3ae8337f8a065cfc972643663ea4279e04e7256de865aa66fe25cec5fb912d3f"
[[package]]
name = "xserial-client"
version = "0.1.0"
dependencies = [
"mlua",
"serde",
"serde_json",
"thiserror 2.0.18",
"tokio",
"tracing",
"tracing-subscriber",
"xserial-core",
]
[[package]]
name = "xserial-core"
version = "0.1.0"
dependencies = [
"async-trait",
"bytes",
"hex",
"nom 8.0.0",
"serde",
"serde_json",
"serialport",
"thiserror 2.0.18",
"tokio",
"tokio-serial",
"tracing",
]
[[package]]
name = "xserial-gui"
version = "0.1.0"
dependencies = [
"eframe",
"egui",
"egui_plot",
"hex",
"serde",
"serde_json",
"tokio",
"tracing",
"tracing-subscriber",
"xserial-client",
"xserial-core",
]
[[package]]
name = "xserial-tui"
version = "0.1.0"
dependencies = [
"clap",
"crossterm 0.28.1",
"hex",
"image",
"mlua",
"ratatui",
"serde",
"serde_json",
"tokio",
"tracing",
"tracing-appender",
"tracing-subscriber",
"xserial-client",
"xserial-core",
]
[[package]] [[package]]
name = "yoke" name = "yoke"
version = "0.8.2" version = "0.8.2"

View File

@@ -1,10 +1,10 @@
[workspace] [workspace]
resolver = "2" resolver = "2"
members = [ members = [
"crates/pipeview-core", "crates/xserial-core",
"crates/pipeview-client", "crates/xserial-client",
"crates/pipeview-tui", "crates/xserial-tui",
"crates/pipeview-gui", "crates/xserial-gui",
] ]
[workspace.dependencies] [workspace.dependencies]

387
README.md
View File

@@ -1,96 +1,83 @@
# pipeview # xserial
**跨平台串口 / TCP / UDP 数据观测工具** — 可配置分帧、协议解码、多会话管理、实时波形绘图,单二进制零依赖。 **跨平台串口 / TCP / UDP 数据观测工具** — 可配置分帧、协议解码、多会话管理、实时波形绘图,单二进制零依赖。
基于 Rust + [egui](https://github.com/emilk/egui) 构建,支持 Lua 脚本扩展。 基于 Rust + [egui](https://github.com/emilk/egui) 构建,支持 Lua 脚本扩展。
[English](README_en.md)
---
## 目录
- [功能特性](#功能特性)
- [快速开始](#快速开始)
- [完整示例:无人机遥测解析](#完整示例无人机遥测解析)
- [Lua 脚本开发指南](#lua-脚本开发指南)
- [架构](#架构)
- [配置与持久化](#配置与持久化)
- [开发工具](#开发工具)
- [技术栈](#技术栈)
- [License](#license)
--- ---
## 功能特性 ## 功能特性
### 传输层 ### 传输层
| 类型 | 说明 | 配置项 | - **串口** — 波特率 (30012M)、数据位 (5/6/7/8)、校验位 (None/Odd/Even)、停止位 (1/2)、流控 (None/Software/Hardware)、DTR/RTS 控制
|------|------|--------| - **TCP** — 原始 TCP 客户端
| **Serial** | 串口通信 | 端口名、波特率 (30012M)、数据位 (5/6/7/8)、校验位 (None/Odd/Even)、停止位 (1/2)、流控 (None/Software/Hardware)、DTR/RTS 控制 | - **UDP** — 绑定地址 + 可选远端地址
| **TCP** | TCP 客户端 | 目标地址 `host:port` |
| **UDP** | UDP 通信 | 绑定地址 `host:port`,可选远端地址 |
### 分帧Framer ### 分帧与解码
将原始字节流切分为独立帧。每个 Session 可配置**多条独立管线**同一字节流并行送入多个 framer→decoder 链路。 每个 Session 可配置**多条独立管线**同一字节流并行送入多个 framer→decoder 链路。
| 分帧器 | 说明 | 配置参数 | | 分帧器 | 说明 |
|--------|------|----------| |--------|------|
| **Line** | 按 `\n` 分割文本行 | `strip_cr`(去除 `\r`)、`max_line_len`(最大行长度) | | Line | 按 `\n` 分割,可选去除 `\r` |
| **Fixed** | 固定字节数为一帧 | `frame_len`(帧长度) | | Fixed | 固定字节数为一帧 |
| **Length** | 长度前缀协议 | `len_bytes` (1/2/4/8)、`endian` (大小端)、`length_includes_self``max_payload` | | Length | 长度前缀协议 (1/2/4/8 字节头) |
| **COBS** | [Consistent Overhead Byte Stuffing](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) 编码 | `max_frame`(最大帧长) | | COBS | [Consistent Overhead Byte Stuffing](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) |
| **MixedTextPlot** | 单连接混合文本行 + COBS 编码的 plot 帧 | `strip_cr``max_line_len``max_plot_frame` | | MixedTextPlot | 单连接混合文本行 + COBS plot 帧 |
| **Lua** | 用户自定义分帧脚本 | `script_path`Lua 脚本路径) | | Lua | 用户自定义分帧脚本 |
### 解码器Decoder | 解码器 | 输出 |
|--------|------|
将帧数据解析为可展示的内容。 | Text | UTF-8 / Latin1 / ASCII |
| Hex | 可配置分组、大小端 |
| 解码器 | 输出类型 | 配置参数 | | Plot | Interleaved / Block / XY 波形 (i8f64) |
|--------|----------|----------| | MixedTextPlot | 混合文本 + 波形 |
| **Text** | 文本 | `encoding`UTF-8 / Latin1 / ASCII | | Lua | 用户自定义解码脚本 |
| **Hex** | 十六进制 | `uppercase``separator``bytes_per_group``endian` |
| **Plot** | 波形数据 | `sample_type` (i8f64)、`endian``channels` (164)、`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 侧栏并排展示,可按分组和大小端解析多字节数值。 - **十六进制视图** — 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 条历史记录,可配置 1001,000,000 - **日志到文件** — 后台线程写入,不阻塞 UI
- **日志到文件** — 每行数据实时写入1KB 缓冲 + 后台线程,不阻塞 UI - 配置自动持久化到 `gui-state.json`
- **搜索** — `Ctrl+F` 呼出搜索栏大小写敏感切换F3/Shift+F3 前后跳转
### Lua 脚本扩展 ### Lua 脚本
内置 LuaJIT 运行时: 内置 LuaJIT 运行时,自定义分帧和解码逻辑
- **自定义分帧器** — 实现 `feed(bytes)``flush()``reset()``pending_len()` 四个函数 ```lua
- **自定义解码器** — 实现 `decode(frame)` 函数,返回 text/hex/plot/binary 四种类型 local buffer = ""
- **会话 API** — `pipeview.open()` 创建 Session、`session:on_data()` 事件回调、`session:send()` 发送数据 return {
- **工具函数** — `pipeview.list_ports()``pipeview.sleep(ms)``pipeview.poll(limit)``pipeview.log(msg)` feed = function(bytes)
buffer = buffer .. bytes
local frames = {}
while true do
local i = buffer:find("\n", 1, true)
if not i then break end
frames[#frames + 1] = buffer:sub(1, i - 1)
buffer = buffer:sub(i + 1)
end
return frames
end,
flush = function()
if #buffer == 0 then return nil end
local frame = buffer; buffer = ""; return frame
end,
reset = function() buffer = "" end,
pending_len = function() return #buffer end,
}
```
会话 API`xserial.open()``xserial.list_ports()``xserial.sleep()``xserial.poll()``xserial.log()``session:on_data()``session:send()`
### 快捷键 ### 快捷键
@@ -100,11 +87,9 @@
| `Ctrl+E` | 编辑当前会话 | | `Ctrl+E` | 编辑当前会话 |
| `Ctrl+W` | 删除当前会话 | | `Ctrl+W` | 删除当前会话 |
| `Ctrl+F5` | 切换连接 | | `Ctrl+F5` | 切换连接 |
| `Ctrl+T` / `Ctrl+H` / `Ctrl+P` | 切换到文本 / 十六进制 / 波形视图 | | `Ctrl+T/H/P` | 切换到文本 / 十六进制 / 波形视图 |
| `Ctrl+Tab` / `Ctrl+Shift+Tab` | 下一个 / 上一个标签页 | | `Ctrl+Tab` / `Ctrl+Shift+Tab` | 下一个 / 上一个标签页 |
| `Ctrl+L` | 清空输出 | | `Ctrl+L` | 清空输出 |
| `Ctrl+F` | 搜索 |
| `F3` / `Shift+F3` | 上一个 / 下一个匹配 |
| `Ctrl+,` | UI 设置 | | `Ctrl+,` | UI 设置 |
| `Esc` | 关闭浮层 | | `Esc` | 关闭浮层 |
@@ -114,162 +99,30 @@
### 前置条件 ### 前置条件
| 平台 | 依赖 | - **Rust ≥ 1.85**
|------|------| - **Linux**: `libudev-dev`serialport 依赖)
| **Linux** | `libudev-dev``apt install libudev-dev` | - **所有平台**: C 编译器mlua 从源码编译 LuaJIT
| **macOS** | 无需额外依赖 |
| **Windows** | 无需额外依赖 |
| **所有平台** | Rust ≥ 1.85、C 编译器GCC / Clang / MSVC |
### 构建与运行 ### 构建与运行
```bash ```bash
# 克隆项目 cargo run -p xserial-gui
git clone https://github.com/your-org/pipeview.git ```
cd pipeview
# 编译运行 ### 测试
cargo run -p pipeview-gui
# 运行测试 ```bash
cargo test --workspace # ~308 个测试 cargo test --workspace # ~308 个测试
cargo clippy --workspace --all-targets -- -D warnings cargo clippy --workspace --all-targets -- -D warnings
``` ```
### 发布构建 ### 配置文件位置
```bash | 平台 | 路径 |
cargo build -p pipeview-gui --release |------|------|
# 二进制位于 target/release/pipeview-gui (Linux/macOS) | Linux | `$XDG_CONFIG_HOME/xserial/``~/.config/xserial/` |
# 或 target/release/pipeview-gui.exe (Windows) | macOS | `~/Library/Application Support/xserial/` |
``` | Windows | `%APPDATA%\xserial\` |
---
## 完整示例:无人机遥测解析
以 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
在 pipeview-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/` 目录。
--- ---
@@ -277,117 +130,63 @@ return {
``` ```
┌──────────────────────────────────────────────────┐ ┌──────────────────────────────────────────────────┐
pipeview-gui (egui) pipeview-tui (ratatui) │ xserial-gui (egui) xserial-tui (ratatui) │
├──────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────┤
pipeview-client │ xserial-client │
│ SessionManager · Session · Config · History │ │ SessionManager · Session · Config · History │
│ Lua Runtime (mlua / LuaJIT) │ │ Lua Runtime (mlua / LuaJIT) │
├──────────────────────────────────────────────────┤ ├──────────────────────────────────────────────────┤
pipeview-core │ xserial-core │
│ Transport ──▶ Frame ──▶ Protocol ──▶ Pipeline │ │ Transport ──▶ Frame ──▶ Protocol ──▶ Pipeline │
└──────────────────────────────────────────────────┘ └──────────────────────────────────────────────────┘
``` ```
| Crate | 类型 | 职责 | | Crate | 类型 | 职责 |
|-------|------|------| |-------|------|------|
| `pipeview-core` | library | 传输层Serial/TCP/UDP、分帧器Line/Fixed/Length/COBS/Mixed/Lua、协议解码器Text/Hex/Plot、MultiPipeline | | `xserial-core` | library | 传输层、分帧器、协议解码、管线 |
| `pipeview-client` | library | Session 生命周期管理、SessionManager、事件广播tokio broadcast、RingBuffer 历史、Lua 运行时及会话 API | | `xserial-client` | library | 会话管理、事件分发、历史缓冲、Lua 运行时 |
| `pipeview-gui` | binary | egui 桌面应用,包含 sidebar/config/console/text/hex/plot 面板、键盘快捷键、字体管理、性能分析 | | `xserial-gui` | binary | egui 桌面应用(主要入口) |
| `pipeview-tui` | binary | ratatui 终端应用(功能未对齐 GUI仍在开发中 | | `xserial-tui` | binary | ratatui 终端应用(占位 |
**依赖方向** `core ← client ← {gui, tui}` 依赖方向: `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 状态自动保存,路径遵循各平台规范: ### Plot 测试服务器
| 平台 | 路径 |
|------|------|
| Linux | `$XDG_CONFIG_HOME/pipeview/gui-state.json``~/.config/pipeview/gui-state.json` |
| macOS | `~/Library/Application Support/pipeview/gui-state.json` |
| Windows | `%APPDATA%\pipeview\gui-state.json` |
持久化的内容包括Session 配置(传输参数、管线设置)、日志开关及路径、活动标签页、显示选项。
日志文件默认保存在配置目录的 `logs/` 子目录下,文件命名格式为 `session_{id}_{timestamp}.log`
---
## 开发工具
### 测试数据生成器
```bash ```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 --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 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
``` ```
GUI 中配置Transport `TCP 127.0.0.1:8091`Framer `MixedTextPlot`Decoder `MixedTextPlot`
### 性能分析 ### 性能分析
```bash ```bash
RUST_LOG=pipeview_gui::perf=info XSERIAL_GUI_PROFILE=1 cargo run -p pipeview-gui RUST_LOG=xserial_gui::perf=info XSERIAL_GUI_PROFILE=1 cargo run -p xserial-gui
XSERIAL_GUI_PROFILE_INTERVAL_MS=500 cargo run -p pipeview-gui XSERIAL_GUI_PROFILE_INTERVAL_MS=500 cargo run -p xserial-gui
``` ```
输出每帧的耗时、事件 drain 耗时、text/hex/plot 渲染耗时、plot 点数统计。
### 日志 ### 日志
```bash ```bash
RUST_LOG=info cargo run -p pipeview-gui # 应用日志 RUST_LOG=info cargo run -p xserial-gui
RUST_LOG=pipeview_gui=debug cargo run -p pipeview-gui # 详细日志 RUST_LOG=xserial_gui=debug cargo run -p xserial-gui
```
使用 `tracing-subscriber` + `RUST_LOG` 环境变量控制。
### 项目结构
```
crates/
pipeview-core/ # 传输、分帧、协议
pipeview-client/ # 会话管理、Lua 运行时
pipeview-gui/ # egui 桌面应用
pipeview-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 (multi-thread)
- **串口**`tokio-serial` + `serialport` - **串口**: `tokio-serial` + `serialport`
- **GUI**egui + egui_plot - **GUI**: egui + egui_plot
- **Lua**mlua 0.11, LuaJIT (vendored 编译), async/serde/send - **Lua**: mlua 0.11, LuaJIT (vendored), async/serde/send
- **事件分发**`tokio::sync::broadcast`多订阅者 - **事件**: `tokio::sync::broadcast` 多订阅者
- **零 feature flags**零 build script零条件编译 - **零 feature flags**零 build script零条件编译
## License ## License

View File

@@ -1,378 +0,0 @@
# pipeview
**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.
Built with Rust + [egui](https://github.com/emilk/egui), scriptable with Lua.
[中文文档](README.md)
---
## Table of Contents
- [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
| Type | Description | Options |
|------|-------------|---------|
| **Serial** | Serial port communication | Port name, baud rate (30012M), 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 |
### Framers
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.
| 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` |
### Decoders
Decoders parse framed data into displayable content.
| Decoder | Output | Parameters |
|---------|--------|------------|
| **Text** | Text | `encoding` (UTF-8 / Latin1 / ASCII) |
| **Hex** | Hexadecimal | `uppercase`, `separator`, `bytes_per_group`, `endian` |
| **Plot** | Waveform | `sample_type` (i8f64), `endian`, `channels` (164), `format` (Interleaved / Block / XY) |
| **MixedTextPlot** | Hybrid text + waveform | `encoding` |
| **Lua** | Custom | `script_path` |
**Plot sample formats:**
| 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, …]` |
Supported sample types: `i8`, `u8`, `i16`, `u16`, `i32`, `u32`, `i64`, `u64`, `f32`, `f64`
### Views
- **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
- **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 1001,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 Scripting
Built-in LuaJIT runtime:
- **Custom framers** — implement `feed(bytes)`, `flush()`, `reset()`, `pending_len()`
- **Custom decoders** — implement `decode(frame)`, return text/hex/plot/binary
- **Session API** — `pipeview.open()` to create sessions, `session:on_data()` for event callbacks, `session:send()` to transmit data
- **Utilities** — `pipeview.list_ports()`, `pipeview.sleep(ms)`, `pipeview.poll(limit)`, `pipeview.log(msg)`
### Keyboard Shortcuts
| 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
| 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/pipeview.git
cd pipeview
cargo run -p pipeview-gui
# Run tests
cargo test --workspace # ~308 tests
cargo clippy --workspace --all-targets -- -D warnings
```
### Release Build
```bash
cargo build -p pipeview-gui --release
# Binary: target/release/pipeview-gui (Linux/macOS)
# target/release/pipeview-gui.exe (Windows)
```
---
## Walkthrough: Drone Telemetry
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
```
### Step 1: Start the data source
```bash
python tools/test_drone.py --rate 10 --port 8091
```
### Step 2: Configure the session
In pipeview-gui, create a session with two pipelines:
| 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` |
### Step 3: View the results
- **Text View** — formatted sensor readouts
- **Plot View** — real-time gyroscope curves (gz/gy/gx)
The decoder in `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 Scripting Guide
### Framer API
A Lua framer splits raw bytes into frames. The script must return a table with these functions:
```lua
return {
feed = function(bytes)
-- bytes: Lua string (raw bytes)
-- Returns: { frame1, frame2, ... } or nil
end,
flush = function()
-- Returns: last buffered frame (string) or nil
end,
reset = function()
end,
pending_len = function()
-- Returns: number of bytes pending in buffer
end,
}
```
Reference: `tests/lua_line_framer.lua` (line-based framer splitting on `\n`).
### Decoder API
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 (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` | 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 return value example:**
```lua
return {
kind = "plot",
channels = {
{ 1.0, 2.0, 3.0 }, -- channel 0
{ 4.0, 5.0, 6.0 }, -- channel 1
},
sample_type = "F64", -- default F64; also I8/U8/I16/U32/U64/F32
format = "Block", -- default Interleaved; also Block/XY
}
```
More examples in `examples/`.
---
## Architecture
```
┌──────────────────────────────────────────────────┐
│ pipeview-gui (egui) pipeview-tui (ratatui) │
├──────────────────────────────────────────────────┤
│ pipeview-client │
│ SessionManager · Session · Config · History │
│ Lua Runtime (mlua / LuaJIT) │
├──────────────────────────────────────────────────┤
│ pipeview-core │
│ Transport ──▶ Frame ──▶ Protocol ──▶ Pipeline │
└──────────────────────────────────────────────────┘
```
| Crate | Type | Purpose |
|-------|------|---------|
| `pipeview-core` | library | Transport (Serial/TCP/UDP), framers (Line/Fixed/Length/COBS/Mixed/Lua), decoders (Text/Hex/Plot), MultiPipeline |
| `pipeview-client` | library | Session lifecycle, SessionManager, event broadcast (tokio broadcast), RingBuffer history, Lua runtime & session API |
| `pipeview-gui` | binary | egui desktop app: sidebar, config, console, text/hex/plot panels, keyboard shortcuts, font management, profiling |
| `pipeview-tui` | binary | ratatui terminal app (feature-incomplete, under development) |
**Dependency flow:** `core ← client ← {gui, tui}`
**Data flow:**
```
[Transport] → read bytes → [MultiPipeline]
→ Pipeline 1: Framer → Decoder → DecodedEntry → broadcast → GUI buffers
→ Pipeline 2: Framer → Decoder → DecodedEntry → broadcast → GUI buffers
→ ...
```
Each pipeline frames and decodes independently. Only successful decodes produce output.
---
## Configuration & Persistence
GUI state is saved automatically to platform-standard locations:
| Platform | Path |
|----------|------|
| Linux | `$XDG_CONFIG_HOME/pipeview/gui-state.json` or `~/.config/pipeview/gui-state.json` |
| macOS | `~/Library/Application Support/pipeview/gui-state.json` |
| Windows | `%APPDATA%\pipeview\gui-state.json` |
Persisted data includes: session configurations (transport, pipelines), log settings, active tab, and display options.
Log files are written to `logs/` under the config directory, named `session_{id}_{timestamp}.log`.
---
## Development Tools
### Test Data Generators
```bash
# 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=pipeview_gui::perf=info XSERIAL_GUI_PROFILE=1 cargo run -p pipeview-gui
XSERIAL_GUI_PROFILE_INTERVAL_MS=500 cargo run -p pipeview-gui
```
### Tracing
```bash
RUST_LOG=info cargo run -p pipeview-gui
RUST_LOG=pipeview_gui=debug cargo run -p pipeview-gui
```
### Project Structure
```
crates/
pipeview-core/ # Transport, framing, protocol
pipeview-client/ # Session management, Lua runtime
pipeview-gui/ # egui desktop application
pipeview-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
- **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
MIT

View File

@@ -1,64 +0,0 @@
#![cfg_attr(windows, windows_subsystem = "windows")]
mod app;
mod app_state;
mod buffers;
mod logging;
mod panels;
mod perf;
mod shortcuts;
mod ui_fonts;
use pipeview_client::SessionManager;
/// On Linux, when launched from a file manager, a terminal emulator may be spawned
/// to run this binary. We re-spawn ourselves detached so the terminal can close
/// while the GUI window persists.
#[cfg(target_os = "linux")]
fn ensure_detached() {
use std::os::unix::process::CommandExt;
use std::process;
if std::env::var("PIPEVIEW_DETACHED").is_ok() {
return;
}
let exe = match std::env::current_exe() {
Ok(p) => p,
Err(_) => return,
};
let args: Vec<String> = std::env::args().skip(1).collect();
let _ = process::Command::new(&exe)
.args(&args)
.env("PIPEVIEW_DETACHED", "1")
.stdin(process::Stdio::null())
.stdout(process::Stdio::null())
.stderr(process::Stdio::null())
.process_group(0)
.spawn();
process::exit(0);
}
fn main() {
#[cfg(target_os = "linux")]
ensure_detached();
tracing_subscriber::fmt()
.with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
.init();
let rt = tokio::runtime::Runtime::new().expect("tokio runtime");
let _guard = rt.enter();
let mgr = SessionManager::new();
let rx = mgr.subscribe();
let _ = eframe::run_native(
"pipeview",
eframe::NativeOptions::default(),
Box::new(|cc| Ok(Box::new(app::XserialApp::new(mgr, rx, cc.egui_ctx.clone())))),
);
}

View File

@@ -1,10 +1,10 @@
[package] [package]
name = "pipeview-client" name = "xserial-client"
version = "0.1.0" version = "0.1.0"
edition = "2024" edition = "2024"
[dependencies] [dependencies]
pipeview-core = { path = "../pipeview-core" } xserial-core = { path = "../xserial-core" }
tokio = { workspace = true, features = ["sync", "time"] } tokio = { workspace = true, features = ["sync", "time"] }
tracing = { workspace = true } tracing = { workspace = true }
serde = { workspace = true } serde = { workspace = true }

View File

@@ -1,5 +1,5 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use pipeview_core::frame::{ use xserial_core::frame::{
Endian, Framer, Endian, Framer,
cobs::CobsFramer, cobs::CobsFramer,
fixed::FixedLengthFramer, fixed::FixedLengthFramer,
@@ -7,14 +7,14 @@ use pipeview_core::frame::{
line::{LineConfig, LineFramer}, line::{LineConfig, LineFramer},
mixed::{MixedTextPlotConfig as MixedFramerConfig, MixedTextPlotFramer}, mixed::{MixedTextPlotConfig as MixedFramerConfig, MixedTextPlotFramer},
}; };
use pipeview_core::protocol::{ use xserial_core::protocol::{
ProtocolDecoder, ProtocolDecoder,
hex::{HexConfig, HexDecoder}, hex::{HexConfig, HexDecoder},
mixed::{MixedTextPlotConfig as MixedDecoderConfig, MixedTextPlotDecoder}, mixed::{MixedTextPlotConfig as MixedDecoderConfig, MixedTextPlotDecoder},
plot::{PlotConfig, PlotDecoder, PlotFormat, SampleType}, plot::{PlotConfig, PlotDecoder, PlotFormat, SampleType},
text::{TextDecoder, TextEncoding}, text::{TextDecoder, TextEncoding},
}; };
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
use crate::error::Result; use crate::error::Result;
use crate::lua::codec::{LuaDecoder, LuaFramer}; use crate::lua::codec::{LuaDecoder, LuaFramer};
@@ -229,10 +229,10 @@ impl Default for SessionConfig {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use pipeview_core::protocol::Endian; use xserial_core::protocol::Endian;
use pipeview_core::protocol::plot::{PlotFormat, SampleType}; use xserial_core::protocol::plot::{PlotFormat, SampleType};
use pipeview_core::protocol::text::TextEncoding; use xserial_core::protocol::text::TextEncoding;
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
#[test] #[test]
fn framer_line_serde_roundtrip() { fn framer_line_serde_roundtrip() {

View File

@@ -1,4 +1,4 @@
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct DecodedEntry { pub struct DecodedEntry {

View File

@@ -3,9 +3,9 @@ use std::sync::Mutex;
use mlua::{Function, Lua, RegistryKey, Table, Value}; use mlua::{Function, Lua, RegistryKey, Table, Value};
use tracing::warn; use tracing::warn;
use pipeview_core::frame::Framer; use xserial_core::frame::Framer;
use pipeview_core::protocol::plot::{PlotFormat, PlotFrame, SampleType}; use xserial_core::protocol::plot::{PlotFormat, PlotFrame, SampleType};
use pipeview_core::protocol::{DecodedData, ProtocolDecoder}; use xserial_core::protocol::{DecodedData, ProtocolDecoder};
use crate::error::{Error, Result}; use crate::error::{Error, Result};
@@ -297,7 +297,7 @@ mod tests {
.duration_since(UNIX_EPOCH) .duration_since(UNIX_EPOCH)
.unwrap() .unwrap()
.as_nanos(); .as_nanos();
let path = std::env::temp_dir().join(format!("pipeview_{name}_{nonce}.lua")); let path = std::env::temp_dir().join(format!("xserial_{name}_{nonce}.lua"));
fs::write(&path, script).unwrap(); fs::write(&path, script).unwrap();
path path
} }

View File

@@ -81,9 +81,9 @@ pub fn register(lua: &Lua) -> LuaResult<()> {
pub fn register_with_manager(lua: &Lua, manager: SessionManager) -> LuaResult<()> { pub fn register_with_manager(lua: &Lua, manager: SessionManager) -> LuaResult<()> {
let runtime = LuaRuntime::new(manager); let runtime = LuaRuntime::new(manager);
let pipeview = lua.create_table()?; let xserial = lua.create_table()?;
pipeview.set("open", { xserial.set("open", {
let runtime = runtime.clone(); let runtime = runtime.clone();
lua.create_async_function(move |lua, config: Table| { lua.create_async_function(move |lua, config: Table| {
let runtime = runtime.clone(); let runtime = runtime.clone();
@@ -96,15 +96,15 @@ pub fn register_with_manager(lua: &Lua, manager: SessionManager) -> LuaResult<()
})? })?
})?; })?;
pipeview.set( xserial.set(
"list_ports", "list_ports",
lua.create_function(|_, ()| { lua.create_function(|_, ()| {
let ports = pipeview_core::transport::serial::SerialTransport::list_ports(); let ports = xserial_core::transport::serial::SerialTransport::list_ports();
Ok(ports.into_iter().map(|p| p.port_name).collect::<Vec<_>>()) Ok(ports.into_iter().map(|p| p.port_name).collect::<Vec<_>>())
})?, })?,
)?; )?;
pipeview.set("sleep", { xserial.set("sleep", {
let runtime = runtime.clone(); let runtime = runtime.clone();
lua.create_async_function(move |lua, ms: u64| { lua.create_async_function(move |lua, ms: u64| {
let runtime = runtime.clone(); let runtime = runtime.clone();
@@ -116,7 +116,7 @@ pub fn register_with_manager(lua: &Lua, manager: SessionManager) -> LuaResult<()
})? })?
})?; })?;
pipeview.set("poll", { xserial.set("poll", {
let runtime = runtime.clone(); let runtime = runtime.clone();
lua.create_async_function(move |lua, limit_per_session: Option<usize>| { lua.create_async_function(move |lua, limit_per_session: Option<usize>| {
let runtime = runtime.clone(); let runtime = runtime.clone();
@@ -124,7 +124,7 @@ pub fn register_with_manager(lua: &Lua, manager: SessionManager) -> LuaResult<()
})? })?
})?; })?;
pipeview.set( xserial.set(
"log", "log",
lua.create_function(|_, msg: String| { lua.create_function(|_, msg: String| {
tracing::info!("[lua] {}", msg); tracing::info!("[lua] {}", msg);
@@ -132,7 +132,7 @@ pub fn register_with_manager(lua: &Lua, manager: SessionManager) -> LuaResult<()
})?, })?,
)?; )?;
lua.globals().set("pipeview", pipeview)?; lua.globals().set("xserial", xserial)?;
Ok(()) Ok(())
} }
@@ -146,9 +146,9 @@ mod tests {
let lua = Lua::new(); let lua = Lua::new();
register(&lua).unwrap(); register(&lua).unwrap();
let pipeview: Table = lua.globals().get("pipeview").unwrap(); let xserial: Table = lua.globals().get("xserial").unwrap();
for name in ["open", "list_ports", "sleep", "poll", "log"] { for name in ["open", "list_ports", "sleep", "poll", "log"] {
let value: Value = pipeview.get(name).unwrap(); let value: Value = xserial.get(name).unwrap();
assert!( assert!(
matches!(value, Value::Function(_)), matches!(value, Value::Function(_)),
"{name} should be a function" "{name} should be a function"
@@ -162,8 +162,8 @@ mod tests {
let manager = SessionManager::new(); let manager = SessionManager::new();
register_with_manager(&lua, manager.clone()).unwrap(); register_with_manager(&lua, manager.clone()).unwrap();
let pipeview: Table = lua.globals().get("pipeview").unwrap(); let xserial: Table = lua.globals().get("xserial").unwrap();
let open: Value = pipeview.get("open").unwrap(); let open: Value = xserial.get("open").unwrap();
assert!(matches!(open, Value::Function(_))); assert!(matches!(open, Value::Function(_)));
assert_eq!(manager.count(), 0); assert_eq!(manager.count(), 0);
} }

View File

@@ -8,7 +8,7 @@ use std::time::Duration;
use mlua::{Function, Lua, LuaSerdeExt, RegistryKey, UserData, UserDataMethods, Value, Variadic}; use mlua::{Function, Lua, LuaSerdeExt, RegistryKey, UserData, UserDataMethods, Value, Variadic};
use tokio::sync::mpsc; use tokio::sync::mpsc;
use tokio::task::JoinHandle; use tokio::task::JoinHandle;
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
use crate::config::SessionConfig; use crate::config::SessionConfig;
use crate::lua::LuaRuntime; use crate::lua::LuaRuntime;

View File

@@ -11,8 +11,8 @@ use tokio::sync::{Mutex, broadcast, mpsc};
use tokio::task::JoinHandle; use tokio::task::JoinHandle;
use tracing::{debug, error, info, warn}; use tracing::{debug, error, info, warn};
use pipeview_core::pipeline::{MultiPipeline, Pipeline}; use xserial_core::pipeline::{MultiPipeline, Pipeline};
use pipeview_core::transport::Connection; use xserial_core::transport::Connection;
use crate::cmd::SessionCmd; use crate::cmd::SessionCmd;
use crate::config::SessionConfig; use crate::config::SessionConfig;
@@ -499,7 +499,7 @@ async fn try_read(
} }
} }
fn to_io_error(err: pipeview_core::error::Error) -> std::io::Error { fn to_io_error(err: xserial_core::error::Error) -> std::io::Error {
io::Error::other(err.to_string()) io::Error::other(err.to_string())
} }
@@ -510,7 +510,7 @@ mod tests {
fn tcp_config() -> SessionConfig { fn tcp_config() -> SessionConfig {
SessionConfig { SessionConfig {
transport: pipeview_core::transport::TransportConfig::Tcp { transport: xserial_core::transport::TransportConfig::Tcp {
addr: "127.0.0.1:1".into(), addr: "127.0.0.1:1".into(),
}, },
pipelines: vec![PipelineConfig { pipelines: vec![PipelineConfig {
@@ -520,7 +520,7 @@ mod tests {
max_line_len: 65536, max_line_len: 65536,
}, },
decoder: DecoderConfig::Text { decoder: DecoderConfig::Text {
encoding: pipeview_core::protocol::text::TextEncoding::Utf8, encoding: xserial_core::protocol::text::TextEncoding::Utf8,
}, },
}], }],
..Default::default() ..Default::default()

View File

@@ -11,7 +11,7 @@ static INIT: Once = Once::new();
fn init_tracing() { fn init_tracing() {
INIT.call_once(|| { INIT.call_once(|| {
tracing_subscriber::fmt() tracing_subscriber::fmt()
.with_env_filter("pipeview=trace") .with_env_filter("xserial=trace")
.try_init() .try_init()
.ok(); .ok();
}); });
@@ -22,7 +22,7 @@ fn write_temp_lua(name: &str, script: &str) -> PathBuf {
.duration_since(std::time::UNIX_EPOCH) .duration_since(std::time::UNIX_EPOCH)
.unwrap() .unwrap()
.as_nanos(); .as_nanos();
let path = std::env::temp_dir().join(format!("pipeview_{name}_{nonce}.lua")); let path = std::env::temp_dir().join(format!("xserial_{name}_{nonce}.lua"));
fs::write(&path, script).unwrap(); fs::write(&path, script).unwrap();
path path
} }
@@ -47,18 +47,18 @@ fn hex_pipeline_lua() -> &'static str {
"# "#
} }
// ── pipeview.sleep / pipeview.log ────────────────────────────────── // ── xserial.sleep / xserial.log ──────────────────────────────────
#[tokio::test] #[tokio::test]
async fn lua_sleep_and_log() { async fn lua_sleep_and_log() {
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
lua.load( lua.load(
r#" r#"
pipeview.log("test start") xserial.log("test start")
pipeview.sleep(50) xserial.sleep(50)
pipeview.log("test end") xserial.log("test end")
"#, "#,
) )
.exec_async() .exec_async()
@@ -66,15 +66,15 @@ async fn lua_sleep_and_log() {
.unwrap(); .unwrap();
} }
// ── pipeview.list_ports ─────────────────────────────────────────── // ── xserial.list_ports ───────────────────────────────────────────
#[tokio::test] #[tokio::test]
async fn lua_list_ports() { async fn lua_list_ports() {
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let result: Vec<String> = lua let result: Vec<String> = lua
.load(r#"return pipeview.list_ports()"#) .load(r#"return xserial.list_ports()"#)
.eval_async() .eval_async()
.await .await
.unwrap(); .unwrap();
@@ -84,7 +84,7 @@ async fn lua_list_ports() {
let _ = result; let _ = result;
} }
// ── pipeview.open + session:send / session:read / session:close ──── // ── xserial.open + session:send / session:read / session:close ────
#[tokio::test] #[tokio::test]
async fn lua_session_open_send_read_close() { async fn lua_session_open_send_read_close() {
@@ -102,11 +102,11 @@ async fn lua_session_open_send_read_close() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -141,11 +141,11 @@ async fn lua_session_read_timeout() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -162,7 +162,7 @@ async fn lua_session_read_timeout() {
lua.load(&script).exec_async().await.unwrap(); lua.load(&script).exec_async().await.unwrap();
} }
// ── pipeview.open with hex decoder ──────────────────────────────── // ── xserial.open with hex decoder ────────────────────────────────
#[tokio::test] #[tokio::test]
async fn lua_session_hex_decoder() { async fn lua_session_hex_decoder() {
@@ -176,11 +176,11 @@ async fn lua_session_hex_decoder() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -201,7 +201,7 @@ async fn lua_session_hex_decoder() {
server.await.unwrap(); server.await.unwrap();
} }
// ── pipeview.open with Lua framer + Lua decoder ─────────────────── // ── xserial.open with Lua framer + Lua decoder ───────────────────
#[tokio::test] #[tokio::test]
async fn lua_session_custom_lua_pipeline() { async fn lua_session_custom_lua_pipeline() {
@@ -259,11 +259,11 @@ async fn lua_session_custom_lua_pipeline() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{ pipelines = {{
{{ {{
@@ -311,12 +311,12 @@ async fn lua_session_on_data_callback() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local received = {{}} local received = {{}}
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -327,8 +327,8 @@ async fn lua_session_on_data_callback() {
for _ = 1, 50 do for _ = 1, 50 do
if #received < 2 then if #received < 2 then
pipeview.poll(1) xserial.poll(1)
pipeview.sleep(10) xserial.sleep(10)
end end
end end
@@ -371,11 +371,11 @@ async fn lua_session_reconfigure() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -420,11 +420,11 @@ async fn lua_session_next_event_stream() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -450,7 +450,7 @@ async fn lua_session_next_event_stream() {
server.await.unwrap(); server.await.unwrap();
} }
// ── session:off + pipeview.poll ─────────────────────────────────── // ── session:off + xserial.poll ───────────────────────────────────
#[tokio::test] #[tokio::test]
async fn lua_session_off_stops_future_callbacks() { async fn lua_session_off_stops_future_callbacks() {
@@ -466,12 +466,12 @@ async fn lua_session_off_stops_future_callbacks() {
}); });
let lua = Lua::new(); let lua = Lua::new();
pipeview_client::lua::register(&lua).unwrap(); xserial_client::lua::register(&lua).unwrap();
let script = format!( let script = format!(
r#" r#"
local received = {{}} local received = {{}}
local sess = pipeview.open({{ local sess = xserial.open({{
transport = {{ Tcp = {{ addr = "{}" }} }}, transport = {{ Tcp = {{ addr = "{}" }} }},
pipelines = {{{}}} pipelines = {{{}}}
}}) }})
@@ -482,8 +482,8 @@ async fn lua_session_off_stops_future_callbacks() {
for _ = 1, 50 do for _ = 1, 50 do
if #received == 0 then if #received == 0 then
pipeview.poll(1) xserial.poll(1)
pipeview.sleep(10) xserial.sleep(10)
end end
end end
@@ -491,8 +491,8 @@ async fn lua_session_off_stops_future_callbacks() {
assert(received[1] == "text:first") assert(received[1] == "text:first")
assert(sess:off(token) == true) assert(sess:off(token) == true)
pipeview.sleep(250) xserial.sleep(250)
pipeview.poll(10) xserial.poll(10)
assert(#received == 1, "callback should not fire after off") assert(#received == 1, "callback should not fire after off")
assert(sess:off(token) == false) assert(sess:off(token) == false)

View File

@@ -3,11 +3,11 @@ use std::time::Duration;
use tokio::io::{AsyncReadExt, AsyncWriteExt}; use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpListener; use tokio::net::TcpListener;
use pipeview_client::SessionManager; use xserial_client::SessionManager;
use pipeview_client::config::{DecoderConfig, FramerConfig, PipelineConfig, SessionConfig}; use xserial_client::config::{DecoderConfig, FramerConfig, PipelineConfig, SessionConfig};
use pipeview_client::session::{Session, SessionEvent}; use xserial_client::session::{Session, SessionEvent};
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
fn tcp_config(addr: String) -> SessionConfig { fn tcp_config(addr: String) -> SessionConfig {
SessionConfig { SessionConfig {
@@ -19,7 +19,7 @@ fn tcp_config(addr: String) -> SessionConfig {
max_line_len: 1024 * 1024, max_line_len: 1024 * 1024,
}, },
decoder: DecoderConfig::Text { decoder: DecoderConfig::Text {
encoding: pipeview_core::protocol::text::TextEncoding::Utf8, encoding: xserial_core::protocol::text::TextEncoding::Utf8,
}, },
}], }],
history_limit: 100, history_limit: 100,
@@ -113,7 +113,7 @@ async fn session_multi_pipeline_text_and_hex() {
uppercase: false, uppercase: false,
separator: " ".into(), separator: " ".into(),
bytes_per_group: 1, bytes_per_group: 1,
endian: pipeview_core::protocol::Endian::Big, endian: xserial_core::protocol::Endian::Big,
}, },
}); });
@@ -285,7 +285,7 @@ async fn session_reconfigure_changes_pipeline() {
uppercase: true, uppercase: true,
separator: " ".into(), separator: " ".into(),
bytes_per_group: 1, bytes_per_group: 1,
endian: pipeview_core::protocol::Endian::Big, endian: xserial_core::protocol::Endian::Big,
}; };
handle.reconfigure(new_cfg).await.unwrap(); handle.reconfigure(new_cfg).await.unwrap();

View File

@@ -1,5 +1,5 @@
[package] [package]
name = "pipeview-core" name = "xserial-core"
version = "0.1.0" version = "0.1.0"
edition = "2024" edition = "2024"

View File

@@ -61,11 +61,11 @@ pub struct PipelineResult {
/// Manages multiple [`Pipeline`]s, feeding the same byte stream to all of them. /// Manages multiple [`Pipeline`]s, feeding the same byte stream to all of them.
/// ///
/// ``` /// ```
/// use pipeview_core::pipeline::{MultiPipeline, Pipeline}; /// use xserial_core::pipeline::{MultiPipeline, Pipeline};
/// use pipeview_core::frame::line::{LineFramer, LineConfig}; /// use xserial_core::frame::line::{LineFramer, LineConfig};
/// use pipeview_core::frame::fixed::FixedLengthFramer; /// use xserial_core::frame::fixed::FixedLengthFramer;
/// use pipeview_core::protocol::text::{TextDecoder, TextEncoding}; /// use xserial_core::protocol::text::{TextDecoder, TextEncoding};
/// use pipeview_core::protocol::hex::{HexDecoder, HexConfig}; /// use xserial_core::protocol::hex::{HexDecoder, HexConfig};
/// ///
/// let mut mp = MultiPipeline::new(); /// let mut mp = MultiPipeline::new();
/// mp.add( /// mp.add(

View File

@@ -4,7 +4,7 @@ use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::{TcpListener, UdpSocket}; use tokio::net::{TcpListener, UdpSocket};
use tokio::time::timeout; use tokio::time::timeout;
use pipeview_core::frame::{ use xserial_core::frame::{
Endian, Framer, Endian, Framer,
cobs::CobsFramer, cobs::CobsFramer,
cobs::cobs_encode as raw_cobs_encode, cobs::cobs_encode as raw_cobs_encode,
@@ -13,17 +13,17 @@ use pipeview_core::frame::{
line::{LineConfig, LineFramer}, line::{LineConfig, LineFramer},
mixed::{MixedTextPlotConfig as MixedFramerConfig, MixedTextPlotFramer}, mixed::{MixedTextPlotConfig as MixedFramerConfig, MixedTextPlotFramer},
}; };
use pipeview_core::protocol::{ use xserial_core::protocol::{
DecodedData, ProtocolDecoder, DecodedData, ProtocolDecoder,
hex::{HexConfig, HexDecoder}, hex::{HexConfig, HexDecoder},
mixed::{MIXED_PLOT_ESCAPE, MIXED_PLOT_MARKER, MixedTextPlotConfig, MixedTextPlotDecoder}, mixed::{MIXED_PLOT_ESCAPE, MIXED_PLOT_MARKER, MixedTextPlotConfig, MixedTextPlotDecoder},
plot::{PlotConfig, PlotDecoder, PlotFormat, SampleType}, plot::{PlotConfig, PlotDecoder, PlotFormat, SampleType},
text::{TextDecoder, TextEncoding}, text::{TextDecoder, TextEncoding},
}; };
use pipeview_core::transport::serial::{ use xserial_core::transport::serial::{
SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits, SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits,
}; };
use pipeview_core::transport::{Connection, TransportConfig, TransportType}; use xserial_core::transport::{Connection, TransportConfig, TransportType};
const TEST_TIMEOUT: Duration = Duration::from_secs(5); const TEST_TIMEOUT: Duration = Duration::from_secs(5);

View File

@@ -1,15 +1,15 @@
[package] [package]
name = "pipeview-gui" name = "xserial-gui"
version = "0.1.0" version = "0.1.0"
edition = "2024" edition = "2024"
[[bin]] [[bin]]
name = "pipeview-gui" name = "xserial-gui"
path = "src/main.rs" path = "src/main.rs"
[dependencies] [dependencies]
pipeview-core = { path = "../pipeview-core" } xserial-core = { path = "../xserial-core" }
pipeview-client = { path = "../pipeview-client" } xserial-client = { path = "../xserial-client" }
tokio = { workspace = true } tokio = { workspace = true }
egui = { workspace = true } egui = { workspace = true }
eframe = { workspace = true } eframe = { workspace = true }

View File

@@ -10,11 +10,11 @@ use crate::perf::{DrainStats, GuiProfiler, GuiSnapshot};
use crate::shortcuts::{self, default_bindings}; use crate::shortcuts::{self, default_bindings};
use crate::ui_fonts::{self, FontCandidate, FontChoice, UiFontSettings}; use crate::ui_fonts::{self, FontCandidate, FontChoice, UiFontSettings};
use egui::{Color32, Layout, Panel, Pos2, Rect, TextEdit, UiBuilder}; use egui::{Color32, Layout, Panel, Pos2, Rect, TextEdit, UiBuilder};
use pipeview_client::SessionManager; use xserial_client::SessionManager;
use pipeview_client::config::SessionConfig; use xserial_client::config::SessionConfig;
use pipeview_client::session::SessionEvent; use xserial_client::session::SessionEvent;
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
const DATA_REPAINT_INTERVAL: Duration = Duration::from_millis(33); const DATA_REPAINT_INTERVAL: Duration = Duration::from_millis(33);
@@ -851,7 +851,7 @@ impl XserialApp {
fn render_top_bar(&mut self, ui: &mut egui::Ui) { fn render_top_bar(&mut self, ui: &mut egui::Ui) {
Panel::top("top_bar").show_inside(ui, |ui| { Panel::top("top_bar").show_inside(ui, |ui| {
ui.horizontal_wrapped(|ui| { ui.horizontal_wrapped(|ui| {
ui.heading("pipeview"); ui.heading("xserial");
ui.separator(); ui.separator();
// ui.label(format!( // ui.label(format!(
// "Fonts: {} + {} {:.1} pt", // "Fonts: {} + {} {:.1} pt",
@@ -1434,8 +1434,8 @@ fn build_payload(tab: &SessionTab) -> Result<Option<Vec<u8>>, String> {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::transport_summary; use super::transport_summary;
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
use pipeview_core::transport::serial::{ use xserial_core::transport::serial::{
SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits, SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits,
}; };

View File

@@ -5,7 +5,7 @@ use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use tracing::warn; use tracing::warn;
use pipeview_client::config::SessionConfig; use xserial_client::config::SessionConfig;
const GUI_STATE_FILE_NAME: &str = "gui-state.json"; const GUI_STATE_FILE_NAME: &str = "gui-state.json";
@@ -54,7 +54,7 @@ fn gui_state_path() -> PathBuf {
gui_state_path_for_os_and_env(env::consts::OS, |key| env::var(key).ok()) gui_state_path_for_os_and_env(env::consts::OS, |key| env::var(key).ok())
} }
/// Returns the pipeview configuration directory (the parent of gui-state.json). /// Returns the xserial configuration directory (the parent of gui-state.json).
pub fn config_dir() -> PathBuf { pub fn config_dir() -> PathBuf {
gui_state_path() gui_state_path()
.parent() .parent()
@@ -67,12 +67,12 @@ fn gui_state_path_for_os_and_env(os: &str, get_env: impl Fn(&str) -> Option<Stri
"windows" => { "windows" => {
if let Some(path) = get_env("APPDATA").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("APPDATA").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(GUI_STATE_FILE_NAME); .join(GUI_STATE_FILE_NAME);
} }
if let Some(path) = get_env("LOCALAPPDATA").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("LOCALAPPDATA").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(GUI_STATE_FILE_NAME); .join(GUI_STATE_FILE_NAME);
} }
} }
@@ -81,20 +81,20 @@ fn gui_state_path_for_os_and_env(os: &str, get_env: impl Fn(&str) -> Option<Stri
return PathBuf::from(home) return PathBuf::from(home)
.join("Library") .join("Library")
.join("Application Support") .join("Application Support")
.join("pipeview") .join("xserial")
.join(GUI_STATE_FILE_NAME); .join(GUI_STATE_FILE_NAME);
} }
} }
_ => { _ => {
if let Some(path) = get_env("XDG_CONFIG_HOME").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("XDG_CONFIG_HOME").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(GUI_STATE_FILE_NAME); .join(GUI_STATE_FILE_NAME);
} }
if let Some(home) = get_env("HOME").filter(|path| !path.trim().is_empty()) { if let Some(home) = get_env("HOME").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(home) return PathBuf::from(home)
.join(".config") .join(".config")
.join("pipeview") .join("xserial")
.join(GUI_STATE_FILE_NAME); .join(GUI_STATE_FILE_NAME);
} }
} }
@@ -124,7 +124,7 @@ const fn default_true() -> bool {
mod tests { mod tests {
use super::*; use super::*;
use std::time::{SystemTime, UNIX_EPOCH}; use std::time::{SystemTime, UNIX_EPOCH};
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
#[test] #[test]
fn windows_gui_state_path_uses_appdata() { fn windows_gui_state_path_uses_appdata() {
@@ -135,7 +135,7 @@ mod tests {
assert_eq!( assert_eq!(
path, path,
PathBuf::from(r"C:\Users\Test\AppData\Roaming") PathBuf::from(r"C:\Users\Test\AppData\Roaming")
.join("pipeview") .join("xserial")
.join(GUI_STATE_FILE_NAME) .join(GUI_STATE_FILE_NAME)
); );
} }
@@ -146,7 +146,7 @@ mod tests {
.duration_since(UNIX_EPOCH) .duration_since(UNIX_EPOCH)
.unwrap() .unwrap()
.as_nanos(); .as_nanos();
let dir = env::temp_dir().join(format!("pipeview-gui-state-{unique}")); let dir = env::temp_dir().join(format!("xserial-gui-state-{unique}"));
let path = dir.join(GUI_STATE_FILE_NAME); let path = dir.join(GUI_STATE_FILE_NAME);
let state = PersistedGuiState { let state = PersistedGuiState {
sessions: vec![SessionConfig { sessions: vec![SessionConfig {

View File

@@ -1,10 +1,10 @@
use egui_plot::PlotBounds; use egui_plot::PlotBounds;
use std::collections::VecDeque; use std::collections::VecDeque;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use pipeview_client::RingBuffer; use xserial_client::RingBuffer;
use pipeview_client::event::DecodedEntry; use xserial_client::event::DecodedEntry;
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
use pipeview_core::protocol::plot::{PlotFormat, PlotFrame}; use xserial_core::protocol::plot::{PlotFormat, PlotFrame};
#[derive(Clone)] #[derive(Clone)]
pub enum LineDirection { pub enum LineDirection {
@@ -716,9 +716,9 @@ impl PlotBuffer {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use pipeview_client::event::DecodedEntry; use xserial_client::event::DecodedEntry;
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
use pipeview_core::protocol::plot::{PlotFrame, SampleType}; use xserial_core::protocol::plot::{PlotFrame, SampleType};
fn plot_entry() -> DecodedEntry { fn plot_entry() -> DecodedEntry {
DecodedEntry { DecodedEntry {

View File

@@ -6,8 +6,8 @@ use std::thread;
use std::time::{SystemTime, UNIX_EPOCH}; use std::time::{SystemTime, UNIX_EPOCH};
use pipeview_client::event::DecodedEntry; use xserial_client::event::DecodedEntry;
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
/// Manages background file logging via a dedicated writer thread. /// Manages background file logging via a dedicated writer thread.
/// ///
@@ -30,7 +30,7 @@ impl LogWriter {
let mut writer = BufWriter::with_capacity(1024, file); let mut writer = BufWriter::with_capacity(1024, file);
let (sender, receiver) = mpsc::channel::<String>(); let (sender, receiver) = mpsc::channel::<String>();
let thread_name = format!("pipeview-log-{}", path.display()); let thread_name = format!("xserial-log-{}", path.display());
thread::Builder::new().name(thread_name).spawn(move || { thread::Builder::new().name(thread_name).spawn(move || {
while let Ok(line) = receiver.recv() { while let Ok(line) = receiver.recv() {
if writeln!(writer, "{line}").is_err() { if writeln!(writer, "{line}").is_err() {

View File

@@ -0,0 +1,28 @@
mod app;
mod app_state;
mod buffers;
mod logging;
mod panels;
mod perf;
mod shortcuts;
mod ui_fonts;
use xserial_client::SessionManager;
fn main() {
tracing_subscriber::fmt()
.with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
.init();
let rt = tokio::runtime::Runtime::new().expect("tokio runtime");
let _guard = rt.enter();
let mgr = SessionManager::new();
let rx = mgr.subscribe();
let _ = eframe::run_native(
"xserial",
eframe::NativeOptions::default(),
Box::new(|cc| Ok(Box::new(app::XserialApp::new(mgr, rx, cc.egui_ctx.clone())))),
);
}

View File

@@ -1,10 +1,10 @@
use egui::{ComboBox, DragValue, ScrollArea, TextEdit, Ui}; use egui::{ComboBox, DragValue, ScrollArea, TextEdit, Ui};
use pipeview_client::config::{DecoderConfig, FramerConfig, PipelineConfig, SessionConfig}; use xserial_client::config::{DecoderConfig, FramerConfig, PipelineConfig, SessionConfig};
use pipeview_core::protocol::Endian; use xserial_core::protocol::Endian;
use pipeview_core::protocol::plot::{PlotFormat, SampleType}; use xserial_core::protocol::plot::{PlotFormat, SampleType};
use pipeview_core::protocol::text::TextEncoding; use xserial_core::protocol::text::TextEncoding;
use pipeview_core::transport::TransportConfig; use xserial_core::transport::TransportConfig;
use pipeview_core::transport::serial::{ use xserial_core::transport::serial::{
SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits, SerialTransport, SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits, SerialTransport,
}; };

View File

@@ -202,7 +202,7 @@ impl GuiProfiler {
let repaints = self.repaint_counter.take(); let repaints = self.repaint_counter.take();
info!( info!(
target: "pipeview_gui::perf", target: "xserial_gui::perf",
frames = self.interval_stats.frames.count, frames = self.interval_stats.frames.count,
frame_avg_ms = self.interval_stats.frames.avg_ms(), frame_avg_ms = self.interval_stats.frames.avg_ms(),
frame_max_ms = self.interval_stats.frames.max_ms(), frame_max_ms = self.interval_stats.frames.max_ms(),

View File

@@ -358,12 +358,12 @@ fn font_settings_path_for_os_and_env(
"windows" => { "windows" => {
if let Some(path) = get_env("APPDATA").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("APPDATA").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME); .join(FONT_SETTINGS_FILE_NAME);
} }
if let Some(path) = get_env("LOCALAPPDATA").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("LOCALAPPDATA").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME); .join(FONT_SETTINGS_FILE_NAME);
} }
} }
@@ -372,20 +372,20 @@ fn font_settings_path_for_os_and_env(
return PathBuf::from(home) return PathBuf::from(home)
.join("Library") .join("Library")
.join("Application Support") .join("Application Support")
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME); .join(FONT_SETTINGS_FILE_NAME);
} }
} }
_ => { _ => {
if let Some(path) = get_env("XDG_CONFIG_HOME").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("XDG_CONFIG_HOME").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME); .join(FONT_SETTINGS_FILE_NAME);
} }
if let Some(home) = get_env("HOME").filter(|path| !path.trim().is_empty()) { if let Some(home) = get_env("HOME").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(home) return PathBuf::from(home)
.join(".config") .join(".config")
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME); .join(FONT_SETTINGS_FILE_NAME);
} }
} }
@@ -591,7 +591,7 @@ mod tests {
.duration_since(UNIX_EPOCH) .duration_since(UNIX_EPOCH)
.unwrap() .unwrap()
.as_nanos(); .as_nanos();
let dir = env::temp_dir().join(format!("pipeview-gui-font-settings-{unique}")); let dir = env::temp_dir().join(format!("xserial-gui-font-settings-{unique}"));
let path = dir.join("gui-fonts.json"); let path = dir.join("gui-fonts.json");
let settings = UiFontSettings { let settings = UiFontSettings {
primary_choice: FontChoice::System(String::from("primary")), primary_choice: FontChoice::System(String::from("primary")),
@@ -622,7 +622,7 @@ mod tests {
assert_eq!( assert_eq!(
path, path,
PathBuf::from("/tmp/xdg-config") PathBuf::from("/tmp/xdg-config")
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME) .join(FONT_SETTINGS_FILE_NAME)
); );
} }
@@ -636,7 +636,7 @@ mod tests {
assert_eq!( assert_eq!(
path, path,
PathBuf::from(r"C:\Users\Test\AppData\Roaming") PathBuf::from(r"C:\Users\Test\AppData\Roaming")
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME) .join(FONT_SETTINGS_FILE_NAME)
); );
} }
@@ -652,7 +652,7 @@ mod tests {
PathBuf::from("/Users/tester") PathBuf::from("/Users/tester")
.join("Library") .join("Library")
.join("Application Support") .join("Application Support")
.join("pipeview") .join("xserial")
.join(FONT_SETTINGS_FILE_NAME) .join(FONT_SETTINGS_FILE_NAME)
); );
} }

View File

@@ -1,15 +1,15 @@
[package] [package]
name = "pipeview-tui" name = "xserial-tui"
version = "0.1.0" version = "0.1.0"
edition = "2024" edition = "2024"
[[bin]] [[bin]]
name = "pipeview-tui" name = "xserial-tui"
path = "src/main.rs" path = "src/main.rs"
[dependencies] [dependencies]
pipeview-core = { path = "../pipeview-core" } xserial-core = { path = "../xserial-core" }
pipeview-client = { path = "../pipeview-client" } xserial-client = { path = "../xserial-client" }
tokio = { workspace = true } tokio = { workspace = true }
ratatui = { workspace = true } ratatui = { workspace = true }
crossterm = { workspace = true } crossterm = { workspace = true }

View File

@@ -3,12 +3,12 @@ use std::{io, time::Duration};
use crossterm::event::{self, Event, KeyCode, KeyEventKind, KeyModifiers}; use crossterm::event::{self, Event, KeyCode, KeyEventKind, KeyModifiers};
use ratatui::DefaultTerminal; use ratatui::DefaultTerminal;
use tokio::sync::broadcast; use tokio::sync::broadcast;
use pipeview_client::{ use xserial_client::{
DecoderConfig, FramerConfig, PipelineConfig, SessionConfig, SessionEvent, SessionId, DecoderConfig, FramerConfig, PipelineConfig, SessionConfig, SessionEvent, SessionId,
SessionManager, SessionManager,
}; };
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
use pipeview_core::transport::{ use xserial_core::transport::{
TransportConfig, TransportType, TransportConfig, TransportType,
serial::{SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits, SerialTransport}, serial::{SerialDataBits, SerialFlowControl, SerialParity, SerialStopBits, SerialTransport},
}; };

View File

@@ -5,7 +5,7 @@ use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use tracing::warn; use tracing::warn;
use pipeview_client::SessionConfig; use xserial_client::SessionConfig;
const TUI_STATE_FILE_NAME: &str = "tui-state.json"; const TUI_STATE_FILE_NAME: &str = "tui-state.json";
@@ -49,12 +49,12 @@ fn state_path_for_os_and_env(os: &str, get_env: impl Fn(&str) -> Option<String>)
"windows" => { "windows" => {
if let Some(path) = get_env("APPDATA").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("APPDATA").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(TUI_STATE_FILE_NAME); .join(TUI_STATE_FILE_NAME);
} }
if let Some(path) = get_env("LOCALAPPDATA").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("LOCALAPPDATA").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(TUI_STATE_FILE_NAME); .join(TUI_STATE_FILE_NAME);
} }
} }
@@ -63,20 +63,20 @@ fn state_path_for_os_and_env(os: &str, get_env: impl Fn(&str) -> Option<String>)
return PathBuf::from(home) return PathBuf::from(home)
.join("Library") .join("Library")
.join("Application Support") .join("Application Support")
.join("pipeview") .join("xserial")
.join(TUI_STATE_FILE_NAME); .join(TUI_STATE_FILE_NAME);
} }
} }
_ => { _ => {
if let Some(path) = get_env("XDG_CONFIG_HOME").filter(|path| !path.trim().is_empty()) { if let Some(path) = get_env("XDG_CONFIG_HOME").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(path) return PathBuf::from(path)
.join("pipeview") .join("xserial")
.join(TUI_STATE_FILE_NAME); .join(TUI_STATE_FILE_NAME);
} }
if let Some(home) = get_env("HOME").filter(|path| !path.trim().is_empty()) { if let Some(home) = get_env("HOME").filter(|path| !path.trim().is_empty()) {
return PathBuf::from(home) return PathBuf::from(home)
.join(".config") .join(".config")
.join("pipeview") .join("xserial")
.join(TUI_STATE_FILE_NAME); .join(TUI_STATE_FILE_NAME);
} }
} }

View File

@@ -1,7 +1,7 @@
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use pipeview_client::{DecodedEntry, RingBuffer}; use xserial_client::{DecodedEntry, RingBuffer};
use pipeview_core::protocol::DecodedData; use xserial_core::protocol::DecodedData;
#[derive(Clone, Copy, PartialEq, Eq)] #[derive(Clone, Copy, PartialEq, Eq)]
pub enum LineDirection { pub enum LineDirection {

View File

@@ -10,7 +10,7 @@ use crossterm::{
terminal::{EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode}, terminal::{EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode},
}; };
use ratatui::{Terminal, backend::CrosstermBackend}; use ratatui::{Terminal, backend::CrosstermBackend};
use pipeview_client::SessionManager; use xserial_client::SessionManager;
#[tokio::main] #[tokio::main]
async fn main() -> io::Result<()> { async fn main() -> io::Result<()> {

View File

@@ -100,7 +100,7 @@ fn render_main(frame: &mut Frame, app: &App, area: Rect) {
app.help_text(), app.help_text(),
app.notice().unwrap_or("") app.notice().unwrap_or("")
)) ))
.block(Block::default().borders(Borders::ALL).title("pipeview-tui")) .block(Block::default().borders(Borders::ALL).title("xserial-tui"))
.wrap(Wrap { trim: false }), .wrap(Wrap { trim: false }),
area, area,
); );

View File

@@ -1,5 +1,5 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""Generate fake drone telemetry data for testing pipeview Lua decoder.""" """Generate fake drone telemetry data for testing xserial Lua decoder."""
import argparse import argparse
import math import math

View File

@@ -1,5 +1,5 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""TCP server that sends plot waveform frames or text lines for pipeview GUI.""" """TCP server that sends plot waveform frames or text lines for xserial GUI."""
import argparse import argparse
import math import math
@@ -116,7 +116,7 @@ def is_disconnect_error(err: OSError) -> bool:
def main() -> None: def main() -> None:
parser = argparse.ArgumentParser(description="pipeview plot test server") parser = argparse.ArgumentParser(description="xserial plot test server")
parser.add_argument("--host", default="127.0.0.1") parser.add_argument("--host", default="127.0.0.1")
parser.add_argument("--port", type=int, default=8080) parser.add_argument("--port", type=int, default=8080)
parser.add_argument("--channels", type=int, default=1) parser.add_argument("--channels", type=int, default=1)

View File

@@ -429,7 +429,7 @@ int main(int argc, char **argv) {
double frame_interval = (double)args.samples_per_channel / args.rate; double frame_interval = (double)args.samples_per_channel / args.rate;
double frame_rate = args.rate / (double)args.samples_per_channel; double frame_rate = args.rate / (double)args.samples_per_channel;
printf("═══ pipeview Serial Plot Generator ═══\n"); printf("═══ xserial Serial Plot Generator ═══\n");
printf("串口: %s @ %d baud\n", args.port, args.baudrate); printf("串口: %s @ %d baud\n", args.port, args.baudrate);
printf("通道: %u 格式: %s\n", args.channels, format_name); printf("通道: %u 格式: %s\n", args.channels, format_name);
printf("频率: %.1f Hz 振幅: %.1f\n", args.freq, args.amp); printf("频率: %.1f Hz 振幅: %.1f\n", args.freq, args.amp);

View File

@@ -208,7 +208,7 @@ int main(int argc, char **argv) {
double interval = 1.0 / args.rate; double interval = 1.0 / args.rate;
printf("═══ pipeview Plain Text Generator ═══\n"); printf("═══ xserial Plain Text Generator ═══\n");
printf("串口: %s @ %d baud\n", args.port, args.baudrate); printf("串口: %s @ %d baud\n", args.port, args.baudrate);
printf("通道: %u 振幅: %.1f 频率: %.1f Hz\n", args.channels, args.amp, args.freq); printf("通道: %u 振幅: %.1f 频率: %.1f Hz\n", args.channels, args.amp, args.freq);
printf("速率: %.0f lines/sec (间隔 %.3f ms)\n", args.rate, interval * 1000.0); printf("速率: %.0f lines/sec (间隔 %.3f ms)\n", args.rate, interval * 1000.0);