天天看點

C#開發序列槽總結,并提煉序列槽輔助類到公用類庫中

開發C#相關的項目有很多年了,一直沒有接觸序列槽的開發,近期由于工作的需要,需要了解熟悉對硬體序列槽的開發,通過對序列槽的深入了解,序列槽也不再是什麼神秘的東西,利用SerailPort元件,對序列槽的各種操作也非常的友善,由于本人總是喜歡把一些常用的東西封裝成可供重複利用的類庫,是以,閱百家代碼,提煉總結優化,把對序列槽的操作封裝成一個公用的類庫,應付日常的序列槽程式設計開發,也算是工作的一個階段性總結吧。

先上圖,了解序列槽的一些基本的東西,并逐漸介紹相關的知識。

微軟在 .NET FrameWork2.0中對序列槽通訊進行了封裝,我們可以在.net2.0及以上版本開發時直接使用SerialPort類對序列槽進行讀寫操作。

SerialPort類的屬性主要包括:

    1)序列槽名稱(PortName) 

    2)波特率(BaudRate)

    3)資料位 DataBits

    4)停止位 StopBits

    5)奇偶校驗 Parity 

SerialPort類的事件主要包括:

    DataReceived:用于異步接收序列槽資料事件

    ErrorReceived:錯誤處理事件

SerialPort類的方法主要包括: 

    Open();Close();Read();Write()、DiscardInBuffer()、DiscardOutBuffer()等

從上面的測試例子圖中,我們可以看到,一般對序列槽的操作,需要提供序列槽号、波特率、資料位、停止位、奇偶校驗的參數,用來構造一個序列槽操作類,以便實作具體的序列槽操作,而這些參數有的是系統内置的枚舉參數,我們可以通過周遊枚舉對象來綁定下來清單(如停止位、奇偶校驗);但有些參數卻不是系統内置的枚舉類型,例如波特率、資料位等,而且對這些參數操作也是序列槽開發經常用到的,是以,第一步,我對這些參數的綁定做了一個簡單的封裝。

1、先構造波特率、資料位這兩個枚舉對象,友善實際操作。

    /// <summary>

    /// 序列槽資料位清單(5,6,7,8)

    /// </summary>

    public enum SerialPortDatabits : int

    {

        FiveBits = 5,

        SixBits = 6,

        SeventBits = 7,

        EightBits = 8

    }

    /// <summary>

    /// 序列槽波特率清單。

    /// 75,110,150,300,600,1200,2400,4800,9600,14400,19200,28800,38400,56000,57600,

    /// 115200,128000,230400,256000

    public enum SerialPortBaudRates : int

        BaudRate_75 = 75,

        BaudRate_110 = 110,

        BaudRate_150 = 150,

        BaudRate_300 = 300,

        BaudRate_600 = 600,

        BaudRate_1200 = 1200,

        BaudRate_2400 = 2400,

        BaudRate_4800 = 4800,

        BaudRate_9600 = 9600,

        BaudRate_14400 = 14400,

        BaudRate_19200 = 19200,

        BaudRate_28800 = 28800,

        BaudRate_38400 = 38400,

        BaudRate_56000 = 56000,

        BaudRate_57600 = 57600,

        BaudRate_115200 = 115200,

        BaudRate_128000 = 128000,

        BaudRate_230400 = 230400,

        BaudRate_256000 = 256000

   } 

2、對常用的參數下拉清單綁定做一個封裝。

        /// <summary>

        /// 設定序列槽号

        /// </summary>

        /// <param name="obj"></param>

        public static void SetPortNameValues(ComboBox obj)

        {

            obj.Items.Clear();

            foreach (string str in SerialPort.GetPortNames())

            {

                obj.Items.Add(str);

            }

        }

        /// <summary>

        /// 設定波特率

        public static void SetBauRateValues(ComboBox obj)

            foreach (SerialPortBaudRates rate in Enum.GetValues(typeof(SerialPortBaudRates)))

                obj.Items.Add(((int)rate).ToString());

        /// 設定資料位

        public static void SetDataBitsValues(ComboBox obj)

            foreach (SerialPortDatabits databit in Enum.GetValues(typeof(SerialPortDatabits)))

                obj.Items.Add(((int)databit).ToString());

        /// 設定校驗位清單

        public static  void SetParityValues(ComboBox obj)

            foreach (string str in Enum.GetNames(typeof(Parity)))

        /// 設定停止位

        public static void SetStopBitValues(ComboBox obj)

            foreach (string str in Enum.GetNames(typeof(StopBits)))

            } 

       }

