跳到主要内容
版本:2.0

串口客户端

定义

命名空间:TouchSocket.SerialPorts
程序集:TouchSocket.SerialPorts.dll

一、说明

SerialPortClient是串口系客户端,他直接参与串口的连接、发送、接收、处理、断开等。

二、特点

  • 简单易用。
  • 内存池支持
  • 高性能
  • 适配器预处理,一键式解决分包粘包、对象解析(modbus)等。
  • 超简单的同步发送、异步发送、接收等操作。
  • 基于委托、插件驱动,让每一步都能执行AOP。

三、产品应用场景

  • 所有串口基础使用场景:可跨平台、跨语言使用。
  • 自定义协议解析场景:可解析任意数据格式的串口数据报文。

四、可配置项

可配置项

SetMaxPackageSize

数据包最大值(单位:byte),默认1024×1024×10。该值会在适当时间,直接作用DataHandlingAdapter.MaxPackageSize。

SetSerialPortOption

配置串口相关。例如:端口、波特率、数据位、校验位、停止位等。

UseDelaySender

使用延迟发送。众所周知,串口数据报文为了发送效率,会默认启用延迟算法。但是这种设置,只能一定程度的缓解小数据发送效率低的问题,因为它为了保证多线程发送的有序性,在send函数中设置了线程同步,所以说,每调用一次send,实际上都是巨大的性能消耗(此处用iocp发送亦然)。所以,要解决该问题, 最终还是要将小数据,组合成大数据,这样才能更高效率的发送。所以,DelaySender正是负责此类工作的。

使用DelaySender,会一定程度的降低发送的及时性,但是降低程度并不高,简单来说:

如果一个包大于512kb,则不会延迟,直接发送。 如果发送第一个包,与第二个包的时间间隔小于一个线程池线程调度的时间(这个时间极短,一般来说会在10微秒左右),则会将这两个包压缩为一个包发送。

五、支持插件

插件方法功能
ISerialConnectingPlugin在串口连接之前触发。
ISerialConnectedPlugin同意连接,且成功启动接收后触发
ISerialDisconnectingPlugin当客户端主动调用Close时触发
ISerialDisconnectedPlugin当客户端断开连接后触发
ISerialReceivingPlugin在收到原始数据时触发,所有的数据均在ByteBlock里面。
ISerialReceivedPlugin在收到适配器数据时触发,根据适配器类型,数据可能在ByteBlock或者IRequestInfo里面。
ISerialSendingPlugin当即将发送数据时,调用该方法在适配器之后,接下来即会发送数据。

六、创建SerialPortClient

6.1 简单创建

简单的处理逻辑可通过ConnectingConnectedReceived等委托直接实现。

代码如下:

var client = new SerialPortClient();
client.Connecting = (client, e) => { return EasyTask.CompletedTask; };//即将连接到端口
client.Connected = (client, e) => { return EasyTask.CompletedTask; };//成功连接到端口
client.Disconnecting = (client, e) => { return EasyTask.CompletedTask; };//即将从端口断开连接。此处仅主动断开才有效。
client.Disconnected = (client, e) => { return EasyTask.CompletedTask; };//从端口断开连接,当连接不成功时不会触发。
client.Received = async (c, e) =>
{
await Console.Out.WriteLineAsync(Encoding.UTF8.GetString(e.ByteBlock,0,e.ByteBlock.Len));
};

client.Setup(new TouchSocket.Core.TouchSocketConfig()
.SetSerialPortOption(new SerialPortOption()
{
BaudRate = 9600,//波特率
DataBits = 8,//数据位
Parity = System.IO.Ports.Parity.None,//校验位
PortName = "COM1",//COM
StopBits = System.IO.Ports.StopBits.One//停止位
}));

client.Connect();
Console.WriteLine("连接成功");

6.2 继承实现

一般继承实现的话,可以从SerialPortClientBase继承。

class MySerialClient : SerialPortClientBase
{
protected override async Task ReceivedData(ReceivedDataEventArgs e)
{
//此处逻辑单线程处理。

//此处处理数据,功能相当于Received委托。
string mes = Encoding.UTF8.GetString(e.ByteBlock.Buffer, 0, e.ByteBlock.Len);
Console.WriteLine($"已接收到信息:{mes}");
await base.ReceivedData(e);
}
}
var client = new MySerialClient();
client.Setup(new TouchSocket.Core.TouchSocketConfig()
.SetSerialPortOption(new SerialPortOption()
{
BaudRate = 9600,//波特率
DataBits = 8,//数据位
Parity = System.IO.Ports.Parity.None,//校验位
PortName = "COM1",//COM
StopBits = System.IO.Ports.StopBits.One//停止位
}));
client.Connect();//调用连接,当连接不成功时,会抛出异常。

七、接收数据

在串口中,接收数据的方式有很多种。多种方式可以组合使用。

7.1 Received委托处理

当使用SerialPortClient创建客户端时,内部已经定义好了一个外置委托Received,可以通过该委托直接接收数据。

var client = new SerialPortClient();
client.Received = (client, e) =>
{
//收到信息
string mes = Encoding.UTF8.GetString(e.ByteBlock.Buffer, 0, e.ByteBlock.Len);
Console.WriteLine($"接收到信息:{mes}");
return EasyTask.CompletedTask;
};

