CSerialPort

CSerialPort

中文

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

---

Design Principles

• Cross-platform
• Easy to use
• Higher efficiency
• Custom protocol parsing

Feature

• cross-platform windows linux macOS android freebsd
• sync and async read/write
• custom protocol parsing - IProtocolParser and CommNoGuiProtocol
• hot plug notify - CSerialPortHotPlugListener
• third party language bindings - C, C#, Java, Python, Node.js, Electron, Rust - more information bindings
• usage tutorial - CSerialPort Tutorial
• new cross-platform gui serial port tool - CommMaster

Todo List

Long-term Goal

• 1.support modern c++11 standard
• 2.support character interval timeout and custom protocol parsing
• 3.support raw sync(implemented), raw async(implemented) and extend sync mode(not implemented)
• 4.support script engine

Short-term Goal

• 1.cross-platform OS identify class
• 2.cross-platform thread class
• 3.cross-platform lock class
• 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: 5.0.0.260619

by itas109 on 2026-06-19

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 
[INFO] CSerialPort - OS: Linux, ProductName: Ubuntu 22.04.2 LTS, Arch: x86_64, ProcessorNum: 16, Compiler: gcc(11.4.0), Bit: 64, C++: 201103L, Bindings: , Version: https://github.com/itas109/CSerialPort - v5.0.0.260619
Version: https://github.com/itas109/CSerialPort - v5.0.0.260619

AvailableFriendlyPorts:
1 - /dev/ttyCH341USB0 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/ttyCH341USB0
[INFO] openPort - portName: /dev/ttyCH341USB0, baudRate: 9600, dataBit: 8, parity: 0, stopBit: 1, flowControl: 0, mode: async, readBufferSize:4096(4096), readIntervalTimeoutMS: 0, minByteReadNotify: 1, byteReadBufferFullNotify: 3276
[INFO] startReadThread - /dev/ttyCH341USB0 start read thread success. thread id: 140057885512640
[INFO] openPort - open /dev/ttyCH341USB0. code: 0, message: success
Open /dev/ttyCH341USB0 Success
Code: 0, Message: success
[INFO] writeData - /dev/ttyCH341USB0 write. len: 5, hex(top100): 3132333435
[INFO] writeData - /dev/ttyCH341USB0 write. len: 7, hex(top100): 69746173313039
[INFO] readThreadFun - /dev/ttyCH341USB0 write buffer(usedLen 12). len: 12, hex(top100): 313233343569746173313039
[INFO] readThreadFun - onReadEvent read byte. portName: /dev/ttyCH341USB0, readLen: 12
[INFO] readData - read. len: 12, hex(top100): 313233343569746173313039
/dev/ttyCH341USB0 - 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 22.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 .

• arm on windows

$ cd CSerialPort
$ mkdir bin_arm && cd bin_arm
$ cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_arm_win32.cmake
$ cmake --build .

• aarch64 on ubuntu 22.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 .

• aarch64 on windows

$ cd CSerialPort
$ mkdir bin_aarch64 && cd bin_aarch64
$ cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_aarch64_win32.cmake
$ cmake --build .

• mips64el on ubuntu 22.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 22.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 .

• mingw64(windows posix thread) on ununtu 22.04

$ sudo apt-get install mingw-w64
$ cd CSerialPort
$ mkdir bin_mingw64 && cd bin_mingw64
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchain_mingw64_linux.cmake
$ cmake --build .

Screenshot

Gui

Demo Path: CSerialPort/examples/CommQT

Demo Path: CSerialPort/examples/CommElectron

Web

Demo Path: CSerialPort/examples/CommWeb

No Gui

Demo Path: CSerialPort/examples/CommNoGui

Documents

API Document Directory List Document Error Guide Document Frequently Asked Questions

Contacting

• Email : [email protected]
• QQ Group : 129518033

Links

• CSDN Blog
• Github
• Gitee

CSerialPort-based Applications

1. CommMaster

• support windows/linux/macos/raspberrypi and so on
• support custom port name
• support custom baudrate
• support custom language
• support custom theme

https://gitee.com/itas109/CommMaster

Donate

CSDN Blog

---

Other branches

Only for windows branch : https://github.com/itas109/CSerialPort/tree/CSerialPort_win_3.0.3

Thanks for Remon Spekreijse’s serial library

---

License

CSerialPort v3.0.0.171216 - v4.3.1.240204 is licensed under the LGPLv3

CSerialPort v4.3.2.250203 - present is licensed under the LGPLv3 with LGPL-3.0-linking-exception