C# 串口通讯

简介

串口是目前最常用的通讯接口之一,常用的标准接口有RS-232和RS-485,ModbusRTU通讯协议使用的一般也是串口。

Virtual Serial Port Driver是一款串口仿真软件,如果当前没有设备或者连接线,而又需要进行串口通讯测试,它将是你的得力助手。

以下为官网介绍:

Virtual COM Port Driver is a powerful technology designed specifically for those who develop, test, or debug serial port software and hardware. This solution will provide your system with as many virtual COM interfaces as you need.

If there are not enough physical COM ports or even if you don’t have a single real serial port on your computer, this dedicated software will come to the rescue. It will help you create pairs of virtual serial interfaces communicating via a virtual null-modem connection.

You can use Virtual Serial Port Driver as a standalone solution or integrate its advanced functionality into your own product.

本文将使用Virtual Serial Port Driver软件虚拟两个串口,并用C#实现串口通讯。

本文代码已上传至GitHub,项目地址如下:

https://github.com/XMNHCAS/SerialPortWPFDemo


软件下载

Virtual Serial Port Driver官网下载(如需汉化版,可以自行百度)

UartAssist串口调试助手(免安装免注册,提供了各种校验算法、生成报文等功能)

创建虚拟串口

打开Virtual Serial Port Driver,设定需要创建的端口号,点击添加按钮就可以创建出两个相连的虚拟串行端口,如下图所示:

 此时打开UartAssist串口调试助手,可以看到刚刚已经创建出来的虚拟串口。


搭建界面 

首先创建一个WPF项目,接着按照个人喜好设计界面,可参考下图:

XAML如下:

<!--左右布局-->
    <Grid Margin="10">
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="40*"/>
            <ColumnDefinition Width="60*"/>
        </Grid.ColumnDefinitions>
        
        <!--控制面板-->
        <GroupBox Header="控制面板" Grid.Column="0" Margin="10" Padding="10" >
            <Grid>
                <Grid.RowDefinitions>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                </Grid.RowDefinitions>
                <Grid.ColumnDefinitions>
                    <ColumnDefinition Width="40*"/>
                    <ColumnDefinition Width="70*"/>
                </Grid.ColumnDefinitions>
                <TextBlock Grid.Row="0" Grid.Column="0" VerticalAlignment="Center" Text="可用串口:"  />
                <ComboBox Grid.Row="0" Grid.Column="1" x:Name="cbxSerialPortList" ItemsSource="{Binding}" 
                          Margin="5" VerticalAlignment="Center" />

                <TextBlock  Grid.Row="1" Grid.Column="0" VerticalAlignment="Center" Text="连接状态:"/>
                <TextBlock x:Name="tbxStatus"  Grid.Row="1" Grid.Column="1" VerticalAlignment="Center" 
                           Margin="5,0,0,0"  Text="未连接" FontWeight="Bold"/>

                <TextBlock  Grid.Row="2" Grid.Column="0" VerticalAlignment="Center" Text="波特率:"/>
                <ComboBox Grid.Row="2" Grid.Column="1" x:Name="cbxBaudRate" ItemsSource="{Binding}" 
                          Margin="5" VerticalAlignment="Center" />

                <TextBlock Grid.Row="3" Grid.Column="0" VerticalAlignment="Center" Text="奇偶校验:"/>
                <ComboBox Grid.Row="3" Grid.Column="1" x:Name="cbxParity" ItemsSource="{Binding}" 
                          Margin="5" VerticalAlignment="Center" />

                <TextBlock Grid.Row="4" Grid.Column="0" VerticalAlignment="Center" Text="数据位:"/>
                <ComboBox Grid.Row="4" Grid.Column="1" x:Name="cbxDataBits" ItemsSource="{Binding}" 
                          Margin="5" VerticalAlignment="Center" />

                <TextBlock Grid.Row="5" Grid.Column="0" VerticalAlignment="Center" Text="停止位:"/>
                <ComboBox Grid.Row="5" Grid.Column="1" x:Name="cbxStopBits" ItemsSource="{Binding}" 
                          Margin="5" VerticalAlignment="Center" />
                <Button x:Name="btnSwitch" Grid.Row="6" Grid.Column="1" Content="打开串口" 
                        Margin="5" Click="btnSwitch_Click"/>
            </Grid>
        </GroupBox>

        <!--消息面板-->
        <Grid Grid.Column="1" Margin="10">
            <Grid.RowDefinitions>
                <RowDefinition Height="45*"/>
                <RowDefinition Height="55*"/>
            </Grid.RowDefinitions>

            <!--发送消息-->
            <GroupBox Grid.Row="0" Header="发送消息" Margin="0,10,0,0" Padding="5">
                <StackPanel VerticalAlignment="Center">
                    <Grid VerticalAlignment="Center" Margin="0,0,0,5">
                        <Grid.ColumnDefinitions>
                            <ColumnDefinition/>
                            <ColumnDefinition/>
                            <ColumnDefinition/>
                            <ColumnDefinition/>
                        </Grid.ColumnDefinitions>
                        <TextBlock Text="消息格式:" Grid.Column="0" VerticalAlignment="Center"/>
                        <ComboBox x:Name="cbxSendStatus" Grid.Column="1" ItemsSource="{Binding}"
                                  SelectionChanged="cbxSendStatus_SelectionChanged" Margin="0,0,5,0" />
                        <Button x:Name="btnClearSendText" Grid.Column="2" Content="清空" Margin="0,0,5,0" 
                                Click="btnClearSendText_Click"/>
                        <Button x:Name="btnSend" Grid.Column="3" Content="发送" Click="btnSend_Click"/>
                    </Grid>
                    <RichTextBox x:Name="rbxSendMsg" Height="40" Margin="0,0,0,5"/>
                </StackPanel>
            </GroupBox>

            <!--接收消息-->
            <GroupBox Grid.Row="1" Header="接收消息" Margin="0,10,0,0" Padding="5">
                <StackPanel VerticalAlignment="Center">
                    <RichTextBox x:Name="rbxReceiveMsg" Height="100"/>
                </StackPanel>
            </GroupBox>
        </Grid>
    </Grid>

