Skip to content

Latest commit

 

History

History
226 lines (165 loc) · 7.47 KB

README-CN.md

File metadata and controls

226 lines (165 loc) · 7.47 KB
Raw

CSerialPort

Version Stars Forks License GitHub last commit

语言：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.跨平台高效定时器类库

Last Modify 最新版本

Version: 4.0.1.190728 beta

by itas109 on 2019-07-28

Tested Machine 测试机器

  • VS2013 update 5 - Win7 Ultimate 64bit CN - 2019-07-28
  • VS2015 update 3 - Win7 Ultimate 64bit CN - 2019-02-27
  • VS2015 update 3 - Win10 Enterprise 64bit CN - 2019-02-28
  • GCC 5.4.0 20160609 - Ubuntu 16.04 64bit En - 2019-07-28
  • VS2013 update 5 - Win7 Ultimate 64bit En - 2019-03-07

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

image

No Gui 无界面

示例路径 1: CSerialPort/Demo/CommNoGui

image

示例2如下所示 :

image

  • 示例代码
//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

No Gui 无界面

示例路径 1: CSerialPort/Demo/CSerialPortDemoWin32Console

示例路径 2: CSerialPort/Demo/CommNoGui

image

Contacting 联系方式

Links 链接

Donate 捐助

如果您觉得本项目对您有帮助，可以捐助本项目，谢谢！

image

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