【C++】Windows API 串口通讯通用类源码

01、串口通讯

在工业控制中，工控机（一般都基于Windows平台）经常需要与智能仪表通过串口进行通信。串口通信方便易行，应用广泛。

RS232通信协议是目前最常用的一种全双工点对点式的异步串行通信协议接口标准。RS232接口标准由于出现较早，所以其目前存在很多问题。

• 接口电平值较高，易损坏接口电路的芯片。
• 传输速率较低，大约为20Kbps；传输距离较短，大约为15米左右。
• 接口由三根线TX、RX、GND组成，没有构成差分线形式，容易产生共地共模干扰，抗干扰能力弱。

RS232协议层：主要包括起始位、数据位、校验位、停止位四部分组成，而且通信双方必须以约定的通信协议和通信速率进行通信。数据位采用小端传输模式，即低位在前，高位在后。

一般情况下，工控机和各智能仪表通过RS485总线进行通信。RS485的通信方式是半双工的，只能由作为主节点的工控PC机依次轮询网络上的各智能控制单元子节点。每次通信都是由PC机通过串口向智能控制单元发布命令，智能控制单元在接收到正确的命令后作出应答。

在Win32下，可以使用两种编程方式实现串口通信，其一是使用ActiveX控件，这种方法程序简单，但欠灵活。其二是调用Windows的API函数，这种方法可以清楚地掌握串口通信的机制，并且自由灵活。本文我们只介绍API串口通信部分。

串口的操作可以有两种操作方式：同步操作方式和重叠操作方式（又称为异步操作方式）。

同步操作时，API函数会阻塞直到操作完成以后才能返回（在多线程方式中，虽然不会阻塞主线程，但是仍然会阻塞监听线程）；而重叠操作方式，API函数会立即返回，操作在后台进行，避免线程的阻塞。

无论那种操作方式，一般都通过四个步骤来完成：

1：打开串口
2：配置串口
3：读写串口
4：关闭串口

02、 CreateFile API

Win32系统把文件的概念进行了扩展。无论是文件、通信设备、命名管道、邮件槽、磁盘、还是控制台，都是用API函数CreateFile来打开或创建的。该函数的原型为：

扫描二维码关注公众号，回复： 15433552 查看本文章

HANDLE  CreateFile (LPCTSTR lpFileName,
					DWORD dwDesiredAccess,
					DWORD dwShareMode,
					LPSECURITY _ATTRIBUTES lpSecurityAttributes,
					DWORD dwCreationDistribution,
					DWORD dwFlagsAndAttributes, 
					HANDLE hTemplateFile);

参数说明：

1. lpFileName：将要打开的串口逻辑名，如"COM1"（程序中对参数会做更加详细的说明）
2. dwDesiredAccess：指定串口访问的类型，可以是读取、写入或二者并列；
3. dwShareMode：指定共享属性，由于串口不能共享，该参数必须置为0；
4. lpSecurityAttributes：引用安全性属性结构，缺省值为NULL；
5. dwCreationDistribution：创建标志，对串口操作该参数必须置为OPEN_EXISTING；
6. dwFlagsAndAttributes：属性描述，用于指定该串口是否进行异步操作，该值为FILE_FLAG_OVERLAPPED，表示使用异步的I/O；该值为0，表示同步I/O操作；
7. hTemplateFile：对串口而言该参数必须置为NULL。

关键API即上面的CreateFile，现在我们开始贴上整体代码

03、串口通讯Demo

/* 
*	startdata: 2021/08/02
*	CurrentFile: SerialComm.h
*	Creaters: Cain Xcy
*	function: 封装串口通讯的四个步骤，简单实现信息交互
*/

#ifndef _WZSERIALPORT_H
#define _WZSERIALPORT_H
#include <stdafx.h>
#include <string>

Class SerialDemo
{
    
    
public:
	SerialDemo();
	~SerialDemo();

	/*
	portname(串口名): 在Windows下是"COM1""COM2"等，在Linux下是"/dev/ttyS1"等
	baudrate(波特率): 9600、19200、38400、43000、56000、57600、115200 
	parity(校验位): 0为无校验，1为奇校验，2为偶校验，3为标记校验
	databit(数据位): 4-8，通常为8位
	stopbit(停止位): 1为1位停止位，2为2位停止位,3为1.5位停止位
	synchronizable(同步、异步): 0为异步，1为同步
	*/
	BOOL OpenDevice(const char* portname, int baudrate = 115200, char parity = 0, char databit = 8, char stopbit = 1, char synchronizeflag = 1);  //打开串口设备(已经有默认初始化参数)

	//关闭串口，参数待定
	void CloseDevice();

	//发送数据或写数据，成功返回发送数据长度，失败返回0
	int SendInfo(CString data);

	//接受数据或读数据，成功返回读取实际数据的长度，失败返回0
	CString receive();
	
private:
	int pHandle[16];  //句柄数组
	char synchronizeflag;  //同异步标识
};