SerialPort使用示例

SerialPort是C#提供的串行端口资源,位于System.IO.Ports,使用时需要引入此命名空间。通过此类可以很轻松地搭建串口通讯。

使用示例如下:

        //串口实例
        SerialPort serialPort = new SerialPort();

        /// <summary>
        /// 串口参数
        /// </summary>
        public void SetSerialPort()
        {
            //获取当前计算机所有的串行端口名
            string[] serialProtArray = SerialPort.GetPortNames();

            //端口名,如COM1
            serialPort.PortName = "COM1";

            //波特率
            serialPort.BaudRate = 9600;

            //奇偶校验
            serialPort.Parity = Parity.None;

            //数据位
            serialPort.DataBits = 8;

            //停止位
            serialPort.StopBits = StopBits.One;

            //串口接收数据事件
            serialPort.DataReceived += ReceiveDataMethod;
        }

        /// <summary>
        /// 打开串口
        /// </summary>
        public void Open()
        {
            //打开串口
            serialPort.Open();
        }

        /// <summary>
        /// 关闭串口
        /// </summary>
        public void Close()
        {
            serialPort.Close();
        }

        /// <summary>
        /// 发送数据
        /// </summary>
        /// <param name="data">要发送的数据</param>
        public void SendDataMethod(byte[] data)
        {
            //获取串口状态,true为已打开,false为未打开
            bool isOpen = serialPort.IsOpen;

            if (!isOpen)
            {
                Open();
            }

            //发送字节数组
            //参数1:包含要写入端口的数据的字节数组。
            //参数2:参数中从零开始的字节偏移量,从此处开始将字节复制到端口。
            //参数3:要写入的字节数。 
            serialPort.Write(data, 0, data.Length);
        }

        /// <summary>
        /// 发送数据
        /// </summary>
        /// <param name="data">要发送的数据</param>
        public void SendDataMethod(string data)
        {
            //获取串口状态,true为已打开,false为未打开
            bool isOpen = serialPort.IsOpen;

            if (!isOpen)
            {
                Open();
            }

            //直接发送字符串
            serialPort.Write(data);
        }

        /// <summary>
        /// 串口接收到数据触发此方法进行数据读取
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void ReceiveDataMethod(object sender, SerialDataReceivedEventArgs e)
        {
            //读取串口缓冲区的字节数据
            byte[] result = new byte[serialPort.BytesToRead];
            serialPort.Read(result, 0, serialPort.BytesToRead);
        }

具体实现示例

