C++串口編程實例

在windows程序設計與開發過程當中，特別是涉及到開發嵌入式軟硬件系統時，每每會涉及到串口編程。網上以及一些書籍上講解windows下的串口編程知識也挺多的，但我我的以爲，看完書上的知識點有時依然不知道該如何下手開始本身的程序設計和代碼編寫，許多知識若是能結合着詳細的例子每每可以幫助咱們學習得更快，因此，在此，我專門爲串口編程初學者設計了一個詳細的例子，供你們參考和學習。
   
下面我將本身用C++編寫的串口通訊的例子貼出來，其特色以下：
   
1. 本例子使用了比較規範的軟件設計方法，類的設計具備比較好的可擴展性和移植性、代碼的註釋採用doxgen支持的javaDoc風格。
2. 爲了能方便初學者更快地瞭解和入門，幾乎每一行代碼都加上了詳細的註釋，對於註釋中若是依然有不清楚的概念，相信你經過百度和google必定能找到答案。
3. 本例子設計的串口操做類能夠直接移植到其餘的工程中去，你們也能夠根據本身的須要添加其餘的接口。
4. 本例子只實現了串口數據的基本收發功能，其實爲了保證串口數據傳輸的正確性，每每須要設計一些串口通訊協議，協議的設計有待你本身完成，若是之後有時間，我也會嘗試提供一種比較基本的串口通訊協議設計案例給你們學習。
5. 關於本程序的驗證方法，能夠使用虛擬串口軟件VSPM和串口調試助手進行程序的測試與驗證，上述兩個軟件的使用方法請參考： http://ticktick.blog.51cto.com/823160/285610

 

下面即爲例子工程的三個文件，SerialPort.h、SerialPort.cpp、maincpp

 

附件中是工程文件，須要使用vs2008打開。

     

//////////////////////////////////////////////////////////////////////////
/// COPYRIGHT NOTICE
/// Copyright (c) 2009, 華中科技大學tickTick Group  （版權聲明）
/// All rights reserved.
///
/// @file    SerialPort.h
/// @brief   串口通訊類頭文件
///
/// 本文件完成串口通訊類的聲明
///
/// @version 1.0
/// @author  盧俊
/// @E-mail：lujun.hust@gmail.com
/// @date    2010/03/19
///
///  修訂說明：
//////////////////////////////////////////////////////////////////////////

#ifndef SERIALPORT_H_
#define SERIALPORT_H_

#include <Windows.h>

/** 串口通訊類
 *
 *  本類實現了對串口的基本操做
 *  例如監聽發到指定串口的數據、發送指定數據到串口
 */
class CSerialPort
{
public:
    CSerialPort(void);
    ~CSerialPort(void);

public:

    /** 初始化串口函數
     *
     *  @param:  UINT portNo 串口編號,默認值爲1,即COM1,注意,儘可能不要大於9
     *  @param:  UINT baud   波特率,默認爲9600
     *  @param:  char parity 是否進行奇偶校驗,'Y'表示須要奇偶校驗,'N'表示不須要奇偶校驗
     *  @param:  UINT databits 數據位的個數,默認值爲8個數據位
     *  @param:  UINT stopsbits 中止位使用格式,默認值爲1
     *  @param:  DWORD dwCommEvents 默認爲EV_RXCHAR,即只要收發任意一個字符,則產生一個事件
     *  @return: bool  初始化是否成功
     *  @note:   在使用其餘本類提供的函數前,請先調用本函數進行串口的初始化
     *　　　　　  \n本函數提供了一些經常使用的串口參數設置,若須要自行設置詳細的DCB參數,可以使用重載函數
     *           \n本串口類析構時會自動關閉串口,無需額外執行關閉串口
     *  @see:
     */
    bool InitPort( UINT  portNo = 1,UINT  baud = CBR_9600,char  parity = 'N',UINT  databits = 8, UINT  stopsbits = 1,DWORD dwCommEvents = EV_RXCHAR);

    /** 串口初始化函數
     *
     *  本函數提供直接根據DCB參數設置串口參數
     *  @param:  UINT portNo
     *  @param:  const LPDCB & plDCB
     *  @return: bool  初始化是否成功
     *  @note:   本函數提供用戶自定義地串口初始化參數
     *  @see:
     */
    bool InitPort( UINT  portNo ,const LPDCB& plDCB );

    /** 開啓監聽線程
     *
     *  本監聽線程完成對串口數據的監聽,並將接收到的數據打印到屏幕輸出
     *  @return: bool  操做是否成功
     *  @note:   當線程已經處於開啓狀態時,返回flase
     *  @see:
     */
    bool OpenListenThread();

