QingruiHuang/CSerialPort

基于C++的轻量级开源跨平台串口类库Lightweight cross-platform serial port library based on C++

CSerialPort

语言：English 英语 / 中文

一个使用C++实现的轻量级串口类库，可以轻松在windows和linux下进行串口读写

---

Design Principles 设计原则

• 跨平台
• 简单易用
• 高效

Todo List 待处理事项

Strategic Goal 战略目标

• 1.首先支持windows和linux平台
• 2.增加通用串口通信协议
• 3.支持热插拔
• 4.更高效的通知模块
• 5.支持其他语言，如C, C#, Python, Java, Golang等
• 6.同步串口通信
• 7.全新的跨平台串口调试助手
• 8.增加一个类库的介绍和使用视频

Short-term Goal 短期目标

• 1.跨平台操作系统识别库
• 2.跨平台多线程类库
• 3.跨平台锁类库
• 4.跨平台高效定时器类库
• 5.性能测试报告(吞吐量、时延、丢包率)

Last Modify 最新版本

Version: 4.0.2.200108

by itas109 on 2020-01-08

Quick Start 快速开始

Windows

• MSVC

批处理需要根据自己安装的MSVC编译器版本和位置修改 这里MSVC编译器版本为VS2013，安装位置为"D:\Program Files (x86)\Microsoft Visual Studio 12.0"

git clone https://github.com/itas109/CSerialPort.git

cd CSerialPort\Demo\CommNoGui

compile-MSVC.bat

CSerialPortDemoNoGui-MSVC.exe

• MinGW

git clone https://github.com/itas109/CSerialPort.git

cd CSerialPort\Demo\CommNoGui

compile-MinGW.bat

CSerialPortDemoNoGui-MinGW.exe

Linux

git clone https://github.com/itas109/CSerialPort.git
cd CSerialPort\Demo\CommNoGui

make
./CSerialPortDemoNoGui

or

git clone https://github.com/itas109/CSerialPort.git
cd CSerialPort\Demo\CommNoGui

chmod +x compile.sh
./compile.sh
./CSerialPortDemoNoGui

Tested Machine 测试机器

系统版本	CPU架构	Gui	编译器	测试时间
DeepIn 15.11 64bit CN	x86_64	QT 5.12.6	GCC 6.3.0	2020-03-21
NeoKylin Server 7.0 CN	x86_64	NoGui	GCC 4.8.5	2020-03-26
Win7 Ultimate 64bit CN	x86_64	QT 5.6.2	MSVC2013u5 32bit	2020-01-08
Win7 Ultimate 64bit CN	x86_64	QT 5.12.1	MSVC2017 64bit	2020-01-08
Win7 Ultimate 64bit CN	x86_64	QT 5.12.7	MinGW73 32bit	2020-03-11
Win7 Ultimate 64bit CN	x86_64	MFC	MSVC2013u5 32bit	2020-01-08
Win7 Ultimate 64bit CN	x86_64	MFC	MSVC2015u3 32bit	2020-01-08
Win7 Ultimate 64bit En	x86_64	MFC	MSVC2013u5 32bit	2019-03-07
Win10 Enterprise 64bit CN	x86_64	MFC	MSVC2015u3 32bit	2020-01-08
Win10 Enterprise 64bit CN	x86_64	QT 5.12.7	MinGW73 64bit	2020-03-12
Ubuntu 16.04 64bit En	x86_64	QT 5.6.2	GCC 5.4.0	2019-07-28
Linux raspberrypi 4.9.70	armv7l	NoGUi	GCC 4.9.2	2020-03-21

directory List 目录列表

update : 2019-08-10

