Skip to content

Fwind43/SerialX

Repository files navigation

SerialX

现代化的 Windows 串口调试工具

基于 Electron + Vue 3 构建,为串口联调和数据分析提供高效的工作体验

下载报告问题

📸 界面预览

SerialX 主界面

✨ 核心特性

🔌 串口通信

  • 多端口同时连接 - 同时管理多个串口设备
  • 文本/HEX 双模式 - 灵活切换数据显示格式
  • HEX + ASCII 联合显示 - 二进制数据可视化
  • 分色显示 - TX/RX 数据自动区分颜色

📟 终端体验

  • 多终端面板 - 每个串口独立终端窗口
  • 实时搜索 - 支持大小写敏感搜索
  • 智能滚动 - 自动滚动与手动浏览模式
  • 快捷操作 - 右键菜单、全选、复制、清屏
  • 日志导出 - 支持 JSON 和纯文本格式

🎯 工作区管理

  • 多分屏布局 - 灵活的多窗口分屏
  • 拖拽调整 - 分屏宽度调节、位置互换
  • 标签拖拽 - 标签可在分屏间自由移动
  • 快照系统 - 保存/加载工作区布局,快速切换场景
  • 会话恢复 - 自动保存工作状态

📤 发送功能

  • 文本/HEX 发送 - 支持多种数据格式
  • 循环发送 - 可配置延时、次数和失败阈值
  • 命令管理 - 分组管理常用命令,支持大量命令快速筛选
  • 历史记录 - 自动保存最近发送的命令

🎨 外观定制

  • 主题切换 - 内置浅色/深色主题
  • 自定义壁纸 - 支持本地图片作为背景
  • 透明度调节 - 侧栏、工作区、终端独立调节
  • 字体设置 - 终端字体大小和粗细可调

🛠️ 实用工具

  • 进制转换器 - 独立的进制转换工具窗口
  • 配置导入/导出 - 快速迁移设置和工作区

📦 快速开始

下载安装

前往 Releases 页面下载最新版本的安装包(SerialX-x.x.x-Setup.exe),运行安装即可。

基本使用

  1. 连接串口

    • 点击左上角 "+" 按钮添加串口
    • 选择端口、波特率等参数
    • 点击 "连接" 开始通信
  2. 发送数据

    • 在底部输入框输入数据
    • 选择文本或 HEX 模式
    • 按 Enter 或点击发送按钮
  3. 工作区管理

    • 右键分屏标题栏添加/删除分屏
    • 拖拽标签在分屏间移动
    • 使用快照功能保存常用布局

🔧 技术栈

模块 技术
桌面框架 Electron 41
前端框架 Vue 3 + Vite
状态管理 Pinia
串口通信 serialport + @serialport/bindings-cpp
终端渲染 xterm.js + xterm-addon-fit + xterm-addon-search
构建打包 electron-vite + electron-builder

💻 开发指南

环境要求

  • Node.js 18 或更高版本
  • npm 9 或更高版本
  • Windows 10 或更高版本

本地开发

# 克隆仓库
git clone https://github.com/Fwind43/SerialX.git
cd SerialX

# 安装依赖
npm install

# 启动开发模式
npm run dev

构建和打包

# 构建项目
npm run build

# 打包 Windows 安装程序
npm run dist:win

构建产物会输出到 release/ 目录。

项目结构

SerialX/
├── electron/          # Electron 主进程代码
├── src/
│   ├── components/   # Vue 组件
│   ├── stores/       # Pinia 状态管理
│   ├── assets/       # 静态资源
│   ├── App.vue       # 应用根组件
│   └── main.js       # 渲染进程入口
├── docs/             # 版本计划和开发文档
├── logo/             # 应用图标
└── release/          # 构建输出目录

CI/CD

项目使用 GitHub Actions 进行自动化构建:

  • 推送到 main 分支或 PR - 自动构建并上传产物
  • 推送 v* 标签 - 自动创建 Release 并发布安装包
  • 手动触发 - 可在 Actions 页面手动运行构建

📝 开发文档

docs/ 目录包含了各版本的开发计划和缺陷记录,供贡献者参考。


🤝 贡献

欢迎提交 Issue 和 Pull Request!

如果你发现了 bug 或有功能建议,请在 Issues 页面提交。


📄 许可证

ISC License


🔗 链接

About

SerialX desktop serial port tool

Resources

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages