串口编程（SerialPort类）

近期由于项目中用到串口编程，而以前有从未使用过，查阅相关资料，先将串口编程整个过程整理如下，以备不时之需。

SerialPort类简述

此类位于System.IO.Ports命名空间下。用于控制串行端口文件资源，此类提供同步I/O和事件驱动的I/O、对管脚和中断状态的访问以及对串行驱动程序的访问。

SerialPort类支持一下编码：ASCIIEncoding、UTF8Encoding、UnicodeEncoding、UTF32Encoding以及mscorlib.dll中定义的代码页小于50000或者为54936的所有编码。（摘自MSDN，具体网址）

SerialPort常用属性

• BaudRate  获取或设置串行波特率
• BreakState 获取或设置中断信号状态
• BytesToRead 获取接收缓冲区中数据的字节数
• BytesToWrite 获取发送缓冲区中数据的自己数
• DataBits 获取或设置每个字节的标准数据位长度（默认为8）
• DtrEnable 获取或设置一个值，该值指示Null字节在端口和接收缓冲区之间传输时是否被忽略
• Encoding 获取或设置传输前后的文本转换的字节编码
• IsOpen 获取一个值，该值指示SerialPort对象的打开或关闭状态
• NewLine 获取或设置用于解释ReadLine和WriteLine方法调用结束的值
• Parity 获取或设置奇偶校验检查协议
• PortName 获取或设置通信端口，包括但不限于所有可用的COM端口
• ReadBufferSize 获取或设置SerialPort输入缓冲区的大小
• ReadTimeOut 获取或设置读取操作未完成时发生超时之前的毫秒数
• ReceivedBytesThreshold 获取或设置DataReceived事件发生前内部输入缓冲区中的字节数
• RtsEnable 获取或设置一个值，该值指示在串行通信中是否启用请求发送RTS信号
• StopBits 获取或设置每个字节的标准停止位数
• WriteBufferSize 获取或设置串行端口输出缓冲区的大小
• WriteTimeout 获取或设置写入操作未完成时发生超时之前的毫秒数

SerialPort的主要方法

• Close 关闭端口连接，将IsOpen属性设置成为false，并释放内部Stream对象
• Dispose 释放SerialPort对象使用的非托管资源
• GetPortNames 获取当前计算机的串行端口名称数组
• Open 打开一个新的串行端口连接
• Read 从SerialPort输入缓冲区中读取
• ReadByte 从SerialPort输入缓冲区中同步读取一个字节
• ReadChar 从SerialPort输入缓冲区中同步读取一个字符
• ReadExisting 在编码的基础上，读取SerialPort对象的流和输入缓冲区中所有立即可用的字节
• ReadLine 一直读取到输入缓冲区中的NewLine值
• ReadTo 一直读取到输入缓冲区中指定value的字符串
• Write 将数据写入到串行端口输出缓冲区
• WriteLine 将指定的字符串和NewLine值写入到输出缓冲区
• DataReceived 表示将处理SerialPort对象的数据接收事件的方法
• ErrorReceived 表示处理Serialport对象的错误事件的方法

SerialPort类编程实例讲解