    /** 關閉監聽線程
     *
     *
     *  @return: bool  操做是否成功
     *  @note:   調用本函數後,監聽串口的線程將會被關閉
     *  @see:
     */
    bool CloseListenTread();

    /** 向串口寫數據
     *
     *  將緩衝區中的數據寫入到串口
     *  @param:  unsigned char * pData 指向須要寫入串口的數據緩衝區
     *  @param:  unsigned int length 須要寫入的數據長度
     *  @return: bool  操做是否成功
     *  @note:   length不要大於pData所指向緩衝區的大小
     *  @see:
     */
    bool WriteData(unsigned char* pData, unsigned int length);

    /** 獲取串口緩衝區中的字節數
     *
     *
     *  @return: UINT  操做是否成功
     *  @note:   當串口緩衝區中無數據時,返回0
     *  @see:
     */
    UINT GetBytesInCOM();

    /** 讀取串口接收緩衝區中一個字節的數據
     *
     *
     *  @param:  char & cRecved 存放讀取數據的字符變量
     *  @return: bool  讀取是否成功
     *  @note:
     *  @see:
     */
    bool ReadChar(char &cRecved);

private:

    /** 打開串口
     *
     *
     *  @param:  UINT portNo 串口設備號
     *  @return: bool  打開是否成功
     *  @note:
     *  @see:
     */
    bool openPort( UINT  portNo );

    /** 關閉串口
     *
     *
     *  @return: void  操做是否成功
     *  @note:
     *  @see:
     */
    void ClosePort();

    /** 串口監聽線程
     *
     *  監聽來自串口的數據和信息
     *  @param:  void * pParam 線程參數
     *  @return: UINT WINAPI 線程返回值
     *  @note:
     *  @see:
     */
    static UINT WINAPI ListenThread(void* pParam);

private:

    /** 串口句柄 */
    HANDLE  m_hComm;

    /** 線程退出標誌變量 */
    static bool s_bExit;

    /** 線程句柄 */
    volatile HANDLE    m_hListenThread;

    /** 同步互斥,臨界區保護 */
    CRITICAL_SECTION   m_csCommunicationSync;       //!< 互斥操做串口

};

#endif //SERIALPORT_H_

//////////////////////////////////////////////////////////////////////////
/// COPYRIGHT NOTICE
/// Copyright (c) 2009, 華中科技大學tickTick Group  （版權聲明）
/// All rights reserved.
///
/// @file    SerialPort.cpp
/// @brief   串口通訊類的實現文件
///
/// 本文件爲串口通訊類的實現代碼
///
/// @version 1.0
/// @author  盧俊
/// @E-mail：lujun.hust@gmail.com
/// @date    2010/03/19
///
///
///  修訂說明：
//////////////////////////////////////////////////////////////////////////

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

/** 線程退出標誌 */
bool CSerialPort::s_bExit = false;
/** 當串口無數據時,sleep至下次查詢間隔的時間,單位:秒 */
const UINT SLEEP_TIME_INTERVAL = 5;

CSerialPort::CSerialPort(void)
: m_hListenThread(INVALID_HANDLE_VALUE)
{
    m_hComm = INVALID_HANDLE_VALUE;
    m_hListenThread = INVALID_HANDLE_VALUE;

    InitializeCriticalSection(&m_csCommunicationSync);

}

CSerialPort::~CSerialPort(void)
{
    CloseListenTread();
    ClosePort();
    DeleteCriticalSection(&m_csCommunicationSync);
}

