CSerialPort串口类的修正版2014-01-10

CSerialPort串口类的修正版2014-01-10

2018-05-17 15:19:53
最新进展：

CSerialPort串口类最新修正版2017-12-16

http://blog.csdn.net/itas109/article/details/78823082

这是一份优秀的类文件，好多的地方值得我们学习，具体在多线程，事件，自定义消息，类的封装方面等等。
Remon提供的串口类网址为： http://codeguru.earthweb.com/network/serialport.shtml，

其他贡献者：http://blog.csdn.net/liquanhai/article/details/6941574

代码下载：http://download.csdn.net/detail/itas109/6855323

代码托管：https://code.csdn.net/itas109/cserialport

源代码如下：

CSerialPort.h
[cpp] view plain copy
1. /*
2. ** FILENAME CSerialPort.h
3. **
4. ** PURPOSE This class can read, write and watch one serial port.
5. ** It sends messages to its owner when something happends on the port
6. ** The class creates a thread for reading and writing so the main
7. ** program is not blocked.
8. **
9. ** CREATION DATE 15-09-1997
10. ** LAST MODIFICATION 12-11-1997
11. **
12. ** AUTHOR Remon Spekreijse
13. **
14. **
15. ************************************************************************************
16. ** author: mrlong date:2007-12-25
17. **
18. ** 改进
19. ** 1) 增加ClosePort
20. ** 2) 增加 writetoProt() 两个方法
21. ** 3) 增加 SendData 与 RecvData 方法
22. **
23. ************************************************************************************
24. ** author：liquanhai date:2011-11-04
25. ** 改进
26. ** 1）增加 ClosePort中交出控制权，防止死锁问题
27. ** 2) 增加 ReceiveChar中防止线程死锁
28. ***************************************************************************************
29. ** author: itas109 date:2014-01-10
30. ** Blog：blog.csdn.net/itas109
31. **
32. ** 改进
33. ** 1) 解决COM10以上端口无法显示的问题
34. ** 2) 扩展可选择端口，最大值MaxSerialPortNum可以自定义
35. ** 3) 添加QueryKey()和Hkey2ComboBox两个方法，用于自动查询当前有效的串口号。
36. **
37. */
39. #ifndef __SERIALPORT_H__
40. #define __SERIALPORT_H__
42. #define WM_COMM_BREAK_DETECTED WM_USER+1 // A break was detected on input.
43. #define WM_COMM_CTS_DETECTED WM_USER+2 // The CTS (clear-to-send) signal changed state.
44. #define WM_COMM_DSR_DETECTED WM_USER+3 // The DSR (data-set-ready) signal changed state.
45. #define WM_COMM_ERR_DETECTED WM_USER+4 // A line-status error occurred. Line-status errors are CE_FRAME, CE_OVERRUN, and CE_RXPARITY.
46. #define WM_COMM_RING_DETECTED WM_USER+5 // A ring indicator was detected.
47. #define WM_COMM_RLSD_DETECTED WM_USER+6 // The RLSD (receive-line-signal-detect) signal changed state.
48. #define WM_COMM_RXCHAR WM_USER+7 // A character was received and placed in the input buffer.
49. #define WM_COMM_RXFLAG_DETECTED WM_USER+8 // The event character was received and placed in the input buffer.
50. #define WM_COMM_TXEMPTY_DETECTED WM_USER+9 // The last character in the output buffer was sent.
52. #define MaxSerialPortNum 20 ///有效的串口总个数，不是串口的号 //add by itas109 2014-01-09
53. class CSerialPort
54. {
55. public:
57. // contruction and destruction
58. CSerialPort();
59. virtual ~CSerialPort();
61. // port initialisation
62. ///串口初始化
63. BOOL InitPort(CWnd* pPortOwner, //串口句柄
64. UINT portnr = 1, //端口号
65. UINT baud = 19200, //波特率
66. char parity = 'N', //奇偶校验
67. UINT databits = 8, //数据位
68. UINT stopbits = 1, //停止位
69. DWORD dwCommEvents = EV_RXCHAR, //消息类型
70. UINT writebuffersize = 1024//写缓存
71. );
74. // start/stop comm watching
75. ///控制串口监视线程
76. BOOL StartMonitoring();//开始监听
77. BOOL RestartMonitoring();//重新监听
78. BOOL StopMonitoring();//停止监听
80. DWORD GetWriteBufferSize();///获取写缓冲大小
81. DWORD GetCommEvents();///获取事件
82. DCB GetDCB();///获取DCB
84. COMMTIMEOUTS GetCommTimeOuts();//
85. BOOL SetCommTimeOuts(COMMTIMEOUTS * lpTimeOuts);
87. ///写数据到串口
88. void WriteToPort(char* string);
89. void WriteToPort(char* string,int n);//add by mrlong 2007-12-25
90. void WriteToPort(LPCTSTR string);//add by mrlong 2007-12-25
91. void WriteToPort(LPCTSTR string,int n);//add by mrlong 2007-12-2
92. void WriteToPort(BYTE* Buffer, int n);// add by mrlong
93. void ClosePort();//关闭串口 // add by mrlong 2007-12-25
95. BOOL RecvData(LPTSTR lpszData, const int nSize);//串口发送函数 by mrlong 2008-2-15
96. void SendData(LPCTSTR lpszData, const int nLength);//串口接收函数 by mrlong 2008-2-15
98. void QueryKey(HKEY hKey);///查询注册表的串口号，将值存于数组中
99. void Hkey2ComboBox(CComboBox& m_PortNO);///将QueryKey查询到的串口号添加到CComboBox控件中
101. protected:
102. // protected memberfunctions
103. void ProcessErrorMessage(char* ErrorText);///错误处理
104. static UINT CommThread(LPVOID pParam);///线程函数
105. static void ReceiveChar(CSerialPort* port, COMSTAT comstat);///接收字符
106. static void WriteChar(CSerialPort* port);///写字符
109. // thread
110. CWinThread* m_Thread;///thread监视线程
111. BOOL m_bIsSuspened;///thread监视线程是否挂起
113. // synchronisation objects
114. CRITICAL_SECTION m_csCommunicationSync;///临界资源
115. BOOL m_bThreadAlive;///监视线程运行标志
117. // handles
118. HANDLE m_hWriteEvent;
119. HANDLE m_hComm;///串口句柄
120. HANDLE m_hShutdownEvent;
122. // Event array.
123. // One element is used for each event. There are two event handles for each port.
124. // A Write event and a receive character event which is located in the overlapped structure (m_ov.hEvent).
125. // There is a general shutdown when the port is closed.
126. ///事件数组，包括一个写事件，接收事件，关闭事件
127. ///一个元素用于一个事件。有两个事件线程处理端口。
128. ///写事件和接收字符事件位于overlapped结构体（m_ov.hEvent）中
129. ///当端口关闭时，有一个通用的关闭。
130. HANDLE m_hEventArray[3];
132. // structures
133. OVERLAPPED m_ov;///异步I/O
134. COMMTIMEOUTS m_CommTimeouts;///超时设置
135. DCB m_dcb;///设备控制块
137. // owner window
138. CWnd* m_pOwner;
140. // misc
141. UINT m_nPortNr;
142. char* m_szWriteBuffer;///写缓冲区
143. DWORD m_dwCommEvents;
144. DWORD m_nWriteBufferSize;///写缓冲大小
146. int m_nWriteSize; //写入字节数 //add by mrlong 2007-12-25
147. };
149. #endif __SERIALPORT_H__
CSerialPort.cpp
[cpp] view plain copy
1. /*
2. ** FILENAME CSerialPort.cpp
3. **
4. ** PURPOSE This class can read, write and watch one serial port.
5. ** It sends messages to its owner when something happends on the port
6. ** The class creates a thread for reading and writing so the main
7. ** program is not blocked.
8. **
9. ** CREATION DATE 15-09-1997
10. ** LAST MODIFICATION 12-11-1997
11. **
12. ** AUTHOR Remon Spekreijse
13. **
14. **
15. */
17. #include "stdafx.h"
18. #include "SerialPort.h"
20. #include <assert.h>
22. int m_nComArray[20];
23. //
24. // Constructor
25. //
26. CSerialPort::CSerialPort()///构造函数
27. {
28. m_hComm = NULL;
29. // initialize overlapped structure members to zero
30. ///初始化异步结构体
31. m_ov.Offset = 0;
32. m_ov.OffsetHigh = 0;
34. // create events
35. m_ov.hEvent = NULL;
36. m_hWriteEvent = NULL;
37. m_hShutdownEvent = NULL;
39. m_szWriteBuffer = NULL;
41. m_bThreadAlive = FALSE;
43. m_nWriteSize=1;///
44. m_bIsSuspened = FALSE;///
45. }
47. //
48. // Delete dynamic memory
49. //
50. CSerialPort::~CSerialPort()///析构函数
51. {
52. do
53. {
54. SetEvent(m_hShutdownEvent);
55. } while (m_bThreadAlive);
58. // if the port is still opened: close it
59. if (m_hComm != NULL)
60. {
61. CloseHandle(m_hComm);
62. m_hComm = NULL;
63. }
64. // Close Handles
65. if(m_hShutdownEvent!=NULL)
66. CloseHandle( m_hShutdownEvent);
67. if(m_ov.hEvent!=NULL)
68. CloseHandle( m_ov.hEvent );
69. if(m_hWriteEvent!=NULL)
70. CloseHandle( m_hWriteEvent );
72. TRACE("Thread endedn");
73. delete [] m_szWriteBuffer;
74. }
76. //
77. // Initialize the port. This can be port 1 to MaxSerialPortNum.
78. ///初始化串口。只能是1-MaxSerialPortNum
79. //
80. BOOL CSerialPort::InitPort(CWnd* pPortOwner, // the owner (CWnd) of the port (receives message)
81. UINT portnr, // portnumber (1..MaxSerialPortNum)
82. UINT baud, // baudrate
83. char parity, // parity
84. UINT databits, // databits
85. UINT stopbits, // stopbits
86. DWORD dwCommEvents, // EV_RXCHAR, EV_CTS etc
87. UINT writebuffersize) // size to the writebuffer
88. {
89. assert(portnr > 0 && portnr < MaxSerialPortNum+1);///add by itas109 2014-01-09
90. assert(pPortOwner != NULL);
92. // if the thread is alive: Kill
93. ///如果线程存在，则关掉进程
94. if (m_bThreadAlive)
95. {
96. do
97. {
98. SetEvent(m_hShutdownEvent);
99. } while (m_bThreadAlive);
100. TRACE("Thread endedn");
101. }
103. // create events
104. if (m_ov.hEvent != NULL)
105. ResetEvent(m_ov.hEvent);
106. else
107. m_ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
109. if (m_hWriteEvent != NULL)
110. ResetEvent(m_hWriteEvent);
111. else
112. m_hWriteEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
114. if (m_hShutdownEvent != NULL)
115. ResetEvent(m_hShutdownEvent);
116. else
117. m_hShutdownEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
119. // initialize the event objects
120. ///事件数组初始化，设定优先级别
121. m_hEventArray[0] = m_hShutdownEvent; // highest priority
122. m_hEventArray[1] = m_ov.hEvent;
123. m_hEventArray[2] = m_hWriteEvent;
125. // initialize critical section
126. ///初始化临界资源
127. InitializeCriticalSection(&m_csCommunicationSync);
129. // set buffersize for writing and save the owner
130. m_pOwner = pPortOwner;
132. if (m_szWriteBuffer != NULL)
133. delete [] m_szWriteBuffer;
134. m_szWriteBuffer = new char[writebuffersize];
136. m_nPortNr = portnr;
138. m_nWriteBufferSize = writebuffersize;
139. m_dwCommEvents = dwCommEvents;
141. BOOL bResult = FALSE;
142. char *szPort = new char[50];
143. char *szBaud = new char[50];
146. /*
147. 多个线程操作相同的数据时，一般是需要按顺序访问的，否则会引导数据错乱，
148. 无法控制数据，变成随机变量。为解决这个问题，就需要引入互斥变量，让每
149. 个线程都按顺序地访问变量。这样就需要使用EnterCriticalSection和
150. LeaveCriticalSection函数。
151. */
152. // now it critical!
153. ///进入临界区
154. EnterCriticalSection(&m_csCommunicationSync);
156. // if the port is already opened: close it
157. ///串口已打开就关掉
158. if (m_hComm != NULL)
159. {
160. CloseHandle(m_hComm);
161. m_hComm = NULL;
162. }
164. // prepare port strings
165. ///串口参数
166. sprintf(szPort, ".COM%d", portnr);///可以显示COM10以上端口//add by itas109 2014-01-09
167. sprintf(szBaud, "baud=%d parity=%c data=%d stop=%d", baud, parity, databits, stopbits);
169. // get a handle to the port
170. /*
171. 通信程序在CreateFile处指定串口设备及相关的操作属性，再返回一个句柄，
172. 该句柄将被用于后续的通信操作，并贯穿整个通信过程串口打开后，其属性
173. 被设置为默认值，根据具体需要，通过调用GetCommState(hComm,&&dcb)读取
174. 当前串口设备控制块DCB设置，修改后通过SetCommState(hComm,&&dcb)将其写
175. 入。运用ReadFile()与WriteFile()这两个API函数实现串口读写操作，若为异
176. 步通信方式，两函数中最后一个参数为指向OVERLAPPED结构的非空指针，在读
177. 写函数返回值为FALSE的情况下，调用GetLastError()函数，返回值为ERROR_IO_PENDING，
178. 表明I/O操作悬挂，即操作转入后台继续执行。此时，可以用WaitForSingleObject()
179. 来等待结束信号并设置最长等待时间
180. */
181. m_hComm = CreateFile(szPort, // communication port string (COMX)
182. GENERIC_READ | GENERIC_WRITE, // read/write types
183. 0, // comm devices must be opened with exclusive access
184. NULL, // no security attributes
185. OPEN_EXISTING, // comm devices must use OPEN_EXISTING
186. FILE_FLAG_OVERLAPPED, // Async I/O
187. 0); // template must be 0 for comm devices
189. ///创建失败
190. if (m_hComm == INVALID_HANDLE_VALUE)
191. {
192. // port not found
193. delete [] szPort;
194. delete [] szBaud;
196. return FALSE;
197. }
199. // set the timeout values
200. ///设置超时
201. m_CommTimeouts.ReadIntervalTimeout = 1000;
202. m_CommTimeouts.ReadTotalTimeoutMultiplier = 1000;
203. m_CommTimeouts.ReadTotalTimeoutConstant = 1000;
204. m_CommTimeouts.WriteTotalTimeoutMultiplier = 1000;
205. m_CommTimeouts.WriteTotalTimeoutConstant = 1000;
207. // configure
208. ///配置
209. ///分别调用Windows API设置串口参数
210. if (SetCommTimeouts(m_hComm, &m_CommTimeouts))///设置超时
211. {
212. /*
213. 若对端口数据的响应时间要求较严格，可采用事件驱动方式。
214. 事件驱动方式通过设置事件通知，当所希望的事件发生时，Windows
215. 发出该事件已发生的通知，这与DOS环境下的中断方式很相似。Windows
216. 定义了9种串口通信事件，较常用的有以下三种：
217. EV_RXCHAR:接收到一个字节，并放入输入缓冲区；
218. EV_TXEMPTY:输出缓冲区中的最后一个字符，发送出去；
219. EV_RXFLAG:接收到事件字符(DCB结构中EvtChar成员)，放入输入缓冲区
220. 在用SetCommMask()指定了有用的事件后，应用程序可调用WaitCommEvent()来等待事
221. 件的发生。SetCommMask(hComm,0)可使WaitCommEvent()中止
222. */
223. if (SetCommMask(m_hComm, dwCommEvents))///设置通信事件
224. {
225. if (GetCommState(m_hComm, &m_dcb))///获取当前DCB参数
226. {
227. m_dcb.EvtChar = 'q';///设置字件字符
228. m_dcb.fRtsControl = RTS_CONTROL_ENABLE; // set RTS bit high!
229. if (BuildCommDCB(szBaud, &m_dcb))///填写DCB结构
230. {
231. if (SetCommState(m_hComm, &m_dcb))///配置DCB
232. ; // normal operation... continue
233. else
234. ProcessErrorMessage("SetCommState()");
235. }
236. else
237. ProcessErrorMessage("BuildCommDCB()");
238. }
239. else
240. ProcessErrorMessage("GetCommState()");
241. }
242. else
243. ProcessErrorMessage("SetCommMask()");
244. }
245. else
246. ProcessErrorMessage("SetCommTimeouts()");
248. delete [] szPort;
249. delete [] szBaud;
251. // flush the port
252. ///终止读写并清空接收和发送
253. PurgeComm(m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);
255. // release critical section
256. ///释放临界资源
257. LeaveCriticalSection(&m_csCommunicationSync);
259. TRACE("Initialisation for communicationport %d completed.nUse Startmonitor to communicate.n", portnr);
261. return TRUE;
262. }
264. //
265. // The CommThread Function.
266. ///线程函数
267. ///监视线程的大致流程：
268. ///检查串口-->进入循环{WaitCommEvent(不阻塞询问)询问事件-->如果有事件来到-->到相应处理(关闭读写)}
269. //
270. UINT CSerialPort::CommThread(LPVOID pParam)
271. {
272. // Cast the void pointer passed to the thread back to
273. // a pointer of CSerialPort class
274. ///CSerialPort类的指针
275. CSerialPort *port = (CSerialPort*)pParam;
277. // Set the status variable in the dialog class to
278. // TRUE to indicate the thread is running.
279. ///TRUE表示线程正在运行
280. port->m_bThreadAlive = TRUE;
282. // Misc. variables
283. DWORD BytesTransfered = 0;
284. DWORD Event = 0;
285. DWORD CommEvent = 0;
286. DWORD dwError = 0;
287. COMSTAT comstat;
288. BOOL bResult = TRUE;
290. // Clear comm buffers at startup
291. ///开始时清除串口缓冲
292. if (port->m_hComm) // check if the port is opened
293. PurgeComm(port->m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);
295. // begin forever loop. This loop will run as long as the thread is alive.
296. ///只要线程存在就不断读取数据
297. for (;;)
298. {
300. // Make a call to WaitCommEvent(). This call will return immediatly
301. // because our port was created as an async port (FILE_FLAG_OVERLAPPED
302. // and an m_OverlappedStructerlapped structure specified). This call will cause the
303. // m_OverlappedStructerlapped element m_OverlappedStruct.hEvent, which is part of the m_hEventArray to
304. // be placed in a non-signeled state if there are no bytes available to be read,
305. // or to a signeled state if there are bytes available. If this event handle
306. // is set to the non-signeled state, it will be set to signeled when a
307. // character arrives at the port.
309. // we do this for each port!
311. /*
312. WaitCommEvent函数第3个参数1pOverlapped可以是一个OVERLAPPED结构的变量指针
313. ，也可以是NULL，当用NULL时，表示该函数是同步的，否则表示该函数是异步的。
314. 调用WaitCommEvent时，如果异步操作不能立即完成，会立即返回FALSE，系统在
315. WaitCommEvent返回前将OVERLAPPED结构成员hEvent设为无信号状态，等到产生通信
316. 事件时，系统将其置有信号
317. */
319. bResult = WaitCommEvent(port->m_hComm, &Event, &port->m_ov);///表示该函数是异步的
321. if (!bResult)
322. {
323. // If WaitCommEvent() returns FALSE, process the last error to determin
324. // the reason..
325. ///如果WaitCommEvent返回Error为FALSE，则查询错误信息
326. switch (dwError = GetLastError())
327. {
328. case ERROR_IO_PENDING: ///正常情况，没有字符可读
329. {
330. // This is a normal return value if there are no bytes
331. // to read at the port.
332. // Do nothing and continue
333. break;
334. }
335. case 87:///系统错误
336. {
337. // Under Windows NT, this value is returned for some reason.
338. // I have not investigated why, but it is also a valid reply
339. // Also do nothing and continue.
340. break;
341. }
342. default:///发生其他错误，其中有串口读写中断开串口连接的错误
343. {
344. // All other error codes indicate a serious error has
345. // occured. Process this error.
346. port->ProcessErrorMessage("WaitCommEvent()");
347. break;
348. }
349. }
350. }
351. else ///WaitCommEvent()能正确返回
352. {
353. // If WaitCommEvent() returns TRUE, check to be sure there are
354. // actually bytes in the buffer to read.
355. //
356. // If you are reading more than one byte at a time from the buffer
357. // (which this program does not do) you will have the situation occur
358. // where the first byte to arrive will cause the WaitForMultipleObjects()
359. // function to stop waiting. The WaitForMultipleObjects() function
360. // resets the event handle in m_OverlappedStruct.hEvent to the non-signelead state
361. // as it returns.
362. //
363. // If in the time between the reset of this event and the call to
364. // ReadFile() more bytes arrive, the m_OverlappedStruct.hEvent handle will be set again
365. // to the signeled state. When the call to ReadFile() occurs, it will
366. // read all of the bytes from the buffer, and the program will
367. // loop back around to WaitCommEvent().
368. //
369. // At this point you will be in the situation where m_OverlappedStruct.hEvent is set,
370. // but there are no bytes available to read. If you proceed and call
371. // ReadFile(), it will return immediatly due to the async port setup, but
372. // GetOverlappedResults() will not return until the next character arrives.
373. //
374. // It is not desirable for the GetOverlappedResults() function to be in
375. // this state. The thread shutdown event (event 0) and the WriteFile()
376. // event (Event2) will not work if the thread is blocked by GetOverlappedResults().
377. //
378. // The solution to this is to check the buffer with a call to ClearCommError().
379. // This call will reset the event handle, and if there are no bytes to read
380. // we can loop back through WaitCommEvent() again, then proceed.
381. // If there are really bytes to read, do nothing and proceed.
383. bResult = ClearCommError(port->m_hComm, &dwError, &comstat);
385. if (comstat.cbInQue == 0)
386. continue;
387. } // end if bResult
389. ///主等待函数，会阻塞线程
390. // Main wait function. This function will normally block the thread
391. // until one of nine events occur that require action.
392. ///等待3个事件：关断/读/写，有一个事件发生就返回
393. Event = WaitForMultipleObjects(3, ///3个事件
394. port->m_hEventArray, ///事件数组
395. FALSE, ///有一个事件发生就返回
396. INFINITE);///超时时间
398. switch (Event)
399. {
400. case 0:
401. {
402. // Shutdown event. This is event zero so it will be
403. // the higest priority and be serviced first.
404. ///关断事件，关闭串口
405. CloseHandle(port->m_hComm);
406. port->m_hComm=NULL;
407. port->m_bThreadAlive = FALSE;
409. // Kill this thread. break is not needed, but makes me feel better.
410. AfxEndThread(100);
412. break;
413. }
414. case 1: /// read event将定义的各种消息发送出去
415. {
416. memset(&comstat, 0, sizeof(COMSTAT));
417. GetCommMask(port->m_hComm, &CommEvent);
418. if (CommEvent & EV_RXCHAR)//接收到字符，并置于输入缓冲区中
419. // Receive character event from port.
420. ReceiveChar(port, comstat);
421. if (CommEvent & EV_CTS)//CTS信号状态发生变化
422. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_CTS_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
423. if (CommEvent & EV_BREAK)//输入中发生中断
424. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_BREAK_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
425. if (CommEvent & EV_ERR)//发生线路状态错误，线路状态错误包括CE_FRAME,CE_OVERRUN和CE_RXPARITY
426. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_ERR_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
427. if (CommEvent & EV_RING)//检测到振铃指示
428. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_RING_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
429. if (CommEvent & EV_RXFLAG)//接收到事件字符，并置于输入缓冲区中
430. ::SendMessage(port->m_pOwner->m_hWnd, WM_COMM_RXFLAG_DETECTED, (WPARAM) 0, (LPARAM) port->m_nPortNr);
432. break;
433. }
434. case 2: /// write event发送数据
435. {
436. // Write character event from port
437. WriteChar(port);
438. break;
439. }
440. default:
441. {
442. AfxMessageBox("接收有问题!");
443. break;
444. }
446. } // end switch
448. } // close forever loop
450. return 0;
451. }
453. //
454. // start comm watching
455. ///开启监视线程
456. //
457. BOOL CSerialPort::StartMonitoring()
458. {
459. if (!(m_Thread = AfxBeginThread(CommThread, this)))
460. return FALSE;
461. TRACE("Thread startedn");
462. m_bIsSuspened = false;
463. return TRUE;
464. }
466. //
467. // Restart the comm thread
468. ///复位监视线程
469. //
470. BOOL CSerialPort::RestartMonitoring()
471. {
472. TRACE("Thread resumedn");
473. m_bIsSuspened = false;
474. m_Thread->ResumeThread();
475. return TRUE;
476. }
479. //
480. // Suspend the comm thread
481. ///挂起监视线程
482. //
483. BOOL CSerialPort::StopMonitoring()
484. {
485. TRACE("Thread suspendedn");
486. m_bIsSuspened = true;
487. m_Thread->SuspendThread();
488. return TRUE;
489. }
492. //
493. // If there is a error, give the right message
494. ///如果有错误，给出提示
495. //
496. void CSerialPort::ProcessErrorMessage(char* ErrorText)
497. {
498. char *Temp = new char[200];
500. LPVOID lpMsgBuf;
502. FormatMessage(
503. FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
504. NULL,
505. GetLastError(),
506. MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
507. (LPTSTR) &lpMsgBuf,
508. 0,
509. NULL
510. );
512. sprintf(Temp, "WARNING: %s Failed with the following error: n%snPort: %dn", (char*)ErrorText, lpMsgBuf, m_nPortNr);
513. MessageBox(NULL, Temp, "Application Error", MB_ICONSTOP);
515. LocalFree(lpMsgBuf);
516. delete [] Temp;
517. return;///
518. }
520. //
521. // Write a character.
522. ///写数据
523. //
524. void CSerialPort::WriteChar(CSerialPort* port)
525. {
526. BOOL bWrite = TRUE;
527. BOOL bResult = TRUE;
529. DWORD BytesSent = 0;
531. ResetEvent(port->m_hWriteEvent);///复位写事件句柄
533. // Gain ownership of the critical section
534. EnterCriticalSection(&port->m_csCommunicationSync);
536. if (bWrite)
537. {
538. // Initailize variables
539. port->m_ov.Offset = 0;
540. port->m_ov.OffsetHigh = 0;
542. // Clear buffer
543. PurgeComm(port->m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);
545. ///串口写入
546. bResult = WriteFile(port->m_hComm, // Handle to COMM Port
547. port->m_szWriteBuffer, // Pointer to message buffer in calling finction
548. // strlen((char*)port->m_szWriteBuffer), // Length of message to send
549. port->m_nWriteSize, // Length of message to send // add by mrlong
550. &BytesSent, // Where to store the number of bytes sent
551. &port->m_ov); // Overlapped structure
553. // deal with any error codes
554. if (!bResult)
555. {
556. DWORD dwError = GetLastError();
557. switch (dwError)
558. {
559. case ERROR_IO_PENDING:
560. {
561. // continue to GetOverlappedResults()
562. BytesSent = 0;
563. bWrite = FALSE;
564. break;
565. }
566. default:
567. {
568. // all other error codes
569. port->ProcessErrorMessage("WriteFile()");
570. break;///
571. }
572. }
573. }
574. else
575. {
576. LeaveCriticalSection(&port->m_csCommunicationSync);
577. }
578. } // end if(bWrite)
580. if (!bWrite)
581. {
582. bWrite = TRUE;
584. bResult = GetOverlappedResult(port->m_hComm, // Handle to COMM port
585. &port->m_ov, // Overlapped structure
586. &BytesSent, // Stores number of bytes sent
587. TRUE); // Wait flag
589. LeaveCriticalSection(&port->m_csCommunicationSync);
591. // deal with the error code
592. //if (!bResult) ///注释掉了，为什么？
593. {
594. //port->ProcessErrorMessage("GetOverlappedResults() in WriteFile()");
595. }
596. } // end if (!bWrite)
598. //Verify that the data size send equals what we tried to send
599. if (BytesSent != port->m_nWriteSize) // Length of message to send)
600. {
601. TRACE("WARNING: WriteFile() error.. Bytes Sent: %d; Message Length: %dn", BytesSent, strlen((char*)port->m_szWriteBuffer));
602. }
603. // ::SendMessage((port->m_pOwner)->m_hWnd, WM_COMM_TXEMPTY_DETECTED, (WPARAM) RXBuff, (LPARAM) port->m_nPortNr);
604. // ::SendMessage((port->m_pOwner)->m_hWnd, WM_COMM_TXEMPTY_DETECTED,0,(LPARAM) port->m_nPortNr);
605. }
607. //
608. // Character received. Inform the owner
609. ///读数据
610. //
611. void CSerialPort::ReceiveChar(CSerialPort* port, COMSTAT comstat)
612. {
613. BOOL bRead = TRUE;
614. BOOL bResult = TRUE;
615. DWORD dwError = 0;
616. DWORD BytesRead = 0;
617. unsigned char RXBuff;
619. for (;;)
620. {
621. //add by liquanhai 防止死锁 2011-11-06
622. if(WaitForSingleObject(port->m_hShutdownEvent,0) == WAIT_OBJECT_0)
623. return;
625. // Gain ownership of the comm port critical section.
626. // This process guarantees no other part of this program
627. // is using the port object.
629. EnterCriticalSection(&port->m_csCommunicationSync);
631. // ClearCommError() will update the COMSTAT structure and
632. // clear any other errors.
633. ///更新COMSTAT
635. bResult = ClearCommError(port->m_hComm, &dwError, &comstat);
637. LeaveCriticalSection(&port->m_csCommunicationSync);
639. // start forever loop. I use this type of loop because I
640. // do not know at runtime how many loops this will have to
641. // run. My solution is to start a forever loop and to
642. // break out of it when I have processed all of the
643. // data available. Be careful with this approach and
644. // be sure your loop will exit.
645. // My reasons for this are not as clear in this sample
646. // as it is in my production code, but I have found this
647. // solutiion to be the most efficient way to do this.
649. ///所有字符均被读出，中断循环
650. if (comstat.cbInQue == 0)
651. {
652. // break out when all bytes have been read
653. break;
654. }
656. EnterCriticalSection(&port->m_csCommunicationSync);
658. if (bRead)
659. {
660. ///串口读出，读出缓冲区中字节
661. bResult = ReadFile(port->m_hComm, // Handle to COMM port
662. &RXBuff, // RX Buffer Pointer
663. 1, // Read one byte
664. &BytesRead, // Stores number of bytes read
665. &port->m_ov); // pointer to the m_ov structure
666. // deal with the error code
667. ///若返回错误，错误处理
668. if (!bResult)
669. {
670. switch (dwError = GetLastError())
671. {
672. case ERROR_IO_PENDING:
673. {
674. // asynchronous i/o is still in progress
675. // Proceed on to GetOverlappedResults();
676. ///异步IO仍在进行
677. bRead = FALSE;
678. break;
679. }
680. default:
681. {
682. // Another error has occured. Process this error.
683. port->ProcessErrorMessage("ReadFile()");
684. break;
685. //return;///防止读写数据时，串口非正常断开导致死循环一直执行。add by itas109 2014-01-09 与上面liquanhai添加防死锁的代码差不多
686. }
687. }
688. }
689. else///ReadFile返回TRUE
690. {
691. // ReadFile() returned complete. It is not necessary to call GetOverlappedResults()
692. bRead = TRUE;
693. }
694. } // close if (bRead)
696. ///异步IO操作仍在进行，需要调用GetOverlappedResult查询
697. if (!bRead)
698. {
699. bRead = TRUE;
700. bResult = GetOverlappedResult(port->m_hComm, // Handle to COMM port
701. &port->m_ov, // Overlapped structure
702. &BytesRead, // Stores number of bytes read
703. TRUE); // Wait flag
705. // deal with the error code
706. if (!bResult)
707. {
708. port->ProcessErrorMessage("GetOverlappedResults() in ReadFile()");
709. }
710. } // close if (!bRead)
712. LeaveCriticalSection(&port->m_csCommunicationSync);
714. // notify parent that a byte was received
715. ::SendMessage((port->m_pOwner)->m_hWnd, WM_COMM_RXCHAR, (WPARAM) RXBuff, (LPARAM) port->m_nPortNr);
716. } // end forever loop
718. }
720. //
721. // Write a string to the port
722. //
723. void CSerialPort::WriteToPort(char* string)
724. {
725. assert(m_hComm != 0);
727. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
728. strcpy(m_szWriteBuffer, string);
729. m_nWriteSize=strlen(string);
731. // set event for write
732. SetEvent(m_hWriteEvent);
733. }
736. void CSerialPort::WriteToPort(char* string,int n)
737. {
738. assert(m_hComm != 0);
740. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
741. // memset(m_szWriteBuffer, 0, n);
742. // strncpy(m_szWriteBuffer, string, n);
743. memcpy(m_szWriteBuffer, string, n);
744. m_nWriteSize=n;
746. // set event for write
747. SetEvent(m_hWriteEvent);
748. }
750. void CSerialPort::WriteToPort(LPCTSTR string,int n)
751. {
752. assert(m_hComm != 0);
754. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
755. memcpy(m_szWriteBuffer, string, n);
756. m_nWriteSize = n;
758. // set event for write
759. SetEvent(m_hWriteEvent);
760. }
762. void CSerialPort::WriteToPort(LPCTSTR string)
763. {
764. assert(m_hComm != 0);
766. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
767. strcpy(m_szWriteBuffer, string);
768. m_nWriteSize=strlen(string);
770. // set event for write
771. SetEvent(m_hWriteEvent);
772. }
774. void CSerialPort::WriteToPort(BYTE* Buffer, int n)
775. {
776. assert(m_hComm != 0);
777. memset(m_szWriteBuffer, 0, sizeof(m_szWriteBuffer));
778. int i;
779. for(i=0; i<n; i++)
780. {
781. m_szWriteBuffer[i] = Buffer[i];
782. }
783. m_nWriteSize=n;
785. // set event for write
786. SetEvent(m_hWriteEvent);
787. }
789. //
790. // Return the device control block
791. //
792. DCB CSerialPort::GetDCB()
793. {
794. return m_dcb;
795. }
797. //
798. // Return the communication event masks
799. //
800. DWORD CSerialPort::GetCommEvents()
801. {
802. return m_dwCommEvents;
803. }
805. //
806. // Return the output buffer size
807. //
808. DWORD CSerialPort::GetWriteBufferSize()
809. {
810. return m_nWriteBufferSize;
811. }
814. void CSerialPort::ClosePort()
815. {
816. if(m_bIsSuspened)
817. {
818. RestartMonitoring();
819. }
820. if (m_bThreadAlive)
821. {
822. MSG message;
823. while (m_bThreadAlive)
824. {
825. //add by liquanhai 防止死锁 2011-11-06
826. if(::PeekMessage(&message, m_pOwner->m_hWnd, 0, 0, PM_REMOVE))
827. {
828. ::TranslateMessage(&message);
829. ::DispatchMessage(&message);
830. }
831. SetEvent(m_hShutdownEvent);
832. }
833. TRACE("Thread endedn");
835. }
836. if(m_szWriteBuffer != NULL)
837. {
838. delete [] m_szWriteBuffer;
839. m_szWriteBuffer = NULL;
840. }
842. if(m_hComm)
843. {
844. CloseHandle(m_hComm);
845. m_hComm = NULL;
846. }
848. // Close Handles
849. if(m_hShutdownEvent!=NULL)
850. ResetEvent(m_hShutdownEvent);
851. if(m_ov.hEvent!=NULL)
852. ResetEvent(m_ov.hEvent);
853. if(m_hWriteEvent!=NULL)
854. ResetEvent(m_hWriteEvent);
855. }
857. void CSerialPort::SendData(LPCTSTR lpszData, const int nLength)
858. {
859. assert(m_hComm != 0);
860. memset(m_szWriteBuffer, 0, nLength);
861. strcpy(m_szWriteBuffer, lpszData);
862. m_nWriteSize=nLength;
863. // set event for write
864. SetEvent(m_hWriteEvent);
865. }
867. BOOL CSerialPort::RecvData(LPTSTR lpszData, const int nSize)
868. {
869. //
870. //接收数据
871. //
872. assert(m_hComm!=0);
873. memset(lpszData,0,nSize);
874. DWORD mylen = 0;
875. DWORD mylen2 = 0;
876. while (mylen < nSize) {
877. if(!ReadFile(m_hComm,lpszData,nSize,&mylen2,NULL))
878. return FALSE;
879. mylen += mylen2;
880. }
882. return TRUE;
883. }
885. COMMTIMEOUTS CSerialPort:: GetCommTimeOuts()
886. {
887. return m_CommTimeouts;
888. }
890. BOOL CSerialPort::SetCommTimeOuts(COMMTIMEOUTS *lpTimeOuts)
891. {
892. SetCommTimeouts(m_hComm, lpTimeOuts);//设置超时
893. return true;
894. }
895. /*
896. void CSerialPort::ClosePort()
897. {
898. do
899. {
900. SetEvent(m_hShutdownEvent);
901. } while (m_bThreadAlive);
904. // if the port is still opened: close it
905. if (m_hComm != NULL)
906. {
907. CloseHandle(m_hComm);
908. m_hComm = NULL;
909. }
910. // Close Handles
911. if(m_hShutdownEvent!=NULL)
912. CloseHandle( m_hShutdownEvent);
913. if(m_ov.hEvent!=NULL)
914. CloseHandle( m_ov.hEvent );
915. if(m_hWriteEvent!=NULL)
916. CloseHandle( m_hWriteEvent );
918. TRACE("Thread endedn");
919. delete [] m_szWriteBuffer;
920. }
921. */
923. //
924. ///查询注册表的串口号，将值存于数组中
925. ///本代码参考于mingojiang的获取串口逻辑名代码
926. //
927. void CSerialPort::QueryKey(HKEY hKey)
928. {
929. #define MAX_KEY_LENGTH 255
930. #define MAX_VALUE_NAME 16383
931. // TCHAR achKey[MAX_KEY_LENGTH]; // buffer for subkey name
932. // DWORD cbName; // size of name string
933. TCHAR achClass[MAX_PATH] = TEXT(""); // buffer for class name
934. DWORD cchClassName = MAX_PATH; // size of class string
935. DWORD cSubKeys=0; // number of subkeys
936. DWORD cbMaxSubKey; // longest subkey size
937. DWORD cchMaxClass; // longest class string
938. DWORD cValues; // number of values for key
939. DWORD cchMaxValue; // longest value name
940. DWORD cbMaxValueData; // longest value data
941. DWORD cbSecurityDescriptor; // size of security descriptor
942. FILETIME ftLastWriteTime; // last write time
944. DWORD i, retCode;
946. TCHAR achValue[MAX_VALUE_NAME];
947. DWORD cchValue = MAX_VALUE_NAME;
949. // Get the class name and the value count.
950. retCode = RegQueryInfoKey(
951. hKey, // key handle
952. achClass, // buffer for class name
953. &cchClassName, // size of class string
954. NULL, // reserved
955. &cSubKeys, // number of subkeys
956. &cbMaxSubKey, // longest subkey size
957. &cchMaxClass, // longest class string
958. &cValues, // number of values for this key
959. &cchMaxValue, // longest value name
960. &cbMaxValueData, // longest value data
961. &cbSecurityDescriptor, // security descriptor
962. &ftLastWriteTime); // last write time
964. for (i=0;i<20;i++)///存放串口号的数组初始化
965. {
966. m_nComArray[i] = -1;
967. }
969. // Enumerate the key values.
970. if (cValues > 0) {
971. for (i=0, retCode=ERROR_SUCCESS; i<cValues; i++) {
972. cchValue = MAX_VALUE_NAME; achValue[0] = '';
973. if (ERROR_SUCCESS == RegEnumValue(hKey, i, achValue, &cchValue, NULL, NULL, NULL, NULL)) {
974. CString szName(achValue);
975. if (-1 != szName.Find(_T("Serial")) || -1 != szName.Find(_T("VCom")) ){
976. BYTE strDSName[10]; memset(strDSName, 0, 10);
977. DWORD nValueType = 0, nBuffLen = 10;
978. if (ERROR_SUCCESS == RegQueryValueEx(hKey, (LPCTSTR)achValue, NULL, &nValueType, strDSName, &nBuffLen)){
979. int nIndex = -1;
980. while(++nIndex < MaxSerialPortNum){
981. if (-1 == m_nComArray[nIndex]) {
982. m_nComArray[nIndex] = atoi((char*)(strDSName + 3));
983. break;
984. }
985. }
986. }
987. }
988. }
989. }
990. }
991. else{
992. AfxMessageBox(_T("本机没有串口....."));
993. }
995. }
997. void CSerialPort::Hkey2ComboBox(CComboBox& m_PortNO)
998. {
999. HKEY hTestKey;
1000. bool Flag = FALSE;
1002. ///仅是XP系统的注册表位置，其他系统根据实际情况做修改
1003. if(ERROR_SUCCESS == RegOpenKeyEx(HKEY_LOCAL_MACHINE, TEXT("HARDWAREDEVICEMAPSERIALCOMM"), 0, KEY_READ, &hTestKey) ){
1004. QueryKey(hTestKey);
1005. }
1006. RegCloseKey(hTestKey);
1008. int i = 0;
1009. m_PortNO.ResetContent();///刷新时，清空下拉列表内容
1010. while(i < MaxSerialPortNum && -1 != m_nComArray[i]){
1011. CString szCom;
1012. szCom.Format(_T("COM%d"), m_nComArray[i]);
1013. m_PortNO.InsertString(i, szCom.GetBuffer(5));
1014. ++i;
1015. Flag = TRUE;
1016. if (Flag)///把第一个发现的串口设为下拉列表的默认值
1017. m_PortNO.SetCurSel(0);
1018. }
1020. }
如需转载请标明出处：http://blog.csdn.net/itas109

网站首页	管理程序	智能项目	上位机
CC2530	ESP8266	MQTT云服务	生活休闲