串口通用帮助类 SerialPortHelper
Demo
private readonly SerialPortHelper _spHelper;
ctor()
{
_spHelper = new SerialPortHelper();
_spHelper.DataReceivedEvent += SerialPort_DataReceivedEvent;
_spHelper.Close();
if (_spHelper.Init("COM1"))
{
_spHelper.SetStartIdentifier(new byte[] { 0xFA, 0xFA });
_spHelper.SetEndIdentifier(new byte[] { 0xFB, 0xFB });
}
_spHelper.WriteXORCheck(command, WatchdogIdentifiers.读取数据);
}
private void SerialPort_DataReceivedEvent(object sender, EventArgs e)
{
if (e is CustomSerialPortEventArgs arg)
{
var data = arg.Message;
if (_spHelper.DataXORCheck(data))
{
switch (data[1])
{
case (byte)WatchdogIdentifiers.设置数据:
{
}
break;
case (byte)WatchdogIdentifiers.读取数据:
{
}
break;
}
}
}
}
///
/// 看门狗的通信标识
///
internal enum WatchdogIdentifiers
{
///
/// 1_1
///
[Description("1")]
设置数据 = 1,
///
/// 1_2
///
[Description("2")]
读取数据 = 2,
}
SerialPortHelper
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO.Ports;
///
/// 串行端口通信帮助类(有帧头、帧尾检测)
///
internal class SerialPortHelper
{
private CustomSerialPort _serialPort;
private readonly WeakEvent _dataReceivedEvent = new WeakEvent();
///
/// 返回的消息数据弱事件
///
public event EventHandler DataReceivedEvent
{
add => _dataReceivedEvent.Add(value, value.Invoke);
remove => _dataReceivedEvent.Remove(value);
}
public bool IsOpen => _serialPort != null && _serialPort.IsOpen;
///
/// 设置结尾标识符
///
///
public void SetEndIdentifier(byte[] end)
{
if (_serialPort != null)
{
_serialPort.EndIdentifier = end;
}
}
///
/// 设置开始标识符
///
///
public void SetStartIdentifier(byte[] start)
{
if (_serialPort != null)
{
_serialPort.StartIdentifier = start;
}
}
///
/// 延迟接收数据。
/// 默认不设置帧头、帧尾,根据实际情况判断数据完整性!
///
/// 默认500(ms)
public void SetDelayDataReceived(int millionsecond = 500)
{
if (_serialPort != null)
{
_serialPort.StartIdentifier = null;
_serialPort.EndIdentifier = null;
_serialPort.DelayRecived(millionsecond);
}
}
public bool Init(string portName, int baudRate = 9600, Parity parity = Parity.None, int dataBits = 8, StopBits stopBits = StopBits.One)
{
try
{
_serialPort = new CustomSerialPort(portName, baudRate, parity, dataBits, stopBits);
_serialPort.DataReceivedEvent += SerialPort_DataReceivedEvent;
return _serialPort.IsOpen;
}
catch (Exception ex)
{
LogFactory.GetInstance().Info(ex.Message);
}
return false;
}
///
/// 串口数据写(带数据异或校验)
///
///
/// 通信标识
/// 版本
public void WriteXORCheck(byte[] data, WatchdogIdentifiers identifier, int version = 1)
{
if (IsOpen)
{
// 通信命令格式: 起始符(FA FA) + 版本 + 通信标识 + 数据长度(mod 255) + 数据内容(DATA) + 数据校验 + 结束符(F5 F5)
int len = data.Length % 255;
byte xor = WSCommFunc.GetXOR(data);
List tmp = new List(data.Length + 4) { (byte)version, (byte)identifier, (byte)len };
tmp.AddRange(data);
tmp.Add(xor);
_serialPort.WritePort(tmp.ToArray());
}
}
///
/// 获取的数据异或校验
///
///
/// true校验成功
public bool DataXORCheck(byte[] data)
{
// 数据格式: 版本 + 通信标识 + 数据长度(mod 255) + 数据内容(DATA) + 数据校验
int length = data.Length;
if (length <= 4)
{
return false;
}
// 长度不一致,异常数据
if (data[2] != length - 4)
{
return false;
}
byte[] temp = new byte[length - 4];
Array.Copy(data, 3, temp, 0, length - 4);
byte xor = WSCommFunc.GetXOR(temp);
return xor == data[length - 1];
}
///
/// 串口数据写
///
///
public void Write(byte[] data)
{
if (IsOpen)
{
_serialPort.WritePort(data);
}
}
///
/// 串口数据写
///
///
public void Write(string data)
{
if (IsOpen)
{
_serialPort.WritePort(data);
}
}
public void Close()
{
if (_serialPort != null)
{
_serialPort.DataReceivedEvent -= SerialPort_DataReceivedEvent;
_serialPort.Close();
}
}
private void SerialPort_DataReceivedEvent(object sender, EventArgs e)
{
_dataReceivedEvent.Invoke(this, e);
}
}
其中,是一般串口通信的基本功能,可自行实现。