README_zh_CN.md

串口助手

作者：康林（kl222@126.com)

---

🇺🇸 English

---

简介

• 项目位置:

  • 主库: https://github.com/KangLin/SerialPortAssistant
  • 镜像库:
    • 中国： https://gitee.com/kl222/SerialPortAssistant
    • https://gitlab.com/kl222/SerialPortAssistant
    • https://sourceforge.net/projects/serialportassistant/
    • https://bitbucket.org/kl222/serialportassistant

• 项目主页

• 本项目是一个跨平台的串口助手。
  它能运行在:

  • WINDOWS
  • Linux
  • Android
  • mac、os
    • 本人没有mac设备，请有设备的朋友自行编译和测试
    • 当前可以成功编译，但是没有正确设置加载动态库路径。请会设置的朋友帮助设置。

  详见：Qt5 支持平台、Qt6 支持平台。

• 程序截屏

  • 多语言
    • 中文
      
    • 英语
      

• 多样式

下载

• 
• 
• 

捐赠

如果你用得满意，可以对本人进行捐赠

如果不能显示，请打开：

• https://gitlab.com/kl222/RabbitCommon/-/raw/master/Src/Resource/image/Contribute.png
• https://sourceforge.net/p/rabbitcommon/code/ci/master/tree/Src/Resource/image/Contribute.png

开发

依赖

• Qt (LGPL v2.1)

• RabbitCommon: https://github.com/KangLin/RabbitCommon
  RabbitCommon 下载到与本项目同级目录中。如果不在同级目录，则需要指定环境变量： RabbitCommon_ROOT

  git clone https://github.com/KangLin/RabbitCommon.git
  

编译

• 下载源码

  git clone https://github.com/KangLin/SerialPortAssistant.git
  

• 下载 RabbitCommon

  git clone https://github.com/KangLin/RabbitCommon.git
  

• 用 QtCreator 编译

  • 直接用 QtCreator 打开工程文件 CMakeLists.txt
  • 如果 RabbitCommon 不在本项目同级目录中，设置参数 RabbitCommon_ROOT 指定其位置。
  • 直接编译就可以生成程序

• 用命令行编译

  • 在同一目录中下载源码与依赖

    git clone https://github.com/KangLin/RabbitCommon.git
    git clone https://github.com/KangLin/SerialPortAssistant.git
    

  • 在项目根目录下建立 build 目录

    cd SerialPortAssistant
    mkdir build
    cd build
    # cmake 配置
    cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`pwd`/install [-DRabbitCommon_ROOT=...]
    # 编译
    cmake --build . --config Release --target install
    cd install  # 程序安装在 install/bin 目录下
    

脚本

• build_debpackage.sh

  • 此脚本是 linux 下生成 deb 包的。使用前，请确保安装了下面程序

    sudo apt-get install debhelper fakeroot build-essential cmake
    

  • 用系统自带的 QT

    • qt6

      sudo apt-get install \
          qt6-tools-dev qt6-tools-dev-tools qt6-base-dev qt6-base-dev-tools \
          qt6-l10n-tools qt6-translations-l10n qt6-scxml-dev \
          qt6-webengine-dev qt6-webengine-dev-tools libqt6serialport6-dev
      

    详见: ubuntu.yml

    • qt5

      sudo apt-get install qttools5-dev qttools5-dev-tools \
          qtbase5-dev qtbase5-dev-tools qttranslations5-l10n \
          libqt5scxml5-dev libqt5svg5-dev libqt5serialport5-dev \
          qtwebengine5-dev qtwebengine5-dev-tools qtwebengine5-private-dev
      

• build_appimage.sh

  此脚本生成 AppImage 可执行文件。 详见：https://github.com/linuxdeploy/linuxdeploy/

• deploy.sh: 此脚本用于产生新的发行版本号和标签。仅程序发布者使用。

测试

• 在 Ubuntu 上

  • 安装 socat

    $ sudo apt update
    $ sudo apt install socat
    

  • 创建一对虚拟串口

    $ sudo socat -d -d pty,raw,echo=0 pty,raw,echo=0
    

    • 运行后会显示：

      2025/12/03 14:09:27 socat[31902] N PTY is /dev/pts/5
      2025/12/03 14:09:27 socat[31902] N PTY is /dev/pts/6
      2025/12/03 14:09:27 socat[31902] N starting data transfer loop with FDs [5,5] and [7,7]
      

    • 创建符号链接（可选，为了更好的命名）

      $ sudo ln -sf /dev/pts/2 /dev/ttyVCOM0
      $ sudo ln -sf /dev/pts/3 /dev/ttyVCOM1
      

    • 可以把上面两步合成以下一条命令

      $ sudo socat -d -d pty,link=/dev/ttyVCOM0,raw,echo=0 pty,link=/dev/ttyVCOM1,raw,echo=0 
      

  • 现在可以用本程序打开串口　/dev/pts/5(/dev/ttyVCOM0) 和　/dev/pts/6(/dev/ttyVCOM1)。
    　　因为这些串口命名为非标准串口命名，本程序可以找不到它。你可以在"串口"输入：　/dev/pts/5
    　　因为虚拟串口建立时，是以 root 权限建立的，所以也需要使用　root 权限运行本程序。

    $ sudo serialportassistant
    

    或者把串口授权为当前用户。

    $ sudo chown $USER:tty /dev/pts/5
    $ sudo chown $USER:tty /dev/pts/6
    $ serialportassistant