# SerialPortAssistant

**Repository Path**: qt-open-source-collection/SerialPortAssistant

## Basic Information

- **Project Name**: SerialPortAssistant
- **Description**: 本项目是一个跨平台的串口助手。它能运行在WINDOWS、linux、mac系统上
- **Primary Language**: C++
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: https://github.com/KangLin/SerialPortAssistant
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 48
- **Created**: 2021-05-11
- **Last Updated**: 2023-09-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Serial Port Assistant

Author: Kang Lin (kl222@126.com)

--------------------------------

[<img src="App/Resource/png/China.png" alt="Chinese" title="Chinese" width="16" height="16" />Chinese](README_zh_CN.md)

## Introduction
### Project position: https://github.com/KangLin/SerialPortAssistant
### [Project home](http://kanglin.github.io/SerialPortAssistant)
### This project is a cross-platform serial 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.

### Complie status

[![windows、android](https://ci.appveyor.com/api/projects/status/y77e828ysqc79r9o?svg=true)](https://ci.appveyor.com/project/KangLin/serialportassistant)
[![linux](https://travis-ci.org/KangLin/SerialPortAssistant.svg?branch=master)](https://travis-ci.org/KangLin/SerialPortAssistant)

### Multi-language
   
* Chinese

  ![Chinese](Docs/ui-zh.jpg)

* Englisth

    ![Englisth](Docs/ui-en.jpg)

### Multi style

## [Release download](https://github.com/KangLin/SerialPortAssistant/releases)  
### [Latest release download](https://github.com/KangLin/SerialPortAssistant/releases/latest)

#### windows
    
[SerialPortAssistant-Setup-v0.5.8.exe](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.8/SerialPortAssistant-Setup-v0.5.8.exe)

#### linux

[SerialPortAssistant_v0.5.8.tar.gz](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.8/SerialPortAssistant_v0.5.8.tar.gz)  

The AppImage format executable can be run directly on the Linux system, see: https://appimage.org/  
Usage:

1. Decompress. Copy SerialPortAssistant_v0.5.8.tar.gz to install directory, then decompress it:

        sudo mkdir /opt/SerialPortAssistant
        cd SerialPortAssistant
        sudo wget https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.8/SerialPortAssistant_v0.5.8.tar.gz
        sudo tar xvfz SerialPortAssistant_v0.5.8.tar.gz
    
2. install
    
        sudo ./install1.sh install SerialPortAssistant
   
3. If you want to uninstall
    
        sudo ./install1.sh remove SerialPortAssistant

#### ubuntu

[serialportassistant_0.5.8_amd64.deb](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.8/serialportassistant_0.5.8_amd64.deb)

        sudo dpkg -i serialportassistant_0.5.8_amd64.deb

#### android

[SerialPortAssistant_v0.5.8.apk](https://github.com/KangLin/SerialPortAssistant/releases/download/v0.5.8/SerialPortAssistant_v0.5.8.apk)
    
## Donate  
If you are satisfied, you can donate to me

[![donation](https://gitee.com/kl222/RabbitCommon/raw/master/Src/Resource/image/Contribute.png "donation")](https://gitee.com/kl222/RabbitCommon/raw/master/Src/Resource/image/Contribute.png "donation")

## Developer  
### Dependence  

+ [Qt (LGPL v2.1)](http://qt.io/)
+ RabbitCommon: https://github.com/KangLin/RabbitCommon

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

### Compile  
  
- Download source code

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

- Compiled with QtCreator
  + Open the project file ![SerialPortAssistant.pro](SerialPortAssistant.pro) with QtCreator
  + Set the parameter RabbitCommon_DIR

        Project -> Build & Run -> Build -> Build settings -> Build step -> qmake 

  + Direct compilation can generate programs
- Compile with the command line
  + Build the build directory in the project root directory
  + *qmake* build compilation project
    - *make* install Build the program with the local toolchain
    - The program is generated in the *install* directory

          mkdir build
          cd build
          qmake ../SerialPortAssistant.pro
          make install
          cd install  #The program is generated in the install 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 
    
  + Use system qt

        sudo apt-get install -y -qq qttools5-dev qttools5-dev-tools \
                 libqt5serialport5-dev qtbase5-dev qtbase5-dev-tools

- tag.sh: This script is used to generate new release version numbers and tag