Serial Monitor 项目技术文档

Serial Monitor 项目技术文档

serial-monitor-rust A cross-plattform serial monitor/plotter written entirely in rust. 项目地址: https://gitcode.com/gh_mirrors/se/serial-monitor-rust

1. 安装指南

1.1 系统要求

• Linux: 需要安装 libxcb-render0-dev, libxcb-shape0-dev, libxcb-xfixes0-dev, libxkbcommon-dev, libssl-dev。
• macOS: 需要安装 xattr 工具。
• Windows: 需要安装 cargo-wix 工具。

1.2 安装步骤

1.2.1 Linux

1. 安装依赖库：

   sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
   

2. 安装 cargo-bundle：

   cargo install cargo-bundle
   

3. 运行 cargo bundle 创建平台可执行文件。

1.2.2 macOS

1. 安装 cargo-bundle：

   cargo install cargo-bundle
   

2. 运行 cargo bundle 创建平台可执行文件。
3. 如果运行 Apple Silicon 二进制文件时出现“Serial Monitor is damaged and cannot be opened.”错误，请运行以下命令：

   xattr -rd com.apple.quarantine Serial\ Monitor.app
   

1.2.3 Windows

1. 安装 cargo-wix：

   cargo install cargo-wix
   

2. 运行 cargo wix 创建 Windows 安装程序。

2. 项目使用说明

2.1 启动项目

1. 下载项目源码。
2. 使用 cargo run 命令启动项目。

2.2 功能介绍

• 数据绘图与打印: 支持同时进行数据绘图和打印。
• 智能数据解析器: 支持多种分隔符（,, , , :, : ）。
• 历史命令记录: 记录过去发送的命令。
• 低CPU使用率: 轻量级应用，CPU使用率低。
• 清除历史选项: 提供清除历史记录的选项。
• 数据窗口宽度可调: 可调整数据窗口的宽度。
• 跨平台: 完全使用 Rust 编写，支持 Linux、macOS 和 Windows。
• 保存文本到文件: 支持将文本保存到文件。
• 保存绘图: 支持保存绘图。
• 数据列标签: 支持为不同数据列添加标签。
• 串口配置: 支持选择数据位、流控制、奇偶校验和停止位。
• 自动保存配置: 关闭后自动保存串口配置，并在下次选择时自动加载。
• 保存原始数据: 支持将原始数据保存到文件。
• 快捷键: 支持使用快捷键（如 ctrl-S 保存数据，ctrl-shift-S 保存绘图，ctrl-X 清除绘图）。

3. 项目API使用文档

3.1 数据解析API

• 分隔符: 支持多种分隔符（,, , , :, : ）。
• 数据列标签: 支持为不同数据列添加标签。

3.2 串口配置API

• 数据位: 支持选择数据位。
• 流控制: 支持选择流控制。
• 奇偶校验: 支持选择奇偶校验。
• 停止位: 支持选择停止位。

3.3 快捷键API

• 保存数据: ctrl-S
• 保存绘图: ctrl-shift-S
• 清除绘图: ctrl-X

4. 项目安装方式

4.1 源码安装

1. 下载项目源码。
2. 使用 cargo run 命令启动项目。

4.2 二进制安装

1. 下载对应平台的二进制文件。
2. 运行二进制文件启动项目。

4.3 平台可执行文件安装

1. 使用 cargo bundle 或 cargo wix 创建平台可执行文件。
2. 运行生成的可执行文件启动项目。

---

通过以上步骤，您可以顺利安装并使用 Serial Monitor 项目。希望这篇技术文档能帮助您更好地理解和使用该项目。

serial-monitor-rust A cross-plattform serial monitor/plotter written entirely in rust. 项目地址: https://gitcode.com/gh_mirrors/se/serial-monitor-rust