设置窗体:

        /// <summary>
        /// 窗体构造函数
        /// </summary>
        public MainWindow()
        {
            InitializeComponent();

            //获取串口列表
            cbxSerialPortList.DataContext = SerialPort.GetPortNames();
            //设置可选波特率
            cbxBaudRate.DataContext = new object[] { 9600, 19200 };
            //设置可选奇偶校验
            cbxParity.DataContext = new object[] { "None", "Odd", "Even", "Mark", "Space" };
            //设置可选数据位
            cbxDataBits.DataContext = new object[] { 5, 6, 7, 8 };
            //设置可选停止位
            cbxStopBits.DataContext = new object[] { 1, 1.5, 2 };
            //设置发送模式
            cbxSendStatus.DataContext = new object[] { "文本", "字节" };

            //设置默认选中项
            cbxSerialPortList.SelectedIndex = 0;
            cbxBaudRate.SelectedIndex = 0;
            cbxParity.SelectedIndex = 0;
            cbxDataBits.SelectedIndex = 3;
            cbxStopBits.SelectedIndex = 0;
            cbxSendStatus.SelectedIndex = 0;

            rbxReceiveMsg.Document.Blocks.Clear();
            btnSend.IsEnabled = false;

            //注册串口接收到数据事件的回调函数
            serialPort.DataReceived += GetReceiveMsg;
        }

串口开关事件:

 /// <summary>
        /// 打开或关闭串口
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnSwitch_Click(object sender, RoutedEventArgs e)
        {
            if (!serialPort.IsOpen)
            {
                //设定参数
                serialPort.PortName = cbxSerialPortList.SelectedItem.ToString();
                serialPort.BaudRate = (int)cbxBaudRate.SelectedItem;
                serialPort.Parity = GetSelectedParity();
                serialPort.DataBits = (int)cbxDataBits.SelectedItem;
                serialPort.StopBits = GetSelectedStopBits();

                try
                {
                    //打开串口
                    serialPort.Open();
                }
                catch (Exception)
                {
                    MessageBox.Show("无法打开此串口,请检查是否被占用");
                    return;
                }

                //切换文本
                tbxStatus.Text = "已连接";
                btnSwitch.Content = "关闭串口";

                //切换可用状态
                cbxSerialPortList.IsEnabled = false;
                cbxBaudRate.IsEnabled = false;
                cbxParity.IsEnabled = false;
                cbxDataBits.IsEnabled = false;
                cbxStopBits.IsEnabled = false;

                btnSend.IsEnabled = true;
            }
            else
            {
                if (serialPort != null)
                {
                    //关闭串口
                    serialPort.Close();
                }

                //切换文本
                tbxStatus.Text = "未连接";
                btnSwitch.Content = "打开串口";

                //切换可用状态
                cbxSerialPortList.IsEnabled = true;
                cbxBaudRate.IsEnabled = true;
                cbxParity.IsEnabled = true;
                cbxDataBits.IsEnabled = true;
                cbxStopBits.IsEnabled = true;

                btnSend.IsEnabled = false;
            }
        }

向串口发送数据:

        /// <summary>
        /// 发送数据
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnSend_Click(object sender, RoutedEventArgs e)
        {
            //获取RichTextBox上的文本
            string str = new TextRange(rbxSendMsg.Document.ContentStart, rbxSendMsg.Document.ContentEnd).Text;
            if (string.IsNullOrEmpty(str.Replace("\r\n", "")))
            {
                MessageBox.Show("未输入消息");
                return;
            }

            //判断读写模式
            if (sendText)
            {
                //发送字符串
                serialPort.Write(str);
            }
            else
            {
                str = str.Replace(" ", "").Replace("\r\n", "");

                //将输入的16进制字符串两两分割为字符串集合
                var strArr = Regex.Matches(str, ".{2}").Cast<Match>().Select(m => m.Value);

                //需要发送的字节数组
                byte[] data = new byte[strArr.Count()];
                
                //循环索引
                int temp = 0;

                //将字符串集合转换为字节数组
                foreach (string item in strArr)
                {
                    data[temp] = Convert.ToByte(item, 16);
                    temp++;
                }

                //发送字节
                serialPort.Write(data, 0, data.Length);
            }

            MessageBox.Show("发送成功");
        }

读取接收到的数据:

        /// <summary>
        /// 获取接收到的数据
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void GetReceiveMsg(object sender, SerialDataReceivedEventArgs e)
        {
            //读取串口缓冲区的字节数据
            byte[] result = new byte[serialPort.BytesToRead];
            serialPort.Read(result, 0, serialPort.BytesToRead);

            string str = $"{DateTime.Now}\n";

            //判断读写模式
            //将接收到的字节数组转换为指定的消息格式
            if (sendText)
            {
                str += $"{Encoding.UTF8.GetString(result)}";
            }
            else
            {
                for (int i = 0; i < result.Length; i++)
                {
                    str += $"{result[i].ToString("X2")} ";
                }
            }

            //在窗体中显示接收到的消息
            SetRecMsgRbx(str.Trim());
        }

