CSerialPort

中文

CSerialPort is a lightweight cross-platform serial port library based on C++, which can easy to read and write serial port on multiple operating system. Also support C, C#, Java, Python, Node.js, Electron etc.

appveyor-ci

Design Principles

Cross-platform
Easy to use
Higher efficiency

Platform

CSerialPort was tested on the following platforms

Windows ( x86, x86_64, arm64 )
Linux ( x86, x86_64, arm, arm64/aarch64, mips64el, riscv, s390x, ppc64le )
macOS ( x86_64 )
Raspberry Pi ( armv7l )
FreeBSD ( x86_64 )
...

Todo List

Long-term Goal

[x] 1.support windows and linux first
[ ] 2.add communicating protocol
[x] 3.support hot swap - CSerialPortExtend
[x] 4.higher efficiency notify module - replace with CSerialPortListener
[x] 5.support other language - C, C#, Java, Python, Node.js, Electron etc. - more information bindings
[x] 6.sync serial port communication
[x] 7.new cross-platform gui serial port tool - CommMaster
[x] 8.add introduction and tutorial of CSerialPort - CSerialPort Tutorial
[ ] 9.serial port monitor hook

Short-term Goal

[x] 1.cross-platform OS identify class
[x] 2.cross-platform thread class
[x] 3.cross-platform lock class
[x] 4.cross-platform higher efficiency timer class
[ ] 5.cross-platform thread pool class
[ ] 6.Performance test report(Throughput && delay && packet dropout rates)

Latest version

Version: 4.3.1.240204

by itas109 on 2024-02-04

Quick Start

$ git clone --depth=1 https://github.com/itas109/CSerialPort.git
$ cd CSerialPort
$ mkdir bin && cd bin
$ cmake ..
$ cmake --build .

run demo ( for example serial port lookback test on linux)

CSerialPort/bin $ ./CSerialPortDemoNoGui 
Version: https://github.com/itas109/CSerialPort - V4.3.1.240204

AvailableFriendlyPorts:
1 - /dev/ttyUSB0 QinHeng CH340 serial converter 1a86:7523
2 - /dev/pts/0 0 pty terminal

Please Input The Index Of Port(1 - 2)
1
Port Name: /dev/ttyUSB0
[CSERIALPORT_DEBUG] openPort - portName: /dev/ttyUSB0, baudRate: 9600, dataBit: 8, parity: 0, stopBit: 0, flowControl: 0, mode: async, readBufferSize:4096(4096), readIntervalTimeoutMS: 0, minByteReadNotify: 1
[CSERIALPORT_DEBUG] openPort - open /dev/ttyUSB0. code: 0, message: success
Open /dev/ttyUSB0 Success
Code: 0, Message: success
[CSERIALPORT_DEBUG] writeData - write. len: 5, hex(top100): 3132333435
[CSERIALPORT_DEBUG] writeData - write. len: 7, hex(top100): 69746173313039
[CSERIALPORT_DEBUG] commThreadMonitor - write buffer(usedLen 12). len: 12, hex(top100): 313233343569746173313039
[CSERIALPORT_DEBUG] commThreadMonitor - onReadEvent. portName: /dev/ttyUSB0, readLen: 12
[CSERIALPORT_DEBUG] readData - read. len: 12, hex(top100): 313233343569746173313039
/dev/ttyUSB0 - Count: 1, Length: 12, Str: 12345itas109, Hex: 0x31 0x32 0x33 0x34 0x35 0x69 0x74 0x61 0x73 0x31 0x30 0x39

Install CSerialPort Using Vcpkg

You can download and install CSerialPort using the vcpkg dependency manager

$ git clone https://github.com/Microsoft/vcpkg.git
$ cd vcpkg
$ ./bootstrap-vcpkg.sh
$ ./vcpkg install cserialport

Cross Compile

arm on ubuntu 20.04

$ sudo apt-get install g++-arm-linux-gnueabi
$ cd CSerialPort
$ mkdir bin_arm && cd bin_arm
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_arm.cmake
$ cmake --build .

aarch64 on ubuntu 20.04

$ sudo apt-get install g++-aarch64-linux-gnu
$ cd CSerialPort
$ mkdir bin_aarch64 && cd bin_aarch64
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_aarch64.cmake
$ cmake --build .

mips64el on ubuntu 20.04

$ sudo apt-get install g++-mips64el-linux-gnuabi64
$ cd CSerialPort
$ mkdir bin_mips64el && cd bin_mips64el
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_mips64el.cmake
$ cmake --build .

riscv64 on ubuntu 20.04

$ sudo apt-get install g++-riscv64-linux-gnu
$ cd CSerialPort
$ mkdir bin_riscv64 && cd bin_riscv64
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_riscv64.cmake
$ cmake --build .