https://github.com/kanglin/serialportassistant
This project is a cross-platform serial port assistant. It can run on WINDOWS, linux、android、macos system.
https://github.com/kanglin/serialportassistant
android donation linux macos serial serial-ports serialport serialportassistant
Last synced: 6 months ago
JSON representation
This project is a cross-platform serial port assistant. It can run on WINDOWS, linux、android、macos system.
- Host: GitHub
- URL: https://github.com/kanglin/serialportassistant
- Owner: KangLin
- License: gpl-3.0
- Created: 2017-02-17T07:45:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T07:04:27.000Z (7 months ago)
- Last Synced: 2025-03-28T14:06:11.152Z (7 months ago)
- Topics: android, donation, linux, macos, serial, serial-ports, serialport, serialportassistant
- Language: C++
- Homepage:
- Size: 2.16 MB
- Stars: 166
- Watchers: 5
- Forks: 63
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Funding: .github/FUNDING.yml
- License: License.md
- Authors: Authors.md
Awesome Lists containing this project
README
# Serial Port Assistant
Author: Kang Lin (kl222@126.com)
--------------------------------
[:cn: 中文](README_zh_CN.md)
[](https://star-history.com/#KangLin/SerialPortAssistant&Date)
[](https://gitee.com/kl222/SerialPortAssistant/stargazers)[](https://github.com/KangLin/SerialPortAssistant/forks)
[](https://github.com/KangLin/SerialPortAssistant/issues)[](https://github.com/KangLin/SerialPortAssistant/releases/latest)
[](https://sourceforge.net/projects/serialportassistant/files/latest/download)[](http://gra.caldis.me/?user=KangLin&repo=SerialPortAssistant)
[](https://sourceforge.net/projects/serialportassistant/files/latest/download)[](https://github.com/KangLin/SerialPortAssistant/actions/workflows/build.yml)
[](https://ci.appveyor.com/project/KangLin/serialportassistant)--------------------------------
## Introduction
- Project position:
+ Main repository: https://github.com/KangLin/SerialPortAssistant
+ Mirrory repository:
- https://gitlab.com/kl222/SerialPortAssistant
- https://sourceforge.net/projects/serialportassistant/
- https://gitee.com/kl222/SerialPortAssistant
- https://bitbucket.org/kl222/serialportassistant
- [Project home](http://kanglin.github.io/SerialPortAssistant)
- This project is a cross-platform serial port assistant.
It can run on:
+ [x] WINDOWS
+ [x] linux
+ [x] Android
+ [x] mac, os
- Mac os, I don't have the corresponding equipment,
please compile and test the user with the corresponding equipment.
- Currently compiles successfully.
but the loading dynamic library path is not set correctly.
Please help you set it.
See: [Qt5 supported platforms](https://doc.qt.io/qt-5/supported-platforms.html), [Qt6 supported platforms](https://doc.qt.io/qt-6/supported-platforms.html).
- Multi-language
+ Chinese
+ Englisth

- Multi style
## Download
### Instructions for installing the package
- Windows: The extension is .exe
- Linux:
- deb package: for Debian, Ubuntu, etc
- rpm package: for RedHat, Fedora, CentOS, etc
- AppImage package: for all Linux systems
- Snap Package: Used on all Linux systems that support Snap.
Ubuntu uses this installation package by default.
- Flatpak Package: For all Linux systems that support Flatpak.
Fedora uses this installation package by default.
- Android: The extension is .apk
- Apple OS: SerialPortAssistant_0.5.31_macos_qt6.8.2.zip
No tests were carried out as there was no relevant equipment.
We hope that interested friends will participate in the development and testing.### Download position
- [](https://github.com/KangLin/SerialPortAssistant/releases/latest)
- [](https://sourceforge.net/projects/serialportassistant/files/latest/download)
- [](https://flathub.org/apps/io.github.KangLin.SerialPortAssistant)### Installation Instructions:
- Linux
- Ubuntu, Debian
- [serialportassistant_0.5.31_ubuntu-24.04_amd64.deb](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/serialportassistant_0.5.31_ubuntu-24.04_amd64.deb)sudo apt install ./serialportassistant_0.5.31_ubuntu-24.04_amd64.deb
# If you're on an older Linux distribution, you will need to run this instead:
# sudo dpkg -i serialportassistant_0.5.31_ubuntu-24.04_amd64.deb
# sudo apt-get install -f # Install dependencies- Other Linux(AppImage)
- [SerialPortAssistant_v0.5.31_Linux_x86_64.AppImage](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/SerialPortAssistant_v0.5.31_Linux_x86_64.AppImage)
sudo chmod a+x SerialPortAssistant_v0.5.31_Linux_x86_64.AppImage
sudo ./SerialPortAssistant_v0.5.31_Linux_x86_64.AppImage- Windows
- Windows xp
- [SerialPortAssistant_v0.5.31_windows_xp_x86_Setup.exe](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/SerialPortAssistant_v0.5.31_windows_xp_x86_Setup.exe)
- Windows 7 or later
- [SerialPortAssistant_v0.5.31_win32_msvc2017_qt5.12.12_Setup.exe](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/SerialPortAssistant_v0.5.31_win32_msvc2017_qt5.12.12_Setup.exe)
- Windows 10 (1809 or later)
- [SerialPortAssistant_v0.5.31_win64_msvc2022_64_qt6.8.2_Setup.exe](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/SerialPortAssistant_v0.5.31_win64_msvc2022_64_qt6.8.2_Setup.exe)- Android 9 or later
- [SerialPortAssistant_v0.5.31_android_arm64_v8a_qt6.8.2_Release.apk](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/SerialPortAssistant_v0.5.31_android_arm64_v8a_qt6.8.2_Release.apk)
- [SerialPortAssistant_v0.5.31_android_x86_64_qt6.8.2_Release.apk](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.31/SerialPortAssistant_v0.5.31_android_x86_64_qt6.8.2_Release.apk)## Donate
If you are satisfied, you can donate to me
[](https://github.com/KangLin/RabbitCommon/raw/master/Src/Resource/image/Contribute_en.png "donation")
If it cannot be displayed, please open:
- 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## Developer
### Dependence+ [Qt (LGPL v2.1)](http://qt.io/)
+ RabbitCommon: https://github.com/KangLin/RabbitCommon
It can be downloaded to the same directory of the project.
If it is a different directory, set the environment variable `RabbitCommon_ROOT`git clone https://github.com/KangLin/RabbitCommon.git
### Compile
- Download source codegit clone https://github.com/KangLin/SerialPortAssistant.git
- Compiled with QtCreator
+ Open the project file [CMakeLists.txt](CMakeLists.txt) with QtCreator
+ The RabbitCommon can be downloaded to the same directory of the project.
If it is a different directory, Set the parameter `RabbitCommon_ROOT`
+ Direct compilation can generate programs
- Compile with the command line
+ Download source code and the deplendence in same directory
git clone https://github.com/KangLin/RabbitCommon.git
git clone https://github.com/KangLin/SerialPortAssistant.git+ Make the build directory in the project root directory
cd SerialPortAssistant
mkdir build
cd build
# cmake configure
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=`pwd`/install [-DRabbitCommon_ROOT=...]
# compiling
cmake --build . --config Release --target install
cd install # The program is installed in the install/bin directory### Script
- build_debpackage.sh
+ This script generates the deb package under linux.
Before use, please make sure the following programs are installed
sudo apt-get install debhelper fakeroot build-essential cmake+ Use system qt
- qt6sudo 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-devSee: [ubuntu.yml](.github/workflows/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
build AppImage. See: https://github.com/linuxdeploy/linuxdeploy/
- deploy.sh: This script is used to generate new release version numbers and tag.
Used only by the program publisher.