Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/itas109/CSerialPort

CSerialPort - lightweight cross-platform serial port library for C/C++/C#/Java/Python/Node.js
https://github.com/itas109/CSerialPort

communication cpp cpp-serial cpp-serial-port cpp-serialport cross-platform cserialport linux linux-serialport mscomm rs232 serial serial-port serialport serialport-interface serialportassistant serialportsdk uart windows-serial

Last synced: about 2 months ago
JSON representation

CSerialPort - lightweight cross-platform serial port library for C/C++/C#/Java/Python/Node.js

Host: GitHub
URL: https://github.com/itas109/CSerialPort
Owner: itas109
License: other
Created: 2016-05-07T03:16:19.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-04-27T14:02:29.000Z (about 2 months ago)
Last Synced: 2024-04-27T15:22:35.070Z (about 2 months ago)
Topics: communication, cpp, cpp-serial, cpp-serial-port, cpp-serialport, cross-platform, cserialport, linux, linux-serialport, mscomm, rs232, serial, serial-port, serialport, serialport-interface, serialportassistant, serialportsdk, uart, windows-serial
Language: C++
Homepage: https://blog.csdn.net/itas109/article/details/84282860
Size: 8.62 MB
Stars: 645
Watchers: 39
Forks: 323
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-cpp - CSerialPort - lightweight cross-platform serial port library. [LGPL3] (Serial Port)
fucking-awesome-cpp - CSerialPort - lightweight cross-platform serial port library. [LGPL3] (Serial Port)

README

        # [CSerialPort](https://github.com/itas109/CSerialPort)

[中文](README_zh_CN.md)

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

















---

# 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](https://github.com/itas109/CSerialPortExtend)

- [x] 4.higher efficiency notify module - replace with CSerialPortListener

- [x] 5.support other language - C#, Java, Python, Node.js etc. - more information [bindings](https://github.com/itas109/CSerialPort/tree/master/bindings)

- [x] 6.sync serial port communication

- [x] 7.new cross-platform gui serial port tool - [CommMaster](https://gitee.com/itas109/CommMaster)

- [x] 8.add introduction and tutorial of CSerialPort - [CSerialPort Tutorial ](https://blog.csdn.net/itas109/category_11520540.html)

- [ ] 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](https://github.com/Microsoft/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

![image](pic/linux.jpg)

## Tui

Demo Path: CSerialPort/examples/CommTui

![image](pic/linux_tui.jpg)

## No Gui

Demo Path: CSerialPort/examples/CommNoGui

![image](pic/linux_no_gui.jpg)

# Documents

[API Document](doc/CSerialPort_doc_en.chm)

[Directory List Document](doc/directory_list.md)

[Error Guide Document](doc/error_guide.md)

[Frequently Asked Questions](doc/FAQ.md)

# Contacting

- Email : [email protected]

- QQ Group : [129518033](http://shang.qq.com/wpa/qunwpa?idkey=2888fa15c4513e6bfb9347052f36e437d919b2377161862948b2a49576679fc6)

# Links

- [CSDN Blog](https://blog.csdn.net/itas109)

- [Github](https://github.com/itas109/CSerialPort)

- [Gitee](https://gitee.com/itas109/CSerialPort)

# CSerialPort-based Applications

## 1. [CommMaster](https://gitee.com/itas109/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

![image](pic/CommMaster.png)

## 2. [CommLite](https://github.com/itas109/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

![image](pic/commlite.gif)

# Donate

[CSDN Blog](https://blog.csdn.net/itas109)

---

# Other branches

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

Thanks for [Remon Spekreijse's serial library](http://www.codeguru.com/cpp/i-n/network/serialcommunications/article.php/c2483/A-communication-class-for-serial-port.htm)

---

# License

since V3.0.0.171216 use [GNU Lesser General Public License v3.0](LICENSE)