#endif

/*
*	startdata: 2021/08/02
*	CurrentFile: SerialComm.cpp
*	Creaters: Cain Xcy
*	function: 封装串口通讯的四个实现，通用类，直接调用即可
*/
#include <stdafx.h>
#include <WinSock2.h>
#include <windows.h>
#include <SerialComm.h>

SerialDemo()
{
    
    
	//无响应
}

~SerialDemo()
{
    
    
	//无响应
}

BOOL SerialDemo::OpenDevice(const char* portname, 
				int baudrate,
				char parity,
				char databit,
				char stopbit,
				char synchronizeflag)
{
    
    
	this->synchronizeflag = synchronizeflag;
	HANDLE hCom = NULL;
	if (this->synchronizeflag)
	{
    
    
		//同步方式
		hCom = CreateFileA(portname, //串口名
			GENERIC_READ | GENERIC_WRITE, //支持读写
			0, //独占方式，串口不支持共享
			NULL,//安全属性指针，默认值为NULL
			OPEN_EXISTING, //打开现有的串口文件
			0, //0：同步方式，FILE_FLAG_OVERLAPPED：异步方式
			NULL);//用于复制文件句柄，默认值为NULL，对串口而言该参数必须置为NULL
	}
	else
	{
    
    
		//异步方式
		hCom = CreateFileA(portname, //串口名
			GENERIC_READ | GENERIC_WRITE, //支持读写
			0, //独占方式，串口不支持共享
			NULL,//安全属性指针，默认值为NULL
			OPEN_EXISTING, //打开现有的串口文件
			FILE_FLAG_OVERLAPPED, //0：同步方式，FILE_FLAG_OVERLAPPED：异步方式
			NULL);//用于复制文件句柄，默认值为NULL，对串口而言该参数必须置为NULL
	}

	if (hCom == (HANDLE)-1)
	{
    
    
		return FALSE;
	}

	//配置缓冲区大小 
	if (!SetupComm(hCom, 1024, 1024))
	{
    
    
		return FALSE;
	}

	// 配置参数 
	DCB p;
	memset(&p, 0, sizeof(p));
	p.DCBlength = sizeof(p);
	p.BaudRate = baudrate; // 波特率
	p.ByteSize = databit; // 数据位

	switch (parity) //校验位
	{
    
    
	case 0:
		p.Parity = NOPARITY; //无校验
		break;
	case 1:
		p.Parity = ODDPARITY; //奇校验
		break;
	case 2:
		p.Parity = EVENPARITY; //偶校验
		break;
	case 3:
		p.Parity = MARKPARITY; //标记校验
		break;
	}

	switch (stopbit) //停止位
	{
    
    
	case 1:
		p.StopBits = ONESTOPBIT; //1位停止位
		break;
	case 2:
		p.StopBits = TWOSTOPBITS; //2位停止位
		break;
	case 3:
		p.StopBits = ONE5STOPBITS; //1.5位停止位
		break;
	}

	if (!SetCommState(hCom, &p))
	{
    
    
		// 设置参数失败
		return FALSE;
	}

	//超时处理,单位：毫秒
	//总超时＝时间系数×读或写的字符数＋时间常量
	COMMTIMEOUTS TimeOuts;
	TimeOuts.ReadIntervalTimeout = 1000; //读间隔超时
	TimeOuts.ReadTotalTimeoutMultiplier = 500; //读时间系数
	TimeOuts.ReadTotalTimeoutConstant = 5000; //读时间常量
	TimeOuts.WriteTotalTimeoutMultiplier = 500; // 写时间系数
	TimeOuts.WriteTotalTimeoutConstant = 2000; //写时间常量
	SetCommTimeouts(hCom, &TimeOuts);

	PurgeComm(hCom, PURGE_TXCLEAR | PURGE_RXCLEAR);//清空串口缓冲区

	memcpy(pHandle, &hCom, sizeof(hCom));// 保存句柄

	return TRUE;
}

void SerialDemo::CloseDevice()
{
    
    
	HANDLE hCom = *(HANDLE*)pHandle;
	CloseHandle(hCom);
}

