• C# 串口二進(jìn)制協(xié)議數(shù)據(jù)解析范例

    2018/12/26??????點(diǎn)擊:
    我們先說一下通訊協(xié)議。通訊協(xié)議就是通訊雙方共同遵循的一套規(guī)則,定義協(xié)議的原則是盡可能的簡(jiǎn)單以提高傳輸率,盡可能的具有安全性保證數(shù)據(jù)傳輸完整正確?;谶@2點(diǎn)規(guī)則,我們一個(gè)通訊協(xié)議應(yīng)該是這樣的:頭+數(shù)據(jù)長(zhǎng)度+數(shù)據(jù)正文+校驗(yàn)
        例如:AA 44 05 01 02 03 04 05 EA
        這里我假設(shè)的一條數(shù)據(jù),協(xié)議如下:
        數(shù)據(jù)頭:     AA 44
        數(shù)據(jù)長(zhǎng)度: 05
        數(shù)據(jù)正文: 01 02 03 04 05
        校驗(yàn):       EA
        一般數(shù)據(jù)的校驗(yàn),都會(huì)采用常用的方式,CRC16,CRC32,Xor。
        有的數(shù)據(jù)安全要求高的,不允許丟包的,可能還要加入重發(fā)機(jī)制或是加入數(shù)據(jù)恢復(fù)算法,在校驗(yàn)后根據(jù)前面數(shù)據(jù)添加恢復(fù)字節(jié)流以恢復(fù)數(shù)據(jù)。我這里采用的是簡(jiǎn)單的異或校驗(yàn),包含數(shù)據(jù)頭的所有字節(jié),依次異或得到的。
        協(xié)議很簡(jiǎn)單,我也認(rèn)為分析協(xié)議是很簡(jiǎn)單的事情,下面我們就如何分析協(xié)議來實(shí)際的結(jié)合c#看一下。
        在我們實(shí)際開始編碼之前,還有一個(gè)規(guī)則需要了解,我們有了通訊協(xié)議,如何結(jié)合串口的協(xié)議來分析,需要關(guān)心什么呢?哦。一般就是4個(gè)問題:緩存收到的所有數(shù)據(jù),找到一條完整數(shù)據(jù),分析數(shù)據(jù),界面通知。
        如果分的更詳細(xì)一點(diǎn),緩存收到的所有數(shù)據(jù),我們想到高效的辦法就是順序表,也就是數(shù)組,但數(shù)組的操作比較復(fù)雜,當(dāng)你使用完一條數(shù)據(jù)后,用過的需要移除;新數(shù)據(jù)如果過多的時(shí)候,緩存過大需要清理;數(shù)據(jù)搬移等等,很有可能一個(gè)不小心就會(huì)丟數(shù)據(jù)導(dǎo)致軟件出些莫名其妙的小問題。個(gè)人建議,使用List,內(nèi)部是數(shù)組方式實(shí)現(xiàn),每次數(shù)據(jù)不足夠的時(shí)候會(huì)擴(kuò)容1倍,數(shù)據(jù)的增刪改都已經(jīng)做的很完善了。不會(huì)出現(xiàn)什么小問題。
        找到一條完整數(shù)據(jù),如何找到完整數(shù)據(jù)呢?就我們例子的這個(gè)協(xié)議,首先在緩存的數(shù)據(jù)中找AA 44,當(dāng)我們找到后,探測(cè)后面的字節(jié),發(fā)現(xiàn)是05,然后看緩存剩下的數(shù)據(jù)是否足夠,不足夠就不用判斷,減少時(shí)間消耗,如果剩余數(shù)據(jù)>=6個(gè)(包含1個(gè)字節(jié)的校驗(yàn)),我們就算一個(gè)校驗(yàn),看和*后的校驗(yàn)是否一致。
        分析數(shù)據(jù):鑒于網(wǎng)絡(luò)的開放性,我無法確定讀者對(duì)c#的了解程度,介紹一下,常用的方式就是BitConvert.ToInt32這一系列的方法,把連續(xù)的字節(jié)(和變量長(zhǎng)度一樣)讀取并轉(zhuǎn)換為對(duì)應(yīng)的變量。c++下使用memcpy,或直接類型轉(zhuǎn)換后進(jìn)行值拷貝,vb6下使用CopyMemory這個(gè)api。
        校驗(yàn):前面說過了。完整性判斷的時(shí)候需要和校驗(yàn)對(duì)比,大多系統(tǒng)都不太嚴(yán)格,不支持重發(fā),所以數(shù)據(jù)錯(cuò)誤就直接丟棄。導(dǎo)致數(shù)據(jù)錯(cuò)誤的原因很多,比如電磁干擾導(dǎo)致數(shù)據(jù)不完整或錯(cuò)誤、硬件驅(qū)動(dòng)效率不夠?qū)е聰?shù)據(jù)丟失、我們的軟件緩存出錯(cuò)等。這些軟件因素?cái)?shù)據(jù)系統(tǒng)錯(cuò)誤,需要修改,但是電磁干擾么,有這個(gè)可能的。雖然很少。
       下面是支持協(xié)議分析(協(xié)議不能配置,可配置的協(xié)議不是我們討論的范疇??梢钥纯从蠨FA(確定性有限狀態(tài)機(jī)))
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Data;
    using System.Drawing;
    using System.Linq;
    using System.Text;
    using System.Windows.Forms;
    using System.IO.Ports;
    using System.Text.RegularExpressions;
    namespace SerialportSample
    {
        public partial class SerialportSampleForm : Form
        {
            private SerialPort comm = new SerialPort();
            private StringBuilder builder = new StringBuilder();//避免在事件處理方法中反復(fù)的創(chuàng)建,定義到外面。
            private long received_count = 0;//接收計(jì)數(shù)
            private long send_count = 0;//發(fā)送計(jì)數(shù)
            private bool Listening = false;//是否沒有執(zhí)行完invoke相關(guān)操作
            private bool Closing = false;//是否正在關(guān)閉串口,執(zhí)行Application.DoEvents,并阻止再次invoke
            private Listbuffer = new List(4096);//默認(rèn)分配1頁(yè)內(nèi)存,并始終限制不允許超過
            private byte[] binary_data_1 = new byte[9];//AA 44 05 01 02 03 04 05 EA
            public SerialportSampleForm()
            {
                InitializeComponent();
            }
            //窗體初始化
            private void Form1_Load(object sender, EventArgs e)
            {
                //初始化下拉串口名稱列表框
                string[] ports = SerialPort.GetPortNames();
                Array.Sort(ports);
                comboPortName.Items.AddRange(ports);
                comboPortName.SelectedIndex = comboPortName.Items.Count > 0 ? 0 : -1;
                comboBaudrate.SelectedIndex = comboBaudrate.Items.IndexOf("19200");
                //初始化SerialPort對(duì)象
                comm.NewLine = "/r/n";
                comm.RtsEnable = true;//根據(jù)實(shí)際情況吧。
                //添加事件注冊(cè)
                comm.DataReceived += comm_DataReceived;
            }
            void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)
            {
                if (Closing) return;//如果正在關(guān)閉,忽略操作,直接返回,盡快的完成串口監(jiān)聽線程的一次循環(huán)
                try
                {
                    Listening = true;//設(shè)置標(biāo)記,說明我已經(jīng)開始處理數(shù)據(jù),一會(huì)兒要使用系統(tǒng)UI的。
                    int n = comm.BytesToRead;//先記錄下來,避免某種原因,人為的原因,操作幾次之間時(shí)間長(zhǎng),緩存不一致
                    byte[] buf = new byte[n];//聲明一個(gè)臨時(shí)數(shù)組存儲(chǔ)當(dāng)前來的串口數(shù)據(jù)
                    received_count += n;//增加接收計(jì)數(shù)
                    comm.Read(buf, 0, n);//讀取緩沖數(shù)據(jù)
                    /////////////////////////////////////////////////////////////////////////////////////////////////////////////
                    //<協(xié)議解析>
                    bool data_1_catched = false;//緩存記錄數(shù)據(jù)是否捕獲到
                    //1.緩存數(shù)據(jù)
                    buffer.AddRange(buf);
                    //2.完整性判斷
                    while (buffer.Count >= 4)//至少要包含頭(2字節(jié))+長(zhǎng)度(1字節(jié))+校驗(yàn)(1字節(jié))
                    {
                        //請(qǐng)不要擔(dān)心使用>=,因?yàn)?gt;=已經(jīng)和>,<,=一樣,是獨(dú)立操作符,并不是解析成>和=2個(gè)符號(hào)
                        //2.1 查找數(shù)據(jù)頭
                        if (buffer[0] == 0xAA && buffer[1] == 0x44)
                        {
                            //2.2 探測(cè)緩存數(shù)據(jù)是否有一條數(shù)據(jù)的字節(jié),如果不夠,就不用費(fèi)勁的做其他驗(yàn)證了
                            //前面已經(jīng)限定了剩余長(zhǎng)度>=4,那我們這里一定能訪問到buffer[2]這個(gè)長(zhǎng)度
                            int len = buffer[2];//數(shù)據(jù)長(zhǎng)度
                            //數(shù)據(jù)完整判斷第一步,長(zhǎng)度是否足夠
                            //len是數(shù)據(jù)段長(zhǎng)度,4個(gè)字節(jié)是while行注釋的3部分長(zhǎng)度
                            if (buffer.Count < len + 4) break;//數(shù)據(jù)不夠的時(shí)候什么都不做
                            //這里確保數(shù)據(jù)長(zhǎng)度足夠,數(shù)據(jù)頭標(biāo)志找到,我們開始計(jì)算校驗(yàn)
                            //2.3 校驗(yàn)數(shù)據(jù),確認(rèn)數(shù)據(jù)正確
                            //異或校驗(yàn),逐個(gè)字節(jié)異或得到校驗(yàn)碼
                            byte checksum = 0;
                            for (int i = 0; i < len + 3; i++)//len+3表示校驗(yàn)之前的位置
                            {
                                checksum ^= buffer[i];
                            }
                            if (checksum != buffer[len + 3]) //如果數(shù)據(jù)校驗(yàn)失敗,丟棄這一包數(shù)據(jù)
                            {
                                buffer.RemoveRange(0, len + 4);//從緩存中刪除錯(cuò)誤數(shù)據(jù)
                                continue;//繼續(xù)下一次循環(huán)
                            }
                            //至此,已經(jīng)被找到了一條完整數(shù)據(jù)。我們將數(shù)據(jù)直接分析,或是緩存起來一起分析
                            //我們這里采用的辦法是緩存一次,好處就是如果你某種原因,數(shù)據(jù)堆積在緩存buffer中
                            //已經(jīng)很多了,那你需要循環(huán)的找到*后一組,只分析*新數(shù)據(jù),過往數(shù)據(jù)你已經(jīng)處理不及時(shí)
                            //了,就不要浪費(fèi)更多時(shí)間了,這也是考慮到系統(tǒng)負(fù)載能夠降低。
                            buffer.CopyTo(0, binary_data_1, 0, len + 4);//復(fù)制一條完整數(shù)據(jù)到具體的數(shù)據(jù)緩存
                            data_1_catched = true;
                            buffer.RemoveRange(0, len + 4);//正確分析一條數(shù)據(jù),從緩存中移除數(shù)據(jù)。
                        }
                        else
                        {
                            //這里是很重要的,如果數(shù)據(jù)開始不是頭,則刪除數(shù)據(jù)
                            buffer.RemoveAt(0);
                        }
                    }
                    //分析數(shù)據(jù)
                    if (data_1_catched)
                    {
                        //我們的數(shù)據(jù)都是定好格式的,所以當(dāng)我們找到分析出的數(shù)據(jù)1,就知道固定位置一定是這些數(shù)據(jù),我們只要顯示就可以了
                        string data = binary_data_1[3].ToString("X2") + " " + binary_data_1[4].ToString("X2") + " " +
                            binary_data_1[5].ToString("X2") + " " + binary_data_1[6].ToString("X2") + " " +
                            binary_data_1[7].ToString("X2");
                        //更新界面
                        this.Invoke((EventHandler)(delegate { txData.Text = data; }));
                    }
                    //如果需要?jiǎng)e的協(xié)議,只要擴(kuò)展這個(gè)data_n_catched就可以了。往往我們協(xié)議多的情況下,還會(huì)包含數(shù)據(jù)編號(hào),給來的數(shù)據(jù)進(jìn)行
                    //編號(hào),協(xié)議優(yōu)化后就是: 頭+編號(hào)+長(zhǎng)度+數(shù)據(jù)+校驗(yàn)
                    //
                    /////////////////////////////////////////////////////////////////////////////////////////////////////////////
                    builder.Clear();//清除字符串構(gòu)造器的內(nèi)容
                    //因?yàn)橐L問ui資源,所以需要使用invoke方式同步ui。
                    this.Invoke((EventHandler)(delegate
                    {
                        //判斷是否是顯示為16禁止
                        if (checkBoxHexView.Checked)
                        {
                            //依次的拼接出16進(jìn)制字符串
                            foreach (byte b in buf)
                            {
                                builder.Append(b.ToString("X2") + " ");
                            }
                        }
                        else
                        {
                            //直接按ASCII規(guī)則轉(zhuǎn)換成字符串
                            builder.Append(Encoding.ASCII.GetString(buf));
                        }
                        //追加的形式添加到文本框末端,并滾動(dòng)到*后。
                        this.txGet.AppendText(builder.ToString());
                        //修改接收計(jì)數(shù)
                        labelGetCount.Text = "Get:" + received_count.ToString();
                    }));
                }
                finally
                {
                    Listening = false;//我用完了,ui可以關(guān)閉串口了。
                }
            }
            private void buttonOpenClose_Click(object sender, EventArgs e)
            {
                //根據(jù)當(dāng)前串口對(duì)象,來判斷操作
                if (comm.IsOpen)
                {
                    Closing = true;
                    while (Listening) Application.DoEvents();
                    //打開時(shí)點(diǎn)擊,則關(guān)閉串口
                    comm.Close();
                }
                else
                {
                    //關(guān)閉時(shí)點(diǎn)擊,則設(shè)置好端口,波特率后打開
                    comm.PortName = comboPortName.Text;
                    comm.BaudRate = int.Parse(comboBaudrate.Text);
                    try
                    {
                        comm.Open();
                    }
                    catch(Exception ex)
                    {
                        //捕獲到異常信息,創(chuàng)建一個(gè)新的comm對(duì)象,之前的不能用了。
                        comm = new SerialPort();
                        //現(xiàn)實(shí)異常信息給客戶。
                        MessageBox.Show(ex.Message);
                    }
                }
                //設(shè)置按鈕的狀態(tài)
                buttonOpenClose.Text = comm.IsOpen ? "Close" : "Open";
                buttonSend.Enabled = comm.IsOpen;
            }
            //動(dòng)態(tài)的修改獲取文本框是否支持自動(dòng)換行。
            private void checkBoxNewlineGet_CheckedChanged(object sender, EventArgs e)
            {
                txGet.WordWrap = checkBoxNewlineGet.Checked;
            }
            private void buttonSend_Click(object sender, EventArgs e)
            {
                //定義一個(gè)變量,記錄發(fā)送了幾個(gè)字節(jié)
                int n = 0;
                //16進(jìn)制發(fā)送
                if (checkBoxHexSend.Checked)
                {
                    //我們不管規(guī)則了。如果寫錯(cuò)了一些,我們?cè)试S的,只用正則得到有效的十六進(jìn)制數(shù)
                    MatchCollection mc = Regex.Matches(txSend.Text, @"(?i)[/da-f]{2}");
                    Listbuf = new List();//填充到這個(gè)臨時(shí)列表中
                    //依次添加到列表中
                    foreach (Match m in mc)
                    {
                        buf.Add(byte.Parse(m.Value, System.Globalization.NumberStyles.HexNumber));
                    }
                    //轉(zhuǎn)換列表為數(shù)組后發(fā)送
                    comm.Write(buf.ToArray(), 0, buf.Count);
                    //記錄發(fā)送的字節(jié)數(shù)
                    n = buf.Count;
                }
                else//ascii編碼直接發(fā)送
                {
                    //包含換行符
                    if (checkBoxNewlineSend.Checked)
                    {
                        comm.WriteLine(txSend.Text);
                        n = txSend.Text.Length + 2;
                    }
                    else//不包含換行符
                    {
                        comm.Write(txSend.Text);
                        n = txSend.Text.Length;
                    }
                }
                send_count += n;//累加發(fā)送字節(jié)數(shù)
                labelSendCount.Text = "Send:" + send_count.ToString();//更新界面
            }
            private void buttonReset_Click(object sender, EventArgs e)
            {
                //復(fù)位接受和發(fā)送的字節(jié)數(shù)計(jì)數(shù)器并更新界面。
                send_count = received_count = 0;
                labelGetCount.Text = "Get:0";
                labelSendCount.Text = "Send:0";
            }
        }
    }

    至此,只要按這個(gè)協(xié)議格式發(fā)送數(shù)據(jù)到軟件打開的串口,就能在數(shù)據(jù)的data標(biāo)簽顯示出你的數(shù)據(jù)內(nèi)容,我們現(xiàn)在是直接顯示為:

    01 02 03 04 05

    也就是實(shí)際的數(shù)據(jù)段內(nèi)容。

    我們?cè)诨仡櫼幌?,一般二進(jìn)制格式數(shù)據(jù)就是這樣分析,分析數(shù)據(jù)長(zhǎng)度是否足夠,找到數(shù)據(jù)頭,數(shù)據(jù)長(zhǎng)度,校驗(yàn),然后分析。
    分析方式很多。結(jié)合各自實(shí)際情況操作,可以使用序列化方式,但是wince不支持,也可以用BitConvert方式將連續(xù)的字節(jié)讀取為某個(gè)類型的變量。
    DataReceived事件中,*高效的做法是指緩存數(shù)據(jù),然后異步的去分析數(shù)據(jù)。但是,這樣較復(fù)雜,在效率要求不是很高的情況下(大多數(shù)情況),可以在DataReceived事件中緩存數(shù)據(jù)后,立刻進(jìn)行數(shù)據(jù)完整性檢查,有效性檢查,分析數(shù)據(jù),以及更新界面。但這么做有一個(gè)隱患,底層串口操作的效率依賴于數(shù)據(jù)分析和界面更新,任何一個(gè)環(huán)節(jié)頻繁耗時(shí)過長(zhǎng),都會(huì)造成數(shù)據(jù)的堆積。本文只假設(shè)都不拖時(shí)間的情況。各位小朋友, 希望本文對(duì)您有幫助, 感謝關(guān)注WISEGLOVE!