# ubibot-serial-sync

**Repository Path**: ubibot-open/ubibot-serial-sync

## Basic Information

- **Project Name**: ubibot-serial-sync
- **Description**: No description available
- **Primary Language**: C++
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-17
- **Last Updated**: 2026-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# UbiBot 串口助手

一款基于 Qt 6 构建的跨平台、轻量级桌面串口工具——完全开源、免费。
专为 UbiBot 物联网设备（WS1、WS1 Pro、GS1-AL4G1RS、SP1……）打造并做了针对性优化，
UbiBot 设备指令支持云端同步：新设备上市时，已经安装了本应用的用户无需等待新版本发布即可使用。

## 下载

预编译的自包含安装包——无需安装 Qt，也不需要其他任何依赖——
发布在 [Releases 页面](https://gitee.com/ubibot-open/ubibot-serial-sync/releases)。
下面的链接始终指向最新构建：

| 平台 | 下载 |
|---|---|
| Windows | [UbiBotSerialAssistant-windows-x64.zip](https://gitee.com/ubibot-open/ubibot-serial-sync/releases/latest/download/UbiBotSerialAssistant-windows-x64.zip) |
| macOS | [UbiBotSerialAssistant-macos.dmg](https://gitee.com/ubibot-open/ubibot-serial-sync/releases/latest/download/UbiBotSerialAssistant-macos.dmg) |
| Linux | [UbiBotSerialAssistant-linux-x86_64.AppImage](https://gitee.com/ubibot-open/ubibot-serial-sync/releases/latest/download/UbiBotSerialAssistant-linux-x86_64.AppImage)（先 `chmod +x`，然后直接运行——无需安装） |

Windows 的 .exe 和 macOS 的 .app/.dmg 均未进行代码签名，因此首次运行时
SmartScreen/Gatekeeper 会弹出常规的"未知发布者"警告——
和其他未签名的开源程序一样，直接点击继续即可（macOS 上可以右键 → 打开）。

**使用本应用无需从源码构建**——只有当你想自己构建、扩展它，
或者想了解它的内部实现时，才需要看 [BUILD.md](BUILD.md)。

## 用户界面

整个窗口使用无边框设计，标题栏和窗口边框均为自绘
（而非操作系统原生样式），因此不只是窗口内容，整个窗口都会跟随应用的浅色/深色主题。

**串口连接设置**——端口、波特率、数据位/停止位、校验位、
流控，以及接收选项（时间戳、自动换行、回显）和
发送选项（ASCII/HEX 模式、追加 CRC16/MODBUS 校验、定时重复发送间隔）：

![串口连接面板](docs/screenshots/serial-panel.png)

**设备指令库**——按型号划分、可搜索的 AT/JSON 指令集，
支持拖拽排序，另有自定义快捷发送模板，以及可保存的多步骤"批量指令"：

![设备指令库面板](docs/screenshots/device-commands-panel.png)

**设置与关于**——运行时切换语言、字体选择、浅色/深色主题，
以及设备指令库自身的版本/更新状态：

![设置与关于对话框](docs/screenshots/settings-about.png)

除了上图所示内容之外：这些面板上方还有完整的菜单栏（文件/编辑/视图/工具/帮助）和工具栏（保存日志、发送、暂停、清空、设置、打开/关闭端口）；
右侧还有一个始终可见的数据监视窗格（无论当前激活的是哪个面板），
包含按颜色区分的 TX/RX/SYS/ERR 日志，以及带历史记录的手动发送框。

## 功能特性

### 串口收发（`QSerialPort`）
- 完整的端口配置：波特率、数据位、校验位、停止位、流控。
- ASCII 或 HEX 格式收发。
- 可选的 CRC16/MODBUS 校验：启用后，每次发送（无论手动发送还是从设备指令库发送）
  都会自动在末尾追加校验值。
- 定时重复发送：按固定间隔重复发送手动发送框中的当前内容。
- 将已发送数据回显到日志中，可分别开关每行时间戳和自动换行。
- 手动发送历史——每一条发送过的内容都会保留，双击即可再次使用。

### 设备指令库
- 按型号划分的指令集，分组展示且可搜索，同时支持纯文本 AT
  指令（`AT+INTERVAL=<sec>`）和 JSON 负载类设备（指令体采用 base64 编码）。
- 对于需要参数的指令，会弹出参数面板；选择自带推荐串口设置的型号时，
  会提示是否应用这些设置。
- 指令列表支持拖拽排序；"我的模板"用于保存你自己的快捷发送片段
  （可添加/编辑/删除，与具体设备无关）；"批量指令"用于保存一个具名的步骤序列，
  按固定间隔逐条发送（每一步都可以单独设置 ASCII/HEX 以及是否追加 CRC）。
- 添加型号或指令只需编辑一个 JSON 文件——修改内容无需重新编译。

### 设备指令库远程更新
- 上述设备/指令数据不必固化在程序里：
  应用可以向配置好的后端检查是否有更新版本，并原地下载更新（无需重启）。

### 软件自动更新（当前已禁用）
- 完整的"检查应用新版本 → 下载 → 校验 → 替换 → 重新启动"流程已经实现（仅限 Windows），
  并且可以端到端正常工作，但其菜单入口目前被注释掉了，
  因为它所依赖的后端注册尚未部署。

### 数据监视
- 按颜色区分的 TX/RX/SYS/ERR 日志、字节计数、暂停/清空。
- 一键导出为纯文本 / CSV / HEX dump。
- 可选的持续文件日志，按天自动轮转。

### 远程协助（早期预览）
- 会话码/OTP 生成和权限开关已全部实现，但背后还没有信令/中继服务器，
  也没有点对点传输通道；而且该面板目前在主窗口中完全无法进入
  （见 [BUILD.md](BUILD.md#设计说明)）。

### 国际化
目前支持英语、简体中文、繁体中文、日语、韩语、俄语、法语和意大利语，
可在"设置与关于"中运行时切换，每种语言都以其本族语名称显示。

### 浅色/深色主题
可在运行时切换，作用于整个窗口，包括自绘的标题栏。

### 跨平台
同一套 Qt/QML/C++17 代码即可为 Windows、macOS 和 Linux 构建独立安装包，
每次打版本标签时都会自动生成——见
[BUILD.md](BUILD.md#通过-github-actions-发布正式构建)。

## 优势

- **原生且轻量**——基于 Qt Quick/QML，而不是捆绑一个浏览器运行时；
  是真正的桌面应用，占用小、启动快，而不是 Electron 套壳。
- **数据驱动的设备支持**——添加新的 UbiBot 型号或指令只需编辑 JSON，
  无需修改代码或重新编译；而且（借助远程更新机制）连新版本都不用发布，
  已安装本应用的用户就能用上。
- **一套代码，三个平台**——Windows/macOS/Linux 版本出自同一个源码树和同一条 CI 流水线，
  而不是分别维护的三个移植版本。
- **完整本地化**，而不是事后硬塞进去一些翻译字符串——
  所有界面元素（包括无边框标题栏）都会遵循当前的语言和主题。
- **可免费商用**——LGPLv3，以动态链接方式使用 Qt（见
  [BUILD.md 中的 Qt 6 模块许可](BUILD.md#qt-6-模块许可商用合规检查)
  一节）——使用、修改、转售或嵌入本软件都无需购买 Qt 商业许可。
- **可复现的自动化发布**——每个打了标签的版本都由 CI 从干净的代码检出构建并发布，
  而不是在某个人的笔记本上手工拼凑出来的。

## 参与贡献

见[组织级 CONTRIBUTING.md](https://gitee.com/ubibot-open/.github/blob/main/CONTRIBUTING.md)。

## 许可证

本项目采用 **GNU 宽通用公共许可证 v3.0（LGPLv3）** 授权——见 [LICENSE](LICENSE)。
由于 LGPLv3 以引用方式包含了 GPLv3，其所引用的 GPLv3 全文也原样收录在
[COPYING](COPYING) 中（[COPYING.LESSER](COPYING.LESSER) 中则是与 `LICENSE` 相同的
LGPLv3 条款，这是 FSF 对使用这对许可证的项目所推荐的惯例）。
关于 Qt 模块许可/商用兼容性检查，见 [BUILD.md](BUILD.md#qt-6-模块许可商用合规检查)。