需要注意串口接收到数据的时候触发的事件并不是主线程里面执行的,而是另开了一个新的线程,如果需要访问主线程并将数据在WPF窗口中显示,则需要通过委托的方式进行跨线程操作,如下所示:

        /// <summary>
        /// 为显示接收消息的富文本框添加文本
        /// </summary>
        /// <param name="str"></param>
        private void SetRecMsgRbx(string str)
        {
            rbxReceiveMsg.Dispatcher.BeginInvoke(new Action(() =>
            {
                Run run = new Run(str);
                Paragraph p = new Paragraph();
                p.Inlines.Add(run);
                rbxReceiveMsg.Document.Blocks.Add(p);
            }));
        }

完整示例

using System;
using System.Collections.Generic;
using System.IO.Ports;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Markup;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

namespace SerialPortWPF
{
    /// <summary>
    /// MainWindow.xaml 的交互逻辑
    /// </summary>
    public partial class MainWindow : Window
    {
        //串口实例
        SerialPort serialPort = new SerialPort();

        //是否发送文本
        bool sendText = true;

        /// <summary>
        /// 窗体构造函数
        /// </summary>
        public MainWindow()
        {
            InitializeComponent();

            //获取串口列表
            cbxSerialPortList.DataContext = SerialPort.GetPortNames();
            //设置可选波特率
            cbxBaudRate.DataContext = new object[] { 9600, 19200 };
            //设置可选奇偶校验
            cbxParity.DataContext = new object[] { "None", "Odd", "Even", "Mark", "Space" };
            //设置可选数据位
            cbxDataBits.DataContext = new object[] { 5, 6, 7, 8 };
            //设置可选停止位
            cbxStopBits.DataContext = new object[] { 1, 1.5, 2 };
            //设置发送模式
            cbxSendStatus.DataContext = new object[] { "文本", "字节" };

            //设置默认选中项
            cbxSerialPortList.SelectedIndex = 0;
            cbxBaudRate.SelectedIndex = 0;
            cbxParity.SelectedIndex = 0;
            cbxDataBits.SelectedIndex = 3;
            cbxStopBits.SelectedIndex = 0;
            cbxSendStatus.SelectedIndex = 0;

            rbxReceiveMsg.Document.Blocks.Clear();
            btnSend.IsEnabled = false;

            //注册串口接收到数据事件的回调函数
            serialPort.DataReceived += GetReceiveMsg;
        }

        /// <summary>
        /// 打开或关闭串口
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnSwitch_Click(object sender, RoutedEventArgs e)
        {
            if (!serialPort.IsOpen)
            {
                //设定参数
                serialPort.PortName = cbxSerialPortList.SelectedItem.ToString();
                serialPort.BaudRate = (int)cbxBaudRate.SelectedItem;
                serialPort.Parity = GetSelectedParity();
                serialPort.DataBits = (int)cbxDataBits.SelectedItem;
                serialPort.StopBits = GetSelectedStopBits();

                try
                {
                    //打开串口
                    serialPort.Open();
                }
                catch (Exception)
                {
                    MessageBox.Show("无法打开此串口,请检查是否被占用");
                    return;
                }

                //切换文本
                tbxStatus.Text = "已连接";
                btnSwitch.Content = "关闭串口";

                //切换可用状态
                cbxSerialPortList.IsEnabled = false;
                cbxBaudRate.IsEnabled = false;
                cbxParity.IsEnabled = false;
                cbxDataBits.IsEnabled = false;
                cbxStopBits.IsEnabled = false;

                btnSend.IsEnabled = true;
            }
            else
            {
                if (serialPort != null)
                {
                    //关闭串口
                    serialPort.Close();
                }

                //切换文本
                tbxStatus.Text = "未连接";
                btnSwitch.Content = "打开串口";

                //切换可用状态
                cbxSerialPortList.IsEnabled = true;
                cbxBaudRate.IsEnabled = true;
                cbxParity.IsEnabled = true;
                cbxDataBits.IsEnabled = true;
                cbxStopBits.IsEnabled = true;

                btnSend.IsEnabled = false;
            }
        }

        /// <summary>
        /// 切换读写模式
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void cbxSendStatus_SelectionChanged(object sender, SelectionChangedEventArgs e)
        {
            sendText = cbxSendStatus.SelectedItem.ToString() == "文本" ? true : false;
        }