bool CSerialPort::InitPort( UINT portNo /*= 1*/,UINT baud /*= CBR_9600*/,char parity /*= 'N'*/,
                            UINT databits /*= 8*/, UINT stopsbits /*= 1*/,DWORD dwCommEvents /*= EV_RXCHAR*/ )
{

    /** 臨時變量,將制定參數轉化爲字符串形式,以構造DCB結構 */
    char szDCBparam[50];
    sprintf_s(szDCBparam, "baud=%d parity=%c data=%d stop=%d", baud, parity, databits, stopsbits);

    /** 打開指定串口,該函數內部已經有臨界區保護,上面請不要加保護 */
    if (!openPort(portNo))
    {
        return false;
    }

    /** 進入臨界段 */
    EnterCriticalSection(&m_csCommunicationSync);

    /** 是否有錯誤發生 */
    BOOL bIsSuccess = TRUE;

    /** 在此能夠設置輸入輸出的緩衝區大小,若是不設置,則系統會設置默認值.
     *  本身設置緩衝區大小時,要注意設置稍大一些,避免緩衝區溢出
     */
    /*if (bIsSuccess )
    {
        bIsSuccess = SetupComm(m_hComm,10,10);
    }*/

    /** 設置串口的超時時間,均設爲0,表示不使用超時限制 */
    COMMTIMEOUTS  CommTimeouts;
    CommTimeouts.ReadIntervalTimeout         = 0;
    CommTimeouts.ReadTotalTimeoutMultiplier  = 0;
    CommTimeouts.ReadTotalTimeoutConstant    = 0;
    CommTimeouts.WriteTotalTimeoutMultiplier = 0;
    CommTimeouts.WriteTotalTimeoutConstant   = 0;
    if ( bIsSuccess)
    {
        bIsSuccess = SetCommTimeouts(m_hComm, &CommTimeouts);
    }

    DCB  dcb;
    if ( bIsSuccess )
    {
        // 將ANSI字符串轉換爲UNICODE字符串
        DWORD dwNum = MultiByteToWideChar (CP_ACP, 0, szDCBparam, -1, NULL, 0);
        wchar_t *pwText = new wchar_t[dwNum] ;
        if (!MultiByteToWideChar (CP_ACP, 0, szDCBparam, -1, pwText, dwNum))
        {
            bIsSuccess = TRUE;
        }

        /** 獲取當前串口配置參數,而且構造串口DCB參數 */
        bIsSuccess = GetCommState(m_hComm, &dcb) && BuildCommDCB(pwText, &dcb) ;
        /** 開啓RTS flow控制 */
        dcb.fRtsControl = RTS_CONTROL_ENABLE;

        /** 釋放內存空間 */
        delete [] pwText;
    }

    if ( bIsSuccess )
    {
        /** 使用DCB參數配置串口狀態 */
        bIsSuccess = SetCommState(m_hComm, &dcb);
    }

    /**  清空串口緩衝區 */
    PurgeComm(m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);

    /** 離開臨界段 */
    LeaveCriticalSection(&m_csCommunicationSync);

    return bIsSuccess==TRUE;
}

bool CSerialPort::InitPort( UINT portNo ,const LPDCB& plDCB )
{
    /** 打開指定串口,該函數內部已經有臨界區保護,上面請不要加保護 */
    if (!openPort(portNo))
    {
        return false;
    }

    /** 進入臨界段 */
    EnterCriticalSection(&m_csCommunicationSync);

    /** 配置串口參數 */
    if (!SetCommState(m_hComm, plDCB))
    {
        return false;
    }

    /**  清空串口緩衝區 */
    PurgeComm(m_hComm, PURGE_RXCLEAR | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_TXABORT);

    /** 離開臨界段 */
    LeaveCriticalSection(&m_csCommunicationSync);

    return true;
}

void CSerialPort::ClosePort()
{
    /** 若是有串口被打開，關閉它 */
    if( m_hComm != INVALID_HANDLE_VALUE )
    {
        CloseHandle( m_hComm );
        m_hComm = INVALID_HANDLE_VALUE;
    }
}

bool CSerialPort::openPort( UINT portNo )
{
    /** 進入臨界段 */
    EnterCriticalSection(&m_csCommunicationSync);

    /** 把串口的編號轉換爲設備名 */
    char szPort[50];
    sprintf_s(szPort, "COM%d", portNo);

    /** 打開指定的串口 */
    m_hComm = CreateFileA(szPort, /** 設備名,COM1,COM2等 */
              GENERIC_READ | GENERIC_WRITE, /** 訪問模式,可同時讀寫 */
              0,                           /** 共享模式,0表示不共享 */
              NULL,                         /** 安全性設置,通常使用NULL */
              OPEN_EXISTING,                /** 該參數表示設備必須存在,不然建立失敗 */
              0,
              0);

    /** 若是打開失敗，釋放資源並返回 */
    if (m_hComm == INVALID_HANDLE_VALUE)
    {
        LeaveCriticalSection(&m_csCommunicationSync);
        return false;
    }

    /** 退出臨界區 */
    LeaveCriticalSection(&m_csCommunicationSync);

    return true;
}

bool CSerialPort::OpenListenThread()
{
    /** 檢測線程是否已經開啓了 */
    if (m_hListenThread != INVALID_HANDLE_VALUE)
    {
        /** 線程已經開啓 */
        return false;
    }

    s_bExit = false;
    /** 線程ID */
    UINT threadId;
    /** 開啓串口數據監聽線程 */
    m_hListenThread = (HANDLE)_beginthreadex(NULL, 0, ListenThread, this, 0, &threadId);
    if (!m_hListenThread)
    {
        return false;
    }
    /** 設置線程的優先級,高於普通線程 */
    if (!SetThreadPriority(m_hListenThread, THREAD_PRIORITY_ABOVE_NORMAL))
    {
        return false;
    }

    return true;
}