這樣我們在窗體界面代碼中,綁定相關參數的資料源就很友善了,如下所示。

        private void Form1_Load(object sender, EventArgs e)

            BindData();

        private void BindData()

            //綁定端口号

            SerialPortUtil.SetPortNameValues(txtPort);

            txtPort.SelectedIndex = 0;

            //波特率

            SerialPortUtil.SetBauRateValues(txtBaudRate);

            txtBaudRate.SelectedText = "57600";

            //資料位

            SerialPortUtil.SetDataBitsValues(txtDataBits);

            this.txtDataBits.SelectedText = "8";

            //校驗位

            SerialPortUtil.SetParityValues(txtParity);

            this.txtParity.SelectedIndex = 0;

            //停止位

            SerialPortUtil.SetStopBitValues(txtStopBit);

            this.txtStopBit.SelectedIndex = 1;

            this.btnSend.Enabled = isOpened;

3、 為了友善構造封裝的視窗類,提供了兩個不同類型參數的序列槽輔助類構造函數,一個可以使用枚舉參數,一個使用字元串參數(最終轉換為枚舉參數對象),如下所示。使用枚舉對象,不需要記住不同參數應該填寫那些值,隻需要從枚舉中選擇即可,友善又直覺。

        /// 參數構造函數(使用枚舉參數構造)

        /// <param name="baud">波特率</param>

        /// <param name="par">奇偶校驗位</param>

        /// <param name="sBits">停止位</param>

        /// <param name="dBits">資料位</param>

        /// <param name="name">序列槽号</param>

        public SerialPortUtil(string name, SerialPortBaudRates baud, Parity par, SerialPortDatabits dBits, StopBits sBits)

            _portName = name;

            _baudRate = baud;

            _parity = par;

            _dataBits = dBits;

            _stopBits = sBits;

            comPort.DataReceived += new SerialDataReceivedEventHandler(comPort_DataReceived);

            comPort.ErrorReceived += new SerialErrorReceivedEventHandler(comPort_ErrorReceived);

        /// 參數構造函數(使用字元串參數構造)

        public SerialPortUtil(string name, string baud, string par, string dBits, string sBits)

            _baudRate = (SerialPortBaudRates)Enum.Parse(typeof(SerialPortBaudRates), baud);

            _parity = (Parity)Enum.Parse(typeof(Parity), par);

            _dataBits = (SerialPortDatabits)Enum.Parse(typeof(SerialPortDatabits), dBits);

            _stopBits = (StopBits)Enum.Parse(typeof(StopBits), sBits);

構造函數做好了,就很友善在實際的窗體界面函數中構造序列槽執行個體了,如下使用代碼所示:

        private void btnConnect_Click(object sender, EventArgs e)

            try

                if (serial == null)

                {

                    try

                    {

                        string portname = this.txtPort.Text;

                        SerialPortBaudRates rate = (SerialPortBaudRates)Enum.Parse(typeof(SerialPortBaudRates), this.txtBaudRate.Text);//int.Parse(this.txtBaudRate.Text);

                        SerialPortDatabits databit = (SerialPortDatabits)int.Parse(this.txtDataBits.Text);

                        Parity party = (Parity)Enum.Parse(typeof(Parity), this.txtParity.Text);

                        StopBits stopbit = (StopBits)Enum.Parse(typeof(StopBits), this.txtStopBit.Text);

                        //使用枚舉參數構造

                        //serial = new SerialPortUtil(portname, rate, party, databit, stopbit);

                        //使用字元串參數構造

                        serial = new SerialPortUtil(portname, this.txtBaudRate.Text, this.txtParity.Text, this.txtDataBits.Text, this.txtStopBit.Text);

                        serial.DataReceived += new DataReceivedEventHandler(serial_DataReceived);

                    }

                    catch (Exception ex)

                        MessageBox.Show(ex.Message);

                        serial = null;

                        return;

                }

                if (!isOpened)

                {                    

                    serial.OpenPort();

                    btnConnect.Text = "斷開";

                else

                    serial.ClosePort();

                    serial = null;

                    btnConnect.Text = "連接配接";

                isOpened = !isOpened;

                this.btnSend.Enabled = isOpened;

                this.lblTips.Text = isOpened ? "已連接配接" : "未連接配接";

            catch (Exception ex)

                this.lblTips.Text = ex.Message;

                MessageBox.Show(ex.Message);

4、對序列槽資料的發送以及序列槽的一些基本操作進行簡單封裝,友善輔助類對序列槽進行相關操作。

        /// 端口是否已經打開

        public bool IsOpen

            get

                return comPort.IsOpen;

        /// 打開端口

        /// <returns></returns>

        public void OpenPort()

            if (comPort.IsOpen) comPort.Close();

            comPort.PortName = _portName;

            comPort.BaudRate = (int)_baudRate;

            comPort.Parity = _parity;

            comPort.DataBits = (int)_dataBits;

            comPort.StopBits = _stopBits;

            comPort.Open();

        /// 關閉端口

        public void ClosePort()

        /// 丢棄來自串行驅動程式的接收和發送緩沖區的資料

        public void DiscardBuffer()

            comPort.DiscardInBuffer();

            comPort.DiscardOutBuffer();

        /// 寫入資料

        /// <param name="msg"></param>

        public void WriteData(string msg)

            if (!(comPort.IsOpen)) comPort.Open();

            comPort.Write(msg);

        /// <param name="msg">寫入端口的位元組數組</param>

        public void WriteData(byte[] msg)

            comPort.Write(msg, 0, msg.Length);

        /// <param name="msg">包含要寫入端口的位元組數組</param>

        /// <param name="offset">參數從0位元組開始的位元組偏移量</param>

        /// <param name="count">要寫入的位元組數</param>

        public void WriteData(byte[] msg, int offset, int count)

            comPort.Write(msg, offset, count);

        }