|-- CSerialPort # root
    |-- .gitattributes
    |-- .gitignore
    |-- LICENSE # LGPL3.0 license
    |-- README.md 
    |-- VERSION # version 版本号
    |-- Demo # example 示例目录
    |   |-- Comm # CSerialPort MFC Demo use source code win32直接调用源码MFC程序示例
    |   |   |-- Comm
    |   |   |-- Release # CSerialPort Release Application 可以直接运行的Release程序
    |   |       |-- Comm.exe
    |   |-- CommDLL # CSerialPort MFC Demo use Win32 Dll win32动态库MFC程序示例
    |   |   |-- Comm
    |   |-- CommQT # CSerialPort QT win/linux Demo QT win/linux 程序示例
    |   |-- CommNoGui # CSerialPort No Gui win/linux Demo win/linux无界面程序示例
    |   |-- CSerialPortDemoWin32Console # CSerialPort Demo for Win32 Console win32控制台程序示例
    |       |-- CSerialPortDemoWin32Console
    |-- doc # document 文档目录
    |   |-- common_problems.md # common problems 问答文档
    |   |-- CSerialPort_doc_cn.chm # Chinese documnet 简体中文说明书
    |   |-- CSerialPort_doc_en.chm # English documnet 英文说明书
    |   |-- error_guide.md # error guide 错误指南文档
    |   |-- How To Use.txt
    |   |-- suspending.txt
    |-- lib # lib 库目录
    |   |-- Linux # windows lib windows库目录
    |       |-- compile.sh # sh compile 命令编译
    |       |-- Makefile # Makefile compile Makefile编译
    |   |-- Windows # windows lib windows库目录
    |       |-- VC12 # windows lib for vs2013 windows vs2013库目录
    |           |-- libcserialport
    |               |-- libcserialport
    |-- pic # picture 图片
    |-- src # source 源代码
        |-- osplatformutil.h # os platform define 操作系统定义
        |-- SerialPort.cpp
        |-- SerialPort.h # Lightweight library of serial port, which can easy to read and write serical port on windows and linux with C++ 轻量级跨平台串口读写类库
        |-- SerialPortBase.cpp
        |-- SerialPortBase.h # CSerialPort Base class 串口基类 
        |-- SerialPortInfo.cpp
        |-- SerialPortInfo.h # CSerialPortInfo class 串口信息辅助类 
        |-- SerialPortInfoBase.cpp
        |-- SerialPortInfoBase.h # CSerialPortInfo Base class 串口信息辅助类基类 
        |-- SerialPortInfoUnixBase.cpp
        |-- SerialPortInfoUnixBase.h # CSerialPortInfo unix class unix串口信息辅助类基类 
        |-- SerialPortInfoWinBase.cpp
        |-- SerialPortInfoWinBase.h # CSerialPortInfo windows class windows串口信息辅助类基类 
        |-- SerialPortUnixBase.cpp
        |-- SerialPortUnixBase.h # CSerialPort unix Base class unix串口基类 
        |-- SerialPortWinBase.cpp
        |-- SerialPortWinBase.h # CSerialPort Windows Base class windows串口基类 
        |-- SerialPort_global.h # Global difine of CSerialPort 串口全局定义 
        |-- sigslot.h # signal and slot 信号与槽

Error Guide 错误指南文档

错误指南文档

Frequently Asked Questions 常见问题回答

常见问题回答

Result 结果

linux：

Gui 界面

示例路径: CSerialPort/Demo/CommQT

No Gui 无界面

示例路径 1: CSerialPort/Demo/CommNoGui

示例2如下所示 :

• 示例代码

//sp.cpp

#include <iostream>
#include "SerialPort.h"

int main()
{
        itas109::CSerialPort sp;
        std::cout << "Version : " << sp.getVersion() << std::endl;
	sp.init("/dev/ttyS0");
	sp.open();
	std::cout << " open status : " << sp.isOpened() << std::endl;
	
	return 0;
}

• compile 编译

Linux源码编译
g++ sp.cpp SerialPort.cpp SerialPortBase.cpp SerialPortUnixBase.cpp -lpthread -o sp
./sp

Linux 动态库编译
g++ SerialPort.cpp SerialPortBase.cpp SerialPortUnixBase.cpp -fPIC -lpthread -shared -o libsp.so
g++ sp.cpp -o sp -L. -lsp
export LD_LIBRARY_PATH=./
./sp

windows:

Gui 界面

示例路径: CSerialPort/Demo/CommQT

![image][win_no_gui]

No Gui 无界面

示例路径 1: CSerialPort/Demo/CSerialPortDemoWin32Console

示例路径 2: CSerialPort/Demo/CommNoGui

Contacting 联系方式

• Email : itas109@qq.com

• QQ群 : 129518033

Links 链接

• CSDN博客
• Github
• Gitee码云

Donate 捐助

---

Other branches 其他分支

Remon Spekreijse的串口类库对于本类库有着深远的影响，十分感谢Remon Spekreijse http://www.codeguru.com/cpp/i-n/network/serialcommunications/article.php/c2483/A-communication-class-for-serial-port.htm

仅支持windows版本分支 : https://github.com/itas109/CSerialPort/tree/CSerialPort_win_3.0.3

---

License 开源协议

自 V3.0.0.171216 版本后采用GNU Lesser General Public License v3.0