显然,我们需要定义一个SerialPort对象。添加DataReceived事件响应收到数据,还有一个重点,我们需要记得设置NewLine属性哦。好想有的版本不设置的时候,WriteLine和Write效果一样。
至此,一个标准的串口调试助手就完成了。留下一个思考题,如果接收数据后,更新界面的时候,尚未操作完成,此时并发了关闭串口的操作。程序会如何呢?敬请阅读《C# 串口操作系列(2) -- 如何避免关闭串口偶尔软件死锁》。
第一篇文章我相信很多人不看都能做的出来,但是,用过微软SerialPort类的人,都遇到过这个尴尬,关闭串口的时候会让软件死锁。天哪,我可不是武断,算了。不要太绝对了。99.9%的人吧,都遇到过这个问题。我想只有一半的人真的解决了。另外一半的人就睁只眼闭只眼阿弥佗佛希望不要在客户那里出现这问题了。
你看到我的文章,就放心吧,这问题有救了。我们先回顾一下上一篇中的代码
- void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)
- {
-
- int n = comm.BytesToRead;
-
- byte[] buf = new byte[n];
-
- received_count += n;
-
- comm.Read(buf, 0, n);
-
- builder.Clear();
-
- this.Invoke((EventHandler)(delegate{...界面更新,略}));
- }
-
- private void buttonOpenClose_Click(object sender, EventArgs e)
- {
-
- if (comm.IsOpen)
- {
-
- comm.Close();
- }
- else
- {...}
- }
为什么会死锁呢,并发冲突。
我们要了解一下SerialPort的实现和串口通讯机制,在你打开串口的时候,SerialPort会创建一个监听线程ListenThread,在这个线程中,等待注册的串口中断,当收到中断后,会调用DataReceived事件。调用完成后,继续进入循环等待,直到串口被关闭退出线程。
我们的UI主线程如何做的呢,首先创建一个窗体,然后执行了Application.Run(窗体实例)。是这样把,这里的Application.Run就是创建了一个消息循环,循环的处理相关的消息。
这里我们就有了2个线程,UI主线程、串口监听线程。那么你在DataReceived处理数据的时候,就需要线程同步,避免并发冲突,什么是并发冲突?并发冲突就是2个或多个并行(至少看上去像)的线程运行的时候,多个线程共同的操作某一线程的资源,在时序上同时或没有按我们的预计顺序操作,这样就可能导致数据混乱无序或是彼此等待完成死锁软件。
而串口程序大多是后者。为什么呢,看看我们的例子中DataReceived做了什么?首先读取数据,然后就是调用this.Invoke方法更新UI了。这里Invoke的时候,监听线程将等待UI线程的标志,等到后,开始操作UI的资源,当操作完成之前,监听线程也就停在DataReceived方法的调用这里,如果这个时候。并发了关闭串口的操作会如何呢?SerialPort的Close方法,会首先尝试等待和监听线程一样的一个互斥体、临界区、或是事件(不确定.net用的哪种)。那这个同步对象什么时候释放呢?每次循环结束就释放,哦。循环为什么不结束呢?因为这一次的循环操作执行到DataReceived之后,执行了Invoke去更新界面了,那Invoke怎么又没有执行完成呢?看上去很简单的几行代码。虽然我没仔细研读过.net的Invoke原理,但我猜测是通过消息的方式来同步的,这也是为什么这么多的类,只有控件(窗体也是控件的一种,.net在概念上,颠覆了微软自己的概念,传统的win32编程,是说所有的控件都是个window,只是父窗体不同,表现形式不同,但都是基于系统消息队列的,.net出于更高的抽象,正好反过来了。呵呵)才有Invoke方法了。(委托自己的Invoke和这个不同)
我猜测控件/窗体的Invoke是SendMessage方式实现的,那么发送消息后就会等待消息循环来处理消息了。如果你直接去关闭串口了。你点击按钮本身也会被转换成消息WM_CLICK,消息循环在处理按钮的WM_CLICK时候,调用你按钮的OnClick方法,进而触发调用你的ButtonClose_Click事件,这都是同步调用的,你的主线程,处理消息的过程,停在了这个Click事件,而你的Click事件又去调用了SerialPort的Close方法,Close方法又因为和串口监听线程的同步信号量关联在一起需要等待一次的while结束,而这个while循环中调用了DataReceived方法,这个方法中调用了Invoke,也就是发送了消息到消息队列等待结果,但消息循环正在处理你的关闭按钮事件等待退出。
实在太复杂了,这个情况下,你想要真的关闭串口成功,就需要while中的DataReceived方法调用结束释放同步信号,就需要执行完Invoke,就需要执行消息循环,幸运的是,我们真的有办法执行消息循环来打破僵局。Application.DoEvents()。还好,不幸中的万幸。可是问题又来了,你能让Invoke结束,但你无法确定是否在你调用消息循环后,你的某一时刻不会再次并发,可能由于单cpu的串行操作模拟并行中,又把时间片先分给了优先级高的串口监听线程呢?是有可能的。所以,我们就需要一点方法来避免再次invoke窗体。优化后不会司机的例子如下,我们修改DataReceived方法,关闭方法,并定义2个标记Listening和Closing。
- 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();
- private long received_count = 0;
- private long send_count = 0;
- private bool Listening = false;
- private bool Closing = false;
- 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("9600");
-
- comm.NewLine = "/r/n";
- comm.RtsEnable = true;
-
- comm.DataReceived += comm_DataReceived;
- }
- void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)
- {
- if (Closing) return;
- try
- {
- Listening = true;
- int n = comm.BytesToRead;
- byte[] buf = new byte[n];
- received_count += n;
- comm.Read(buf, 0, n);
- builder.Clear();
-
- this.Invoke((EventHandler)(delegate
- {
-
- if (checkBoxHexView.Checked)
- {
-
- foreach (byte b in buf)
- {
- builder.Append(b.ToString("X2") + " ");
- }
- }
- else
- {
-
- builder.Append(Encoding.ASCII.GetString(buf));
- }
-
- this.txGet.AppendText(builder.ToString());
-
- labelGetCount.Text = "Get:" + received_count.ToString();
- }));
- }
- finally
- {
- Listening = false;
- }
- }
- private void buttonOpenClose_Click(object sender, EventArgs e)
- {
-
- if (comm.IsOpen)
- {
- Closing = true;
- while (Listening) Application.DoEvents();
-
- comm.Close();
- Closing = false;
- }
- else
- {
-
- comm.PortName = comboPortName.Text;
- comm.BaudRate = int.Parse(comboBaudrate.Text);
- try
- {
- comm.Open();
- }
- catch(Exception ex)
- {
-
- comm = new SerialPort();
-
- MessageBox.Show(ex.Message);
- }
- }
-
- buttonOpenClose.Text = comm.IsOpen ? "Close" : "Open";
- buttonSend.Enabled = comm.IsOpen;
- }
-
- private void checkBoxNewlineGet_CheckedChanged(object sender, EventArgs e)
- {
- txGet.WordWrap = checkBoxNewlineGet.Checked;
- }
- private void buttonSend_Click(object sender, EventArgs e)
- {
-
- int n = 0;
-
- if (checkBoxHexSend.Checked)
- {
-
- MatchCollection mc = Regex.Matches(txSend.Text, @"(?i)[/da-f]{2}");
- List<byte> buf = new List<byte>();
-
- foreach (Match m in mc)
- {
- buf.Add(byte.Parse(m.Value));
- }
-
- comm.Write(buf.ToArray(), 0, buf.Count);
-
- n = buf.Count;
- }
- else
- {
-
- if (checkBoxNewlineSend.Checked)
- {
- comm.WriteLine(txSend.Text);
- n = txSend.Text.Length + 2;
- }
- else
- {
- comm.Write(txSend.Text);
- n = txSend.Text.Length;
- }
- }
- send_count += n;
- labelSendCount.Text = "Send:" + send_count.ToString();
- }
- private void buttonReset_Click(object sender, EventArgs e)
- {
-
- send_count = received_count = 0;
- labelGetCount.Text = "Get:0";
- labelSendCount.Text = "Send:0";
- }
- }
- }
至此,不会再出现关闭死锁问题了。
希望这篇文章能解你的燃眉之急,非常高兴能与读者分享我层遇到,大多数人都遇到的这个问题。如果说的不明白,欢迎讨论。
后续的有关通讯程序底层设计的文章会讲述一个具有丰富扩展性,但有设计简介的万能通讯库,支持网络、蓝牙、串口通讯、并口通讯。但不要指望我都实现出来了,我只是设计出这个框架。
示例代码
//append by wuyazhe @2011-5-26
上面有一点疏漏,源自第一篇,结果到这里还是没修改,源码中有一行,需要修改一下。
//发送按钮中
buf.Add(byte.Parse(m.Value));
要修改为
buf.Add(byte.Parse(m.Value,System.Globalization.NumberStyles.HexNumber));
分类: 通讯类库设计
2010-05-27 09:54
11853人阅读
收藏
举报
我们的串口程序,除了通用的,进行串口监听收发的简单工具,大多都和下位机有关,这就需要关心我们的通讯协议如何缓存,分析,以及通知界面。
我们先说一下通讯协议。通讯协议就是通讯双方共同遵循的一套规则,定义协议的原则是尽可能的简单以提高传输率,尽可能的具有安全性保证数据传输完整正确。基于这2点规则,我们一个通讯协议应该是这样的:头+数据长度+数据正文+校验
例如:AA 44 05 01 02 03 04 05 EA
这里我假设的一条数据,协议如下:
数据头: AA 44
数据长度: 05
数据正文: 01 02 03 04 05
校验: EA
一般数据的校验,都会采用常用的方式,CRC16,CRC32,Xor。
有的数据安全要求高的,不允许丢包的,可能还要加入重发机制或是加入数据恢复算法,在校验后根据前面数据添加恢复字节流以恢复数据。我这里采用的是简单的异或校验,包含数据头的所有字节,依次异或得到的。
协议很简单,我也认为分析协议是很简单的事情,下面我们就如何分析协议来实际的结合c#看一下。
er…再等等,在我们实际开始编码之前,还有一个规则需要了解,我们有了通讯协议,如何结合串口的协议来分析,需要关心什么呢?哦。一般就是4个问题:缓存收到的所有数据,找到一条完整数据,分析数据,界面通知。
如果分的更详细一点,缓存收到的所有数据,我们想到最高效的办法就是顺序表,也就是数组,但数组的操作比较复杂,当你使用完一条数据后,用过的需要移除;新数据如果过多的时候,缓存过大需要清理;数据搬移等等,很有可能一个不小心就会丢数据导致软件出些莫名其妙的小问题。个人建议,使用List<byte>,内部是数组方式实现,每次数据不足够的时候会扩容1倍,数据的增删改都已经做的很完善了。不会出现什么小问题。
找到一条完整数据,如何找到完整数据呢?就我们例子的这个协议,首先在缓存的数据中找AA 44,当我们找到后,探测后面的字节,发现是05,然后看缓存剩下的数据是否足够,不足够就不用判断,减少时间消耗,如果剩余数据>=6个(包含1个字节的校验),我们就算一个校验,看和最后的校验是否一致。
分析数据:鉴于网络的开放性,我无法确定读者对c#的了解程度,介绍一下,常用的方式就是BitConvert.ToInt32这一系列的方法,把连续的字节(和变量长度一样)读取并转换为对应的变量。c++下使用memcpy,或直接类型转换后进行值拷贝,vb6下使用CopyMemory这个api。
校验:前面说过了。完整性判断的时候需要和校验对比,大多系统都不太严格,不支持重发,所以数据错误就直接丢弃。导致数据错误的原因很多,比如电磁干扰导致数据不完整或错误、硬件驱动效率不够导致数据丢失、我们的软件缓存出错等。这些软件因素数据系统错误,需要修改,但是电磁干扰么,有这个可能的。虽然很少。
其实我知道,就算是我,看别人的博客也是,喜欢看图片,看代码,文字性的东西,一看就头大。那我接下来贴出基于上一篇文章的改进版本,支持协议分析(协议不能配置,可配置的协议不是我们讨论的范畴。可以看看有DFA(确定性有限状态机))
我们修改一下界面,以便能显示收到后分析的数据
![红色部分是新增的](http://img.e-com-net.com/image/product/4a26c8cbd01c4696b1127e888c969927.png)
代码如下:
- 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();
- private long received_count = 0;
- private long send_count = 0;
- private bool Listening = false;
- private bool Closing = false;
- private List<byte> buffer = new List<byte>(4096);
- private byte[] binary_data_1 = new byte[9];
- 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");
-
- comm.NewLine = "/r/n";
- comm.RtsEnable = true;
-
- comm.DataReceived += comm_DataReceived;
- }
- void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)
- {
- if (Closing) return;
- try
- {
- Listening = true;
- int n = comm.BytesToRead;
- byte[] buf = new byte[n];
- received_count += n;
- comm.Read(buf, 0, n);
-
-
- bool data_1_catched = false;
-
- buffer.AddRange(buf);
-
- while (buffer.Count >= 4)
- {
-
-
- if (buffer[0] == 0xAA && buffer[1] == 0x44)
- {
-
-
- int len = buffer[2];
-
-
- if (buffer.Count < len + 4) break;
-
-
-
- byte checksum = 0;
- for (int i = 0; i < len + 3; i++)
- {
- checksum ^= buffer[i];
- }
- if (checksum != buffer[len + 3])
- {
- buffer.RemoveRange(0, len + 4);
- continue;
- }
-
-
-
-
- buffer.CopyTo(0, binary_data_1, 0, len + 4);
- data_1_catched = true;
- buffer.RemoveRange(0, len + 4);
- }
- else
- {
-
- buffer.RemoveAt(0);
- }
- }
-
- if (data_1_catched)
- {
-
- 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; }));
- }
-
-
-
-
- builder.Clear();
-
- this.Invoke((EventHandler)(delegate
- {
-
- if (checkBoxHexView.Checked)
- {
-
- foreach (byte b in buf)
- {
- builder.Append(b.ToString("X2") + " ");
- }
- }
- else
- {
-
- builder.Append(Encoding.ASCII.GetString(buf));
- }
-
- this.txGet.AppendText(builder.ToString());
-
- labelGetCount.Text = "Get:" + received_count.ToString();
- }));
- }
- finally
- {
- Listening = false;
- }
- }
- private void buttonOpenClose_Click(object sender, EventArgs e)
- {
-
- if (comm.IsOpen)
- {
- Closing = true;
- while (Listening) Application.DoEvents();
-
- comm.Close();
- }
- else
- {
-
- comm.PortName = comboPortName.Text;
- comm.BaudRate = int.Parse(comboBaudrate.Text);
- try
- {
- comm.Open();
- }
- catch(Exception ex)
- {
-
- comm = new SerialPort();
-
- MessageBox.Show(ex.Message);
- }
- }
-
- buttonOpenClose.Text = comm.IsOpen ? "Close" : "Open";
- buttonSend.Enabled = comm.IsOpen;
- }
-
- private void checkBoxNewlineGet_CheckedChanged(object sender, EventArgs e)
- {
- txGet.WordWrap = checkBoxNewlineGet.Checked;
- }
- private void buttonSend_Click(object sender, EventArgs e)
- {
-
- int n = 0;
-
- if (checkBoxHexSend.Checked)
- {
-
- MatchCollection mc = Regex.Matches(txSend.Text, @"(?i)[/da-f]{2}");
- List<byte> buf = new List<byte>();
-
- foreach (Match m in mc)
- {
- buf.Add(byte.Parse(m.Value, System.Globalization.NumberStyles.HexNumber));
- }
-
- comm.Write(buf.ToArray(), 0, buf.Count);
-
- n = buf.Count;
- }
- else
- {
-
- if (checkBoxNewlineSend.Checked)
- {
- comm.WriteLine(txSend.Text);
- n = txSend.Text.Length + 2;
- }
- else
- {
- comm.Write(txSend.Text);
- n = txSend.Text.Length;
- }
- }
- send_count += n;
- labelSendCount.Text = "Send:" + send_count.ToString();
- }
- private void buttonReset_Click(object sender, EventArgs e)
- {
-
- send_count = received_count = 0;
- labelGetCount.Text = "Get:0";
- labelSendCount.Text = "Send:0";
- }
- }
- }
至此,你只要按这个协议格式发送数据到软件打开的串口。就能在数据的data标签显示出你的数据内容,我们现在是直接显示为:
01 02 03 04 05
也就是数据段内容。
运行截图:
![请注意红色部分](http://img.e-com-net.com/image/product/dc0fc52f767348f7abe486e64a149712.png)
发送模拟数据的界面,使用通用工具SSCOMM32.exe
![sscomm32.exe 发送模拟数据的界面](http://img.e-com-net.com/image/product/1dbad22ec7f6421d8dd46ede12b6e95c.png)
我们在回顾一下,一般二进制格式数据就是这样分析,分析数据长度是否足够,找到数据头,数据长度,校验,然后分析。
分析方式很多。结合各自实际情况操作,可以使用序列化方式,但是wince不支持,也可以用BitConvert方式将连续的字节读取为某个类型的变量。
希望看到这里,能给你带来帮助,欢迎大家和我讨论,希望经验丰富的朋友不吝赐教。上一篇中,有朋友说用BeginInvoke可以避免死锁问题,我暂时没有线,没有测试成功,改天测试后再公布结果。
DataReceived事件中,最高效的做法是指缓存数据,然后异步的去分析数据。但是,这样较复杂,在效率要求不是很高的情况下(大多数情况),可以在DataReceived事件中缓存数据后,立刻进行数据完整性检查,有效性检查,分析数据,以及更新界面。但这么做有一个隐患,底层串口操作的效率依赖于数据分析和界面更新,任何一个环节频繁耗时过长,都会造成数据的堆积。文章只假设都不拖时间的情况。
谢谢观赏,通讯协议分析系列,未完待续……