7.2 ReadAsync异步读取

在使用串口时,可能更需要同步Read的情况。所以此处提供了异步读取方法。

client.Connect();

using (var receiver = client.CreateReceiver())
{
while (true)
{
using (var receiverResult = await receiver.ReadAsync(CancellationToken.None))
{
if (receiverResult.IsClosed)
{
//断开
}
//按照适配器类型。此处可以获取receiverResult.ByteBlock或者receiverResult.RequestInfo
await Console.Out.WriteLineAsync(Encoding.UTF8.GetString(receiverResult.ByteBlock, 0, receiverResult.ByteBlock.Len));
}
}
}

带有接收超时的情况:

client.Connect();
using (var receiver = client.CreateReceiver())
{
while (true)
{
using (var tokenSource=new CancellationTokenSource(5000))
{
using (var receiverResult = await receiver.ReadAsync(tokenSource.Token))
{
if (receiverResult.IsClosed)
{
//断开
}
//按照适配器类型。此处可以获取receiverResult.ByteBlock或者receiverResult.RequestInfo
await Console.Out.WriteLineAsync(Encoding.UTF8.GetString(receiverResult.ByteBlock, 0, receiverResult.ByteBlock.Len));
}
}

}
}
提示

receiver在被Create之后,其优先级最高,即:Received委托和插件都不再被调用。

7.3 插件处理

按照TouchSocket的设计理念,使用插件处理数据,是一项非常简单,且高度解耦的方式。步骤如下:

(1)声明插件

插件可以先继承PluginBase,然后再实现需要的功能插件接口,可以按需选择泛型或者非泛型实现。

如果已经有继承类,直接实现IPlugin接口即可。

public class MyPlugin : PluginBase, ISerialReceivedPlugin<ISerialPortClient>
{
public async Task OnSerialReceived(ISerialPortClient client, ReceivedDataEventArgs e)
{
//这里处理数据接收
//根据适配器类型,e.ByteBlock与e.RequestInfo会呈现不同的值,具体看文档=》适配器部分。
ByteBlock byteBlock = e.ByteBlock;
IRequestInfo requestInfo = e.RequestInfo;

//e.Handled = true;//表示该数据已经被本插件处理,无需再投递到其他插件。

await e.InvokeNext();
}
}

(2)创建使用插件处理的客户端

var client = new SerialPortClient();
client.Setup(new TouchSocketConfig()
.SetSerialPortOption(new SerialPortOption()
{
BaudRate = 9600,//波特率
DataBits = 8,//数据位
Parity = System.IO.Ports.Parity.None,//校验位
PortName = "COM1",//COM
StopBits = System.IO.Ports.StopBits.One//停止位
})
.ConfigurePlugins(a =>
{
a.Add<MyPlugin>();
}));

client.Connect();

八、发送数据

8.1 同步发送

SerialPortClient已经内置了三种同步发送方法,直接调用就可以发送,但需要注意的是,通过该方法发送的数据,会经过适配器,如果想要直接发送,请使用DefaultSend。如果发送失败,则会立即抛出异常。

public virtual void Send(byte[] buffer);
public virtual void Send(ByteBlock byteBlock);
public virtual void Send(byte[] buffer, int offset, int length);

8.2 异步发送

SerialPortClient已经内置了三种异步发送方法,直接调用就可以发送。如果发送失败,await就会触发异常。

public virtual Task SendAsync(byte[] buffer);
public virtual Task SendAsync(byte[] buffer, int offset, int length);
提示

框架不仅内置了Send字节的发送,也扩展了字符串等常见数据的发送。而且还包括了TrySend等不会抛出异常的发送方法。

8.3 同步发送等待

WaitingClient是TouchSocket提供的一个等待客户端发送数据的客户端。例如:串口客户端发送一个Hello,等待对方回信Hi,此时即可使用WaitingClient。

client.Connect();

//调用CreateWaitingClient获取到IWaitingClient的对象。
var waitClient = client.CreateWaitingClient(new WaitingOptions()
{
FilterFunc = response => //设置用于筛选的fun委托,当返回为true时,才会响应返回
{
return true;

//if (response.Data.Length == 1)
//{
// return true;
//}
//return false;
}
});

//然后使用SendThenReturn。
byte[] returnData = waitClient.SendThenReturn(Encoding.UTF8.GetBytes("RRQM"));
client.Logger.Info($"收到回应消息:{Encoding.UTF8.GetString(returnData)}");

//同时,如果适配器收到数据后,返回的并不是字节,而是IRequestInfo对象时,可以使用SendThenResponse.
ResponsedData responsedData = waitClient.SendThenResponse(Encoding.UTF8.GetBytes("RRQM"));
IRequestInfo requestInfo = responsedData.RequestInfo;//同步收到的RequestInfo
提示

在SendThenReturn时,通过其他参数,还可以设置Timeout,以及可取消的等待Token。

注意事项
  1. 发送完数据,在等待时,如果收到其他返回数据,则可能得到错误结果。
  2. 发送采用同步锁,一个事务没结束,另一个请求也发不出去。
  3. Net461及以下版本中,SendThenReturn与SendThenReturnAsync不能混合使用。即:要么全同步,要么全异步。

本文示例Demo