int SerialDemo::SendInfo(CString data)
{
    
    
	//CString To string
	std::string buf = data.GetBuffer(data.GetLength());
	
	//获取句柄
	HANDLE hCom = *(HANDLE*)pHandle;
	if (this->synchronizeflag)
	{
    
    
		// 同步方式
		DWORD dwBytesWrite = buf.length(); //成功写入的数据字节数
		BOOL bWriteStat = WriteFile(hCom, //串口句柄
			(char*)buf.c_str(), //数据首地址
			dwBytesWrite, //要发送的数据字节数
			&dwBytesWrite, //DWORD*，用来接收返回成功发送的数据字节数
			NULL); //NULL为同步发送，OVERLAPPED*为异步发送
		if (!bWriteStat)
		{
    
    
			return 0;
		}
		return dwBytesWrite;
	}
	else
	{
    
    
		//异步方式
		DWORD dwBytesWrite = buf.length(); //成功写入的数据字节数
		DWORD dwErrorFlags; //错误标志
		COMSTAT comStat; //通讯状态
		OVERLAPPED m_osWrite; //异步输入输出结构体

		//创建一个用于OVERLAPPED的事件处理，不会真正用到，但系统要求这么做
		memset(&m_osWrite, 0, sizeof(m_osWrite));
		m_osWrite.hEvent = CreateEvent(NULL, TRUE, FALSE, L"WriteEvent");

		ClearCommError(hCom, &dwErrorFlags, &comStat); //清除通讯错误，获得设备当前状态
		BOOL bWriteStat = WriteFile(hCom, //串口句柄
			(char*)buf.c_str(), //数据首地址
			dwBytesWrite, //要发送的数据字节数
			&dwBytesWrite, //DWORD*，用来接收返回成功发送的数据字节数
			&m_osWrite); //NULL为同步发送，OVERLAPPED*为异步发送
		if (!bWriteStat)
		{
    
    
			if (GetLastError() == ERROR_IO_PENDING) //如果串口正在写入
			{
    
    
				WaitForSingleObject(m_osWrite.hEvent, 1000); //等待写入事件1秒钟
			}
			else
			{
    
    
				ClearCommError(hCom, &dwErrorFlags, &comStat); //清除通讯错误
				CloseHandle(m_osWrite.hEvent); //关闭并释放hEvent内存
				return 0;
			}
		}
		return dwBytesWrite;
	}
}

CString SerialDemo::receive()
{
    
    
	HANDLE hCom = *(HANDLE*)pHandle;
	string rec_str = "";
	CString strRet;
	char buf[256];
	if (this->synchronizeflag)
	{
    
    
		//同步方式
		DWORD wCount=256; //成功读取的数据字节数
		BOOL bReadStat = ReadFile(hCom, //串口句柄
			buf, //数据首地址
			wCount, //要读取的数据最大字节数
			&wCount, //DWORD*,用来接收返回成功读取的数据字节数
			NULL); //NULL为同步发送，OVERLAPPED*为异步发送

		for (int i = 0; i < strlen(buf); i++)
		{
    
    
			rec_str += buf[i];			
		}
		
		strRet.Format(_T("%s"),rec_str);
		
		return strRet;
	}
	else
	{
    
    
		//异步方式
		DWORD wCount = 1024; //成功读取的数据字节数
		DWORD dwErrorFlags; //错误标志
		COMSTAT comStat; //通讯状态
		OVERLAPPED m_osRead; //异步输入输出结构体

		//创建一个用于OVERLAPPED的事件处理，不会真正用到，但系统要求这么做
		memset(&m_osRead, 0, sizeof(m_osRead));
		m_osRead.hEvent = CreateEvent(NULL, TRUE, FALSE, L"ReadEvent");

		ClearCommError(hCom, &dwErrorFlags, &comStat); //清除通讯错误，获得设备当前状态
		if (!comStat.cbInQue)
		return ""; //如果输入缓冲区字节数为0，则返回false
		//std::cout << comStat.cbInQue << std::endl;
		BOOL bReadStat = ReadFile(hCom, //串口句柄
			buf, //数据首地址
			wCount, //要读取的数据最大字节数
			&wCount, //DWORD*,用来接收返回成功读取的数据字节数
			&m_osRead); //NULL为同步发送，OVERLAPPED*为异步发送
		if (!bReadStat)
		{
    
    
			if (GetLastError() == ERROR_IO_PENDING) //如果串口正在读取中
			{
    
    
				//GetOverlappedResult函数的最后一个参数设为TRUE
				//函数会一直等待，直到读操作完成或由于错误而返回
				GetOverlappedResult(hCom, &m_osRead, &wCount, TRUE);
			}
			else
			{
    
    
				ClearCommError(hCom, &dwErrorFlags, &comStat); //清除通讯错误
				CloseHandle(m_osRead.hEvent); //关闭并释放hEvent的内存
				return "";
			}
		}
		for (int i = 0; i < strlen(buf); i++)
		{
    
    
			rec_str += buf[i];
		}
		strRet.Format(_T("%s"),rec_str);
		
		return strRet;
	}
}

到此，MFC 通过Windows API连接串口类就封装完成了，此类灵活，可以根据自己的参数改变，或者通过界面的方式开放参数接口出来，随改随调。
调用这里我就不写了，大家可以试试。