C#开发串口总括,并提炼串口接济类到公用类库中

开发C#连锁的品种有很多年了,一向没有接触串口的费用,目前是因为工作的内需,须要明白熟识对硬件串口的支付,通过对串口的深刻精通,串口也不再是如何秘密的事物,利用SerailPort组件,对串口的种种操作也丰盛的造福,由于自身总是喜欢把一部分常用的东西封装成可供重复利用的类库,因此,阅百家代码,提炼总计优化,把对串口的操作封装成一个公用的类库,应付经常的串口编程开发,也毕竟工作的一个阶段性总括吧。

先上图,通晓串口的一些中坚的东西,并渐渐介绍相关的知识。

图片 1 

微软在 .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
    /// </summary>
    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>
        /// 设置波特率
        /// </summary>
        public static void SetBauRateValues(ComboBox obj)
        {
            obj.Items.Clear();
            foreach (SerialPortBaudRates rate in Enum.GetValues(typeof(SerialPortBaudRates)))
            {
                obj.Items.Add(((int)rate).ToString());
            }
        }

        /// <summary>
        /// 设置数据位
        /// </summary>
        public static void SetDataBitsValues(ComboBox obj)
        {
            obj.Items.Clear();
            foreach (SerialPortDatabits databit in Enum.GetValues(typeof(SerialPortDatabits)))
            {
                obj.Items.Add(((int)databit).ToString());
            }
        }

        /// <summary>
        /// 设置校验位列表
        /// </summary>
        public static  void SetParityValues(ComboBox obj)
        {
            obj.Items.Clear();
            foreach (string str in Enum.GetNames(typeof(Parity)))
            {
                obj.Items.Add(str);
            }
        }

        /// <summary>
        /// 设置甘休位
        /// </summary>
        public static void SetStopBitValues(ComboBox obj)
        {
            obj.Items.Clear();
            foreach (string str in Enum.GetNames(typeof(StopBits)))
            {
                obj.Items.Add(str);
            } 
       }

这么我们在窗体界面代码中,绑定相关参数的数据源就很便利了,如下所示。

        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、
为了方便构造封装的窗口类,提供了八个不等体系参数的串口扶助类构造函数,一个方可选取枚举参数,一个使用字符串参数(最终转换为枚举参数对象),如下所示。使用枚举对象,不需要记住差别参数应该填写那多少个值,只须求从枚举中选拔即可,方便又直观。

        /// <summary>
        /// 参数构造函数(使用枚举参数构造)
        /// </summary>
        /// <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);
        }

        /// <summary>
        /// 参数构造函数(使用字符串参数构造)
        /// </summary>
        /// <param name=”baud”>波特率</param>
        /// <param name=”par”>奇偶校验位</param>
        /// <param name=”sBits”>停止位</param>
        /// <param name=”dBits”>数据位</param>
        /// <param name=”name”>串口号</param>
        public SerialPortUtil(string name, string baud, string par, string dBits, string sBits)
        {
            _portName = name;
            _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);

            comPort.DataReceived += new SerialDataReceivedEventHandler(comPort_DataReceived);
            comPort.ErrorReceived += new SerialErrorReceivedEventHandler(comPort_ErrorReceived);
       }

构造函数做好了,就很便利在实际上的窗体界面函数中结构串口实例了,如下使用代码所示:

        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、对串口数据的出殡以及串口的局地基本操作举办简单包装,方便协理类对串口举行相关操作。

        /// <summary>
        /// 端口是或不是业已开辟
        /// </summary>
        public bool IsOpen
        {
            get
            {
                return comPort.IsOpen;
            }
        }

        /// <summary>
        /// 打早先口
        /// </summary>
        /// <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();
        }

        /// <summary>
        /// 关闭端口
        /// </summary>
        public void ClosePort()
        {
            if (comPort.IsOpen) comPort.Close();
        }

        /// <summary>
        /// 舍弃来自串行驱动程序的接受和发送缓冲区的数码
        /// </summary>
        public void DiscardBuffer()
        {
            comPort.DiscardInBuffer();
            comPort.DiscardOutBuffer();
        }

        /// <summary>
        /// 写入数据
        /// </summary>
        /// <param name=”msg”></param>
        public void WriteData(string msg)
        {
            if (!(comPort.IsOpen)) comPort.Open();

            comPort.Write(msg);
        }

        /// <summary>
        /// 写入数据
        /// </summary>
        /// <param name=”msg”>写入端口的字节数组</param>
        public void WriteData(byte[] msg)
        {
            if (!(comPort.IsOpen)) comPort.Open();

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

        /// <summary>
        /// 写入数据
        /// </summary>
        /// <param name=”msg”>包罗要写入端口的字节数组</param>
        /// <param name=”offset”>参数从0字节上马的字节偏移量</param>
        /// <param name=”count”>要写入的字节数</param>
        public void WriteData(byte[] msg, int offset, int count)
        {
            if (!(comPort.IsOpen)) comPort.Open();

            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)然后构造一个多少接收和错误处理的轩然大波,如下所示

        /// <summary>
        /// 完整协议的笔录处总管件
        /// </summary>
        public event DataReceivedEventHandler DataReceived;
        public event SerialErrorReceivedEventHandler Error; 

3)在构造函数添加相关的事件处理,如下所示

        /// <summary>
        /// 参数构造函数(使用枚举参数构造)
        /// </summary>
        /// <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);
      }

 4)完毕对数码的接收和错误的处理 

        /// <summary>

        /// 为止符比特

        /// </summary>

        public byte EndByte = 0x23;//string End = “#”;

        /// <summary>
        /// 数据接收处理
        /// </summary>
        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));
            }
        }

        /// <summary>
        /// 错误处理函数
        /// </summary>
        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);
            }));
        }

 

这般,一旦接收一条完整的合计,界面上就会在文本框中追加一行数据,如前方的图所示

图片 2 

  

终极呈上该串口扶助类库提供下载,欢迎大家提供革新意见,多多沟通。

http://files.cnblogs.com/wuhuacong/SerialPortUtil.rar 

 

相关文章