Awesome
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.
<p> <a href="https://github.com/itas109/CSerialPort/releases"><img alt="Version" src="https://img.shields.io/github/release/itas109/CSerialPort"/></a> <a href="https://github.com/itas109/CSerialPort/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/itas109/CSerialPort"/></a> <a href="https://gitee.com/itas109/CSerialPort"><img alt="Stars" src="https://gitee.com/itas109/CSerialPort/badge/star.svg?theme=dark"/></a> <a href="https://github.com/itas109/CSerialPort/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/badge/License-LGPL%203.0-orange"/></a> <img alt="language" src="https://img.shields.io/badge/language-c++-red"/> <img alt="appveyor-ci" src="https://ci.appveyor.com/api/projects/status/a4t6ddubhns561kh?svg=true"/> <!-- <img alt="travis-ci" src="https://www.travis-ci.org/itas109/CSerialPort.svg?branch=master"/> --> </p>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
- 1.support windows and linux first
- 2.add communicating protocol
- 3.support hot swap - CSerialPortExtend
- 4.higher efficiency notify module - replace with CSerialPortListener
- 5.support other language - C, C#, Java, Python, Node.js, Electron etc. - more information bindings
- 6.sync serial port communication
- 7.new cross-platform gui serial port tool - CommMaster
- 8.add introduction and tutorial of CSerialPort - CSerialPort Tutorial
- 9.serial port monitor hook
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: 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 .
Screenshot
Gui
Demo Path: CSerialPort/examples/CommQT
Tui
Demo Path: CSerialPort/examples/CommTui
No Gui
Demo Path: CSerialPort/examples/CommNoGui
Documents
API Document Directory List Document Error Guide Document Frequently Asked Questions
Contacting
- Email : itas109@qq.com
- QQ Group : 129518033
Links
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
2. CommLite
CommLite is tui's serial port tool based CSerialPort
- support x86, arm, mips cpu architecture
- support windows dos, linux, macos,raspberrypi, freebsd operating system
https://github.com/itas109/CommLite
Donate
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
since V3.0.0.171216 use GNU Lesser General Public License v3.0