Freedom 协议驱动

包: Snet.Freedom | 类: FreedomOperate | 类型数量: 3

提供一个灵活的用户可自定义协议驱动，支持自定义串口（RS-232/485）和 TCP 通信，并支持脚本化帧解析。适用于非标准或专有设备协议。

安装

dotnet add package Snet.Freedom

快速入门

using Snet.Freedom;

var op = await FreedomOperate.InstanceAsync(new FreedomData.Basics
{
    IpAddress = "192.168.1.100",
    Port = 6688
});

var address = new Address(new List<AddressDetails>
{
    new("读数", "010300000001", DataType.ByteArray),
    new("读数2", "010300000002", DataType.ByteArray)
});
var result = await op.ReadAsync(address);
if (result.Status)
{
    var data = result.GetSource<ConcurrentDictionary<string, AddressValue>>();
    foreach (var kv in data)
        Console.WriteLine($"{kv.Key} = {kv.Value.ResultValue}");
}
else
{
    Console.WriteLine($"读取失败: {result.Message}");
}

// 订阅之前 绑定数据事件
op.OnDataEventAsync += async (sender, e) =>
{
    if (e.Status)
    {
        var data = e.GetSource<ConcurrentDictionary<string, AddressValue>>();
        foreach (var kv in data)
            Console.WriteLine($"{kv.Key} = {kv.Value.ResultValue}");
    }
    else
    {
        Console.WriteLine($"{e.Message}");
    }
};

var subAddr = new Address(new List<AddressDetails>
{
    new("读数", "010300000001", DataType.ByteArray)
});
await op.SubscribeAsync(subAddr);

// 后续：取消订阅
// await op.UnSubscribeAsync(subAddr);

await op.DisposeAsync();

配置参数

参数	类型	默认值	说明
IpAddress	string	127.0.0.1	设备 IP 或 COM 端口
Port	int	6688	TCP 端口（串口连接改用 SerialPortInfo）
ConnectTimeOut	int	1000	连接超时（毫秒）
ReceiveTimeOut	int	1000	接收超时（毫秒）
DataFormat	enum	CDAB	数据转换字节序
IsStringReverseByteWord	bool	false	反转字符串字内字节
SerialPortInfo	string	COM3-9600-8-N-1	串口设置（FreedomSerial）
RtsEnable	bool	false	RTS 握手（FreedomSerial）
DtrEnable	bool	false	DTR 握手（FreedomSerial）
SleepTime	int	0	帧间休眠（毫秒，FreedomSerial）
ProtocolType	enum	FreedomTcpNet	协议类型

支持类型

类型	说明
FreedomTcpNet	TCP 网络通信
FreedomUdpNet	UDP 网络通信
FreedomSerial	RS-232/485 串口通信

帧格式、编码和解析规则可通过脚本或配置完全自定义，从而支持与几乎任何串口或 TCP 设备协议进行集成。

地址格式

Freedom(自由协议)寻址 — 地址就是完整请求报文的十六进制字符串。

区域	地址格式	示例
请求报文	十六进制字符串(空格可选);可选 stx=N; 前缀 = 响应中剥离的报文头字节数	010300000001, 00 00 00 00 00 06 01 03 00 64 00 01, stx=9;00 00 00 00 00 06 01 03 00 64 00 01

支持的数据类型

所有读取按 AddressDetails.DataType 分发 — 别名(Short = Int16、Float = Single、Int = Int32 等)共用同一分支。

数据类型	支持	说明
Bool	❌	ReadBoolAsync 落到基类并失败
Int16 / Short, UInt16 / Ushort	✅	16 位整数
Int32 / Int, UInt32 / Uint	✅	32 位整数
Int64 / Long, UInt64 / Ulong	✅	64 位整数
Float / Single, Double	✅	32 / 64 位浮点
String / Char	✅	带 length + 编码读取
ByteArray + 全部 10 种 *Array	✅	带 length 的数组读取
Byte	❌	ReadAsync 中有 case 但无底层读取 — 实际消息为格式化资源串（含协议名与类型名），并非字面文本 "不支持该类型读取"

地址自动组包与解包

每个数采驱动都实现 IPacker。FreedomOperate 使用标签/符号寻址，未注册在自动组包注册表中，因此 Packer 原样返回地址集合（透传）——见 IPacker 接口。支持字节偏移寻址的协议（如西门子 S7、Modbus、三菱 MC）可组包：地址自动组包。

订阅

先绑定数据事件，再通过 SubscribeAsync 添加地址；数据通过 OnDataEventAsync 到达：

op.OnDataEventAsync += async (sender, e) =>
{
    if (e.Status)
    {
        var data = e.GetSource<ConcurrentDictionary<string, AddressValue>>();
        foreach (var kv in data)
            Console.WriteLine($"{kv.Key} = {kv.Value.ResultValue}");
    }
    else
    {
        Console.WriteLine($"订阅错误: {e.Message}");
    }
};

var subAddr = new Address(new List<AddressDetails>
{
    new("读数", "010300000001", DataType.ByteArray)
});
await op.SubscribeAsync(subAddr);

// 后续：停止监视
// await op.UnSubscribeAsync(subAddr);

支持操作

操作	方法
连接	OnAsync()
断开	OffAsync()
读取	ReadAsync(address)
写入	WriteAsync(values)
订阅	SubscribeAsync(address)
组包 / 解包	PackerAsync(address, protocolTypeKey) / UnPackerAsync(data)

参见

• DaqAbstract 基类
• IDaq 接口