01.using System;  
02.using System.Collections.Generic;  
03.using System.ComponentModel;  
04.using System.Data;  
05.using System.Drawing;  
06.using System.Linq;  
07.using System.Text;  
08.using System.Windows.Forms;  
09.using System.IO.Ports;  
10.using System.Text.RegularExpressions;  
11.namespace SerialportSample  
12.{  
13.    public partial class SerialportSampleForm : Form  
14.    {  
15.        private SerialPort comm = new SerialPort();  
16.        private StringBuilder builder = new StringBuilder();//避免在事件处理方法中反复的创建，定义到外面。  
17.        private long received_count = 0;//接收计数  
18.        private long send_count = 0;//发送计数  
19.        public SerialportSampleForm()  
20.        {  
21.            InitializeComponent();  
22.        }  
23.        //窗体初始化  
24.        private void Form1_Load(object sender, EventArgs e)  
25.        {  
26.            //初始化下拉串口名称列表框  
27.            string[] ports = SerialPort.GetPortNames();  
28.            Array.Sort(ports);  
29.            comboPortName.Items.AddRange(ports);  
30.            comboPortName.SelectedIndex = comboPortName.Items.Count > 0 ? 0 : -1;  
31.            comboBaudrate.SelectedIndex = comboBaudrate.Items.IndexOf("9600");  
32.            //初始化SerialPort对象  
33.            comm.NewLine = "/r/n";  
34.            comm.RtsEnable = true;//根据实际情况吧。  
35.            //添加事件注册  
36.            comm.DataReceived += comm_DataReceived;  
37.        }  
38.        void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)  
39.        {  
40.            int n = comm.BytesToRead;//先记录下来，避免某种原因，人为的原因，操作几次之间时间长，缓存不一致  
41.            byte[] buf = new byte[n];//声明一个临时数组存储当前来的串口数据  
42.            received_count += n;//增加接收计数  
43.            comm.Read(buf, 0, n);//读取缓冲数据  
44.            builder.Clear();//清除字符串构造器的内容  
45.            //因为要访问ui资源，所以需要使用invoke方式同步ui。  
46.            this.Invoke((EventHandler)(delegate  
47.            {  
48.                //判断是否是显示为16禁止  
49.                if (checkBoxHexView.Checked)  
50.                {  
51.                    //依次的拼接出16进制字符串  
52.                    foreach (byte b in buf)  
53.                    {  
54.                        builder.Append(b.ToString("X2") + " ");  
55.                    }  
56.                }  
57.                else  
58.                {  
59.                    //直接按ASCII规则转换成字符串  
60.                    builder.Append(Encoding.ASCII.GetString(buf));  
61.                }  
62.                //追加的形式添加到文本框末端，并滚动到最后。  
63.                this.txGet.AppendText(builder.ToString());  
64.                //修改接收计数  
65.                labelGetCount.Text = "Get:" + received_count.ToString();  
66.            }));  
67.        }  
68.        private void buttonOpenClose_Click(object sender, EventArgs e)  
69.        {  
70.            //根据当前串口对象，来判断操作  
71.            if (comm.IsOpen)  
72.            {  
73.                //打开时点击，则关闭串口  
74.                comm.Close();  
75.            }  
76.            else  
77.            {  
78.                //关闭时点击，则设置好端口，波特率后打开  
79.                comm.PortName = comboPortName.Text;  
80.                comm.BaudRate = int.Parse(comboBaudrate.Text);  
81.                try  
82.                {  
83.                    comm.Open();  
84.                }  
85.                catch(Exception ex)  
86.                {  
87.                    //捕获到异常信息，创建一个新的comm对象，之前的不能用了。  
88.                    comm = new SerialPort();  
89.                    //现实异常信息给客户。  
90.                    MessageBox.Show(ex.Message);  
91.                }  
92.            }  
93.            //设置按钮的状态  
94.            buttonOpenClose.Text = comm.IsOpen ? "Close" : "Open";  
95.            buttonSend.Enabled = comm.IsOpen;  
96.        }  
97.        //动态的修改获取文本框是否支持自动换行。  
98.        private void checkBoxNewlineGet_CheckedChanged(object sender, EventArgs e)  
99.        {  
100.            txGet.WordWrap = checkBoxNewlineGet.Checked;  
101.        }  
102.        private void buttonSend_Click(object sender, EventArgs e)  
103.        {  
104.            //定义一个变量，记录发送了几个字节  
105.            int n = 0;  
106.            //16进制发送  
107.            if (checkBoxHexSend.Checked)  
108.            {  
109.                //我们不管规则了。如果写错了一些，我们允许的，只用正则得到有效的十六进制数  
110.                MatchCollection mc = Regex.Matches(txSend.Text, @"(?i)[/da-f]{2}");  
111.                List<byte> buf = new List<byte>();//填充到这个临时列表中  
112.                //依次添加到列表中  
113.                foreach (Match m in mc)  
114.                {  
115.                    buf.Add(byte.Parse(m.Value,System.Globalization.NumberStyles.HexNumber));116.                }  
117.                //转换列表为数组后发送  
118.                comm.Write(buf.ToArray(), 0, buf.Count);  
119.                //记录发送的字节数  
120.                n = buf.Count;  
121.            }  
122.            else//ascii编码直接发送  
123.            {  
124.                //包含换行符  
125.                if (checkBoxNewlineSend.Checked)  
126.                {  
127.                    comm.WriteLine(txSend.Text);  
128.                    n = txSend.Text.Length + 2;  
129.                }  
130.                else//不包含换行符  
131.                {  
132.                    comm.Write(txSend.Text);  
133.                    n = txSend.Text.Length;  
134.                }  
135.            }  
136.            send_count += n;//累加发送字节数  
137.            labelSendCount.Text = "Send:" + send_count.ToString();//更新界面  
138.        }  
139.        private void buttonReset_Click(object sender, EventArgs e)  
140.        {  
141.            //复位接受和发送的字节数计数器并更新界面。  
142.            send_count = received_count = 0;  
143.            labelGetCount.Text = "Get:0";  
144.            labelSendCount.Text = "Send:0";  
145.        }  
146.    }  
147.}  

代码段来自wuyazhe的C# 串口操作系列(1) -- 入门篇，一个标准的，简陋的串口例子一文，该文非常经典，适合入门，推荐阅读。

总结

一、进行串口通讯时，需要设置一些相关参数，可以通过设置SerialPort 类的属性来进行。串口属性主要包括

.PortName 串口名称，COM1, COM2等。
.BaudRate 波特率，也就是串口通讯的速度，进行串口通讯的双方其波特率需要相同，如果用PC连接其他非PC系统，一般地，波特率由非PC系统决定。
.Parity 奇偶校验。可以选取枚举Parity中的值
.DataBits 数据位
.StopBits 停止位，可以选取枚举StopBits中的值
.Handshake 握手方式，也就是数据流控制方式，可以选取枚举Handshake中的值

二、打开与关闭串口

在创建一个SerialPort 对象，设置串口属性后，可以通过 Open()方法打开串口。数据读写完成后，可以通过Close()方法关闭串口。
根据经验，对于有些系统，在打开串口后，还需要将RtsEnable设置为True，这样才能读写数据，否则不能正常读写数据。

三、DataReceived

SerialPort 提供了DataReceived事件。当有数据进入时，该事件被触发。该事件的触发由操作系统决定，当有数据到达时，该事件在辅助线程中被触发。辅助线程的优先级比较低，因此并不能确保每个字节的数据到达时，该事件都被触发。