串口通信常用API

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

串口通信常用API1-CreateFile()用途:打开串口原型:HANDLECreateFile(LPCTSTRlpFileName,DWORDdwDesiredAccess,DWORDdwShareMode,LPSECURITY_ATTRIBUTESlpSecurityAttributes,DWORDdwCreationDistribution,DWORDdwFlagsAndAttributes,HANDLEhTemplateFile);参数说明:-lpFileName:要打开的文件名称。对串口通信来说就是COM1或COM2。-dwDesiredAccess:读写模式设置。此处应该用GENERIC_READ及GENERIC_WRITE。-dwShareMode:串口共享模式。此处不允许其他应用程序共享,应为0。-lpSecurityAttributes:串口的安全属性,应为0,表示该串口不可被子程序继承。-dwCreationDistribution:创建文件的性质,此处为OPEN_EXISTING.-dwFlagsAndAttributes:属性及相关标志,这里使用异步方式应该用FILE_FLAG_OVERLAPPED。-hTemplateFile:此处为0。操作说明:若文件打开成功,串口即可使用了,该函数返回串口的句柄,以后对串口操作时即可使用该句柄。举例:HANDLEhComm;hComm=CreateFile(COM1,//串口号GENERIC_READ|GENERIC_WRITE,//允许读写0,//通讯设备必须以独占方式打开NULL,//无安全属性OPEN_EXISTING,//通讯设备已存在FILE_FLAG_OVERLAPPED,//异步I/O0);//通讯设备不能用模板打开hComm即为函数返回的串口1的句柄。2-CloseHandle()用途:关闭串口原型:BOOLCloseHandle(HANDLEhObjedt)参数说明:-hObjedt:串口句柄操作说明:成功关闭串口时返回true,否则返回false举例:CloseHandle(hComm);3-GetCommState()用途:取得串口当前状态原型:BOOLGetCommState(HANDLEhFile,LPDCBlpDCB);参数说明:-hFile:串口句柄-lpDCB:设备控制块(DeviceControlBlock)结构地址。此结构中含有和设备相关的参数。此处是与串口相关的参数。由于参数非常多,当需要设置串口参数时,通常是先取得串口的参数结构,修改部分参数后再将参数结构写入。在此仅介绍少数的几个常用的参数:DWORDBaudRate:串口波特率DWORDfParity:为1的话激活奇偶校验检查DWORDParity:校验方式,值0~4分别对应无校验、奇校验、偶校验、校验置位、校验清零DWORDByteSize:一个字节的数据位个数,范围是5~8DWORDStopBits:停止位个数,0~2分别对应1位、1.5位、2位停止位操作举例:DCBComDCB;//串口设备控制块GetCommState(hComm,&ComDCB);4-SetCommState()用途:设置串口状态,包括常用的更改串口号、波特率、奇偶校验方式、数据位数等原型:BOOLSetCommState(HANDLEhFile,LPDCBlpDCB);参数说明:-hFile:串口句柄-lpDCB:设备控制块(DeviceControlBlock)结构地址。要更改的串口参数包含在此结构中。操作举例:DCBComDCB;GetCommState(hComm,&ComDCB);//取得当前串口状态ComDCB.BaudRate=9600;//更改为9600bps,该值即为你要修改后的波特率SetCommState(hComm,&ComDCB;//将更改后的参数写入串口5-WriteFile()用途:向串口写数据原型:BOOLWriteFile(HANDLEhFile,LPCVOIDlpBuffer,DWORDnNumberOfBytesToWrite,LPDWORDlpNumberOfBytesWritten,LPOVERLAPPEDlpOverlapped);参数说明:-hFile:串口句柄-lpBuffer:待写入数据的首地址-nNumberOfBytesToWrite:待写入数据的字节数长度-lpNumberOfBytesWritten:函数返回的实际写入串口的数据个数的地址,利用此变量可判断实际写入的字节数和准备写入的字节数是否相同。-lpOverlapped:重叠I/O结构的指针操作举例:DWORDBytesSent=0;unsignedcharSendBytes[5]={1,2,3,4,5};OVERLAPPEDov_Write;ov_Write.Offset=0;ov_Write.OffsetHigh=0;WriteFile(hComm,//调用成功返回非零,失败返回零SendBytes,//输出缓冲区5,//准备发送的字符长度&BytesSent,//实际发出的字符数&ov_Write);//重叠结构如果函数执行成功的话检查BytesSent的值应该为5,此函数是WriteFile函数执行完毕后自行填充的,利用此变量的填充值可以用来检查该函数是否将所有的数据成功写入串口6-ReadFile()用途:读串口数据原型:BOOLReadFile(HANDLEhFile,LPVOIDlpBuffer,DWORDnNumberOfBytesToRead,lpNumberOfBytesRead,lpOverlapped);参数说明:-hFile:串口句柄-lpBuffer:存储被读出数据的首地址-nNumberOfBytesToRead:准备读出的字节个数-NumberOfBytesRead:实际读出的字节个数-lpOverlapped:异步I/O结构,操作举例:unsignedcharucRxBuff[20];COMSTATComStat;DWORDdwError=0;DWORDBytesRead=0;OVERLAPPEDov_Read;ov_Read.hEvent=CreateEvent(NULL,true,false,NULL);//必须创建有效事件ClearCommError(hComm,&dwError,&ComStat);//检查串口接收缓冲区中的数据个数bResult=ReadFile(hComm,//串口句柄ucRxBuff,//输入缓冲区地址ComStat.cbInQue,//想读入的字符数&BytesRead,//实际读出的字节数的变量指针&ov_Read);//重叠结构指针假如当前串口中有5个字节数据的话,那么执行完ClearCommError()函数后,ComStat结构中的ComStat.cbInQue将被填充为5,此值在ReadFile函数中可被直接利用。7-ClearCommError()用途:清除串口错误或者读取串口现在的状态原型:BOOLClearCommError(HANDLEhFile,LPDWORDlpErrors,LPCOMATATlpStat);参数说明:-hFile:串口句柄-lpErrors:返回错误数值,错误常数如下:1-CE_BREAK:检测到中断信号。意思是说检测到某个字节数据缺少合法的停止位。2-CE_FRAME:硬件检测到帧错误。3-CE_IOE:通信设备发生输入/输出错误。4-CE_MODE:设置模式错误,或是hFile值错误。5-CE_OVERRUN:溢出错误,缓冲区容量不足,数据将丢失。6-CE_RXOVER:溢出错误。7-CE_RXPARITY:硬件检查到校验位错误。8-CE_TXFULL:发送缓冲区已满。-lpStat:指向通信端口状态的结构变量,原型如下:typedefstruct_COMSTAT{......DWORDcbInQue;//输入缓冲区中的字节数DWORDcbOutQue;//输出缓冲区中的字节数}COMSTAT,*LPCOMSTAT;该结构中对我们很重要的只有上面两个参数,其他的我们可以不用管。操作举例:COMSTATComStat;DWORDdwError=0;ClearCommError(hComm,&dwError,&ComStat);上式执行完后,ComStat.cbInQue就是串口中当前含有的数据字节个数,我们利用此数值就可以用ReadFile()函数去读串口中的数据了。8-PurgeComm()用途:清除串口缓冲区原型:BOOLPurgeComm(HANDLEhFile,DWORDdwFlags);参数说明:-hFile:串口句柄-dwFlags:指定串口执行的动作,由以下参数组成:-PURGE_TXABORT:停止目前所有的传输工作立即返回不管是否完成传输动作。-PURGE_RXABORT:停止目前所有的读取工作立即返回不管是否完成读取动作。-PURGE_TXCLEAR:清除发送缓冲区的所有数据。-PURGE_RXCLEAR:清除接收缓冲区的所有数据。操作举例:PurgeComm(hComm,PURGE_RXCLEAR|PURGE_TXCLEAR|PURGE_RXABORT|PURGE_TXABORT);清除串口的所有操作。9-SetCommMask()用途:设置串口通信事件。原型:BOOLSetCommMask(HANDLEhFile,DWORDdwEvtMask);参数说明:-hFile:串口句柄-dwEvtMask:准备监视的串口事件掩码注:在用api函数撰写串口通信函数时大体上有两种方法,一种是查寻法,另外一种是事件通知法。这两种方法的区别在于收串口数据时,前一种方法是主动的周期性的查询串口中当前有没有数据;后一种方法是事先设置好需要监视的串口通信事件,然后依靠单独开设的辅助线程进行监视该事件是否已发生,如果没有发生的话该线程就一直不停的等待直到该事件发生后,将该串口事件以消息的方式通知主窗体,然后主窗体收到该消息后依据不同的事件性质进行处理。比如说当主窗体收到监视线程发来的RX_CHAR(串口中有数据)的消息后,就可以用ReadFile()函数去读串口。该参数有如下信息掩码位值:EV_BREAK:收到BREAK信号EV_CTS:CTS(cleartosend)线路发生变化EV_DSR:DST(DataSetReady)线路发生变化EV_ERR:线路状态错误,包括了CE_FRAME/CE_OVERRUN/CE_RXPARITY3钟错误。EV_RING:检测到振铃信号。EV_RLSD:CD(CarrierDetect)线路信号发生变化。EV_RXCHAR:输入缓冲区中已收到数据。EV_RXFLAG:使用SetCommState()函数设置的DCB结构中的等待字符已被传入输入缓冲区中。EV_TXEMPTY:输出缓冲区中的数据已被完全送出。操作举例:SetCommMask(hComm,EV_RXCHAR|EV_TXEMPTY);上面函数执行完毕后将监视串口中有无数据和发送缓冲区中的数据是否全部发送完毕。10-WaitCommEvent()用途:用来判断用SetCommMask()函数设置的串口通信事件是否已发生。原型:BOOLWaitCommEvent(HANDLEhFile,LPDWORDlpEvtMask,LPOVERLAPPEDlpOverlapped);参数说明:-hFile:串口句柄-lpEvtMask:函数执行完后如果检测到串口通信事件的话就将其写入该参数中。-lpOverlapped:异步结构,用来保存异步操作结果。操作举例:OVERLAPPEDos;DWORDdwMask,dwTrans,dwError=0,err;memset(&os,0,sizeof(OVERLAPPED));os.hEvent=CreateEvent(NULL,TRU

1 / 15
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功