bool CSerialPort::CloseListenTread()
{
    if (m_hListenThread != INVALID_HANDLE_VALUE)
    {
        /** 通知線程退出 */
        s_bExit = true;

        /** 等待線程退出 */
        Sleep(10);

        /** 置線程句柄無效 */
        CloseHandle( m_hListenThread );
        m_hListenThread = INVALID_HANDLE_VALUE;
    }
    return true;
}

UINT CSerialPort::GetBytesInCOM()
{
    DWORD dwError = 0;  /** 錯誤碼 */
    COMSTAT  comstat;   /** COMSTAT結構體,記錄通訊設備的狀態信息 */
    memset(&comstat, 0, sizeof(COMSTAT));

    UINT BytesInQue = 0;
    /** 在調用ReadFile和WriteFile以前,經過本函數清除之前遺留的錯誤標誌 */
    if ( ClearCommError(m_hComm, &dwError, &comstat) )
    {
        BytesInQue = comstat.cbInQue; /** 獲取在輸入緩衝區中的字節數 */
    }

    return BytesInQue;
}

UINT WINAPI CSerialPort::ListenThread( void* pParam )
{
    /** 獲得本類的指針 */
    CSerialPort *pSerialPort = reinterpret_cast<CSerialPort*>(pParam);

    // 線程循環,輪詢方式讀取串口數據
    while (!pSerialPort->s_bExit)
    {
        UINT BytesInQue = pSerialPort->GetBytesInCOM();
        /** 若是串口輸入緩衝區中無數據,則休息一會再查詢 */
        if ( BytesInQue == 0 )
        {
            Sleep(SLEEP_TIME_INTERVAL);
            continue;
        }

        /** 讀取輸入緩衝區中的數據並輸出顯示 */
        char cRecved = 0x00;
        do
        {
            cRecved = 0x00;
            if(pSerialPort->ReadChar(cRecved) == true)
            {
                std::cout << cRecved ;
                continue;
            }
        }while(--BytesInQue);
    }

    return 0;
}

bool CSerialPort::ReadChar( char &cRecved )
{
    BOOL  bResult     = TRUE;
    DWORD BytesRead   = 0;
    if(m_hComm == INVALID_HANDLE_VALUE)
    {
        return false;
    }

    /** 臨界區保護 */
    EnterCriticalSection(&m_csCommunicationSync);

    /** 從緩衝區讀取一個字節的數據 */
    bResult = ReadFile(m_hComm, &cRecved, 1, &BytesRead, NULL);
    if ((!bResult))
    {
        /** 獲取錯誤碼,能夠根據該錯誤碼查出錯誤緣由 */
        DWORD dwError = GetLastError();

        /** 清空串口緩衝區 */
        PurgeComm(m_hComm, PURGE_RXCLEAR | PURGE_RXABORT);
        LeaveCriticalSection(&m_csCommunicationSync);

        return false;
    }

    /** 離開臨界區 */
    LeaveCriticalSection(&m_csCommunicationSync);

    return (BytesRead == 1);

}

bool CSerialPort::WriteData( unsigned char* pData, unsigned int length )
{
    BOOL   bResult     = TRUE;
    DWORD  BytesToSend = 0;
    if(m_hComm == INVALID_HANDLE_VALUE)
    {
        return false;
    }

    /** 臨界區保護 */
    EnterCriticalSection(&m_csCommunicationSync);

    /** 向緩衝區寫入指定量的數據 */
    bResult = WriteFile(m_hComm, pData, length, &BytesToSend, NULL);
    if (!bResult)
    {
        DWORD dwError = GetLastError();
        /** 清空串口緩衝區 */
        PurgeComm(m_hComm, PURGE_RXCLEAR | PURGE_RXABORT);
        LeaveCriticalSection(&m_csCommunicationSync);

        return false;
    }

    /** 離開臨界區 */
    LeaveCriticalSection(&m_csCommunicationSync);

    return true;
}

// main.cpp : Defines the entry point for the console application.
//

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

int _tmain(int argc, _TCHAR* argv[])
{

    CSerialPort mySerialPort;

    if (!mySerialPort.InitPort(2))
    {
        std::cout << "initPort fail !" << std::endl;
    }
    else
    {
        std::cout << "initPort success !" << std::endl;
    }

    if (!mySerialPort.OpenListenThread())
    {
        std::cout << "OpenListenThread fail !" << std::endl;
    }
    else
    {
        std::cout << "OpenListenThread success !" << std::endl;
    }

    int temp;
    std::cin >> temp;

    return 0;
}