6、接收資料的還原

這樣基本上就對序列槽封裝的差不多了,不過還有一個重要的操作就是對序列槽的資料進行接收,并進行處理。由于序列槽擷取資料不是一次性完整的擷取的,可能會被拆分為好幾段,是以,如何還原接收到的資料也就是一個值得注意的問題,這個最好能根據協定來确定,如我的協定基本上是以“~”符号開始,以“#”符号結束,是以我對協定資料的還原,就有可依據的準則。

1)首先要構造一個資料處理的代理,和一個資料處理的事件參數類,如下所示。 

    public class DataReceivedEventArgs : EventArgs

        public string DataReceived;

        public DataReceivedEventArgs(string m_DataReceived)

            this.DataReceived = m_DataReceived;

    public delegate void DataReceivedEventHandler(DataReceivedEventArgs e); 

2)然後構造一個資料接收和錯誤處理的事件,如下所示

        /// 完整協定的記錄處理事件

        public event DataReceivedEventHandler DataReceived;

        public event SerialErrorReceivedEventHandler Error; 

3)在構造函數添加相關的事件處理,如下所示

      }

 4)實作對資料的接收和錯誤的處理 

        /// <summary>

        /// 結束符比特

        /// </summary>

        public byte EndByte = 0x23;//string End = "#";

        /// 資料接收處理

        void comPort_DataReceived(object sender, SerialDataReceivedEventArgs e)

            //禁止接收事件時直接退出

            if (ReceiveEventFlag) return;

            #region 根據結束位元組來判斷是否全部擷取完成

            List<byte> _byteData = new List<byte>();

            bool found = false;//是否檢測到結束符号

            while (comPort.BytesToRead > 0 || !found)

                byte[] readBuffer = new byte[comPort.ReadBufferSize + 1];

                int count = comPort.Read(readBuffer, 0, comPort.ReadBufferSize);

                for (int i = 0; i < count; i++)

                    _byteData.Add(readBuffer[i]);

                    if (readBuffer[i] == EndByte)

                        found = true;

            #endregion

            //字元轉換

            string readString = System.Text.Encoding.Default.GetString(_byteData.ToArray(), 0, _byteData.Count);

            //觸發整條記錄的處理

            if (DataReceived != null)

                DataReceived(new DataReceivedEventArgs(readString));

        /// 錯誤處理函數

        void comPort_ErrorReceived(object sender, SerialErrorReceivedEventArgs e)

            if (Error != null)

                Error(sender, e);

在資料的接收還原中,我們用到了

  EndByte的變量,這個變量是協定資料的結束字元,如果檢測到有這個字元的,就表明收到了一條完整的協定,可以把收到的位元組數組組裝成文本字元串,然後交給委托事件進行處理即可。

在外部的宿主程式中,當有資料收到的時候,輔助類會通知其對資料進行處理,如我們在宿主程式中綁定處理代碼如下所示。

        void serial_DataReceived(DataReceivedEventArgs e)

            this.txtReceived.Invoke(new MethodInvoker(delegate

                this.txtReceived.AppendText(e.DataReceived + Environment.NewLine);

            }));

這樣,一旦收到一條完整的協定,界面上就會在文本框中增加一行資料,如前面的圖所示

最後呈上該序列槽輔助類庫提供下載下傳,歡迎大家提供改善意見,多多交流。

<a href="http://files.cnblogs.com/wuhuacong/SerialPortUtil.rar">http://files.cnblogs.com/wuhuacong/SerialPortUtil.rar </a>