        /// <summary>
        /// 发送数据
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnSend_Click(object sender, RoutedEventArgs e)
        {
            //获取RichTextBox上的文本
            string str = new TextRange(rbxSendMsg.Document.ContentStart, rbxSendMsg.Document.ContentEnd).Text;
            if (string.IsNullOrEmpty(str.Replace("\r\n", "")))
            {
                MessageBox.Show("未输入消息");
                return;
            }

            //判断读写模式
            if (sendText)
            {
                //发送字符串
                serialPort.Write(str);
            }
            else
            {
                str = str.Replace(" ", "").Replace("\r\n", "");

                //将输入的16进制字符串两两分割为字符串集合
                var strArr = Regex.Matches(str, ".{2}").Cast<Match>().Select(m => m.Value);

                //需要发送的字节数组
                byte[] data = new byte[strArr.Count()];
                
                //循环索引
                int temp = 0;

                //将字符串集合转换为字节数组
                foreach (string item in strArr)
                {
                    data[temp] = Convert.ToByte(item, 16);
                    temp++;
                }

                //发送字节
                serialPort.Write(data, 0, data.Length);
            }

            MessageBox.Show("发送成功");
        }

        /// <summary>
        /// 清空发送框的文本
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnClearSendText_Click(object sender, RoutedEventArgs e)
        {
            rbxSendMsg.Document.Blocks.Clear();
        }

        /// <summary>
        /// 获取接收到的数据
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void GetReceiveMsg(object sender, SerialDataReceivedEventArgs e)
        {
            //读取串口缓冲区的字节数据
            byte[] result = new byte[serialPort.BytesToRead];
            serialPort.Read(result, 0, serialPort.BytesToRead);

            string str = $"{DateTime.Now}:\n";

            //判断读写模式
            //将接收到的字节数组转换为指定的消息格式
            if (sendText)
            {
                str += $"{Encoding.UTF8.GetString(result)}";
            }
            else
            {
                for (int i = 0; i < result.Length; i++)
                {
                    str += $"{result[i].ToString("X2")} ";
                }
            }

            //在窗体中显示接收到的消息
            SetRecMsgRbx(str.Trim());
        }

        /// <summary>
        /// 为显示接收消息的富文本框添加文本
        /// </summary>
        /// <param name="str"></param>
        private void SetRecMsgRbx(string str)
        {
            rbxReceiveMsg.Dispatcher.BeginInvoke(new Action(() =>
            {
                Run run = new Run(str);
                Paragraph p = new Paragraph();
                p.Inlines.Add(run);
                rbxReceiveMsg.Document.Blocks.Add(p);
            }));
        }

        /// <summary>
        /// 获取窗体选中的奇偶校验
        /// </summary>
        /// <returns></returns>
        private Parity GetSelectedParity()
        {
            switch (cbxParity.SelectedItem.ToString())
            {
                case "Odd":
                    return Parity.Odd;
                case "Even":
                    return Parity.Even;
                case "Mark":
                    return Parity.Mark;
                case "Space":
                    return Parity.Space;
                case "None":
                default:
                    return Parity.None;
            }
        }

        /// <summary>
        /// 获取窗体选中的停止位
        /// </summary>
        /// <returns></returns>
        private StopBits GetSelectedStopBits()
        {
            switch (Convert.ToDouble(cbxStopBits.SelectedItem))
            {
                case 1:
                    return StopBits.One;
                case 1.5:
                    return StopBits.OnePointFive;
                case 2:
                    return StopBits.Two;
                default:
                    return StopBits.One;
            }
        }
    }
}

效果测试

文本收发: 

字节收发: 


结尾

在C#中实现串口通讯是比较简单的,但是用到真实的设备通讯的时候,往往会涉及到一些报文格式的问题,而报文比较麻烦的就是计算校验码,这里提供常用的两种常用的校验算法:BCC异或校验、CRC16循环冗余校验。

BCC:

public static byte[] BCC(byte[] data)
{
    int temp = 0;
    for (int index = 0; index < data.Length; index++)
    {
        temp = temp ^ data[index];
    }

    byte[] result = new byte[1];

    result[0] = Convert.ToByte(temp);

    return result;
}

CRC16:

public static byte[] CRC16(string code)
{
    var strArr = Regex.Matches(code, ".{2}").Cast<Match>().Select(m => m.Value);
    byte[] pDataBytes = new byte[strArr.Count()];
    int temp = 0;
    foreach (var item in strArr)
    {
        pDataBytes[temp] = Convert.ToByte(item, 16);
        temp++;
    }
    ushort crc = 0xffff;
    ushort polynom = 0xA001;

    for (int i = 0; i < pDataBytes.Length; i++)
    {
        crc ^= pDataBytes[i];
        for (int j = 0; j < 8; j++)
        {
            if ((crc & 0x01) == 0x01)
            {
                crc >>= 1;
                crc ^= polynom;
            }
            else
            {
                crc >>= 1;
            }
        }
    }

    return BitConverter.GetBytes(crc);
}

猜你喜欢

转载自blog.csdn.net/XUMENGCAS/article/details/121990702