前言
IoTClient 是一个针对物联网 (IoT) 领域的开源客户端库,它主要用于实现与各种工业设备之间的通信。这个库是用 C# 编写的,并且基于 .NET Standard 2.0,这意味着可以用于多个版本的.NET,包括 .NET Framework、.NET Core、.NET 5 及以上版本,以及 Xamarin 和 UWP。
项目介绍
IoTClient 是一款基于 .NET Standard 2.0 的开源免费客户端库,适用于跨平台的 .NET 开发,可在 Windows、Linux 乃至树莓派等平台上运行。
该组件支持主流的工业通讯协议,包括 PLC 通信(如 Siemens、Mitsubishi、Omron、Allen Bradley 等)、ModBus(TCP/RTU/ASCII)以及 Bacnet 等。
IoTClient 采用 MIT 许可证发布,您可以自由地修改和进行商业使用(请注意在商业使用前做好充分的评估和测试)。
项目特点
支持多种通信协议
- ModBus:支持 ModBus TCP、ModBus RTU、ModBus ASCII 以及 ModBus RTU over TCP。
- Bacnet:支持 Bacnet 协议。
- PLC通信:支持 Siemens、Mitsubishi、Omron、Allen Bradley 等主流品牌的 PLC 通信。
跨平台
- 可以在 Windows、Linux 上运行。
- 支持在 Raspberry Pi(树莓派)这样的小型设备上部署。
开源和免费
- 使用 MIT 许可证发布,一个非常宽松的许可证,允许自由使用、修改和分发软件。
NuGet 包
- 可以通过 NuGet 包管理器安装到的项目中。
项目使用
1、引用组件
Nuget 安装
Install-Package IoTClient
或图形化安装
2、ModBusTcp读写操作
//1、实例化客户端 - 输入正确的IP和端口
ModBusTcpClient client = new ModBusTcpClient("127.0.0.1", 502);
//2、写操作 - 参数依次是:地址 、值 、站号 、功能码
client.Write("4", (short)33, 2, 16);
//2.1、【注意】写入数据的时候需要明确数据类型
client.Write("0", (short)33, 2, 16); //写入short类型数值
client.Write("4", (ushort)33, 2, 16); //写入ushort类型数值
client.Write("8", (int)33, 2, 16); //写入int类型数值
client.Write("12", (uint)33, 2, 16); //写入uint类型数值
client.Write("16", (long)33, 2, 16); //写入long类型数值
client.Write("20", (ulong)33, 2, 16); //写入ulong类型数值
client.Write("24", (float)33, 2, 16); //写入float类型数值
client.Write("28", (double)33, 2, 16); //写入double类型数值
client.Write("32", true, 2, 5); //写入线圈类型值
client.Write("100", "orderCode", stationNumber); //写入字符串
//3、读操作 - 参数依次是:地址 、站号 、功能码
var value = client.ReadInt16("4", 2, 3).Value;
//3.1、其他类型数据读取
client.ReadInt16("0", stationNumber, 3); //short类型数据读取
client.ReadUInt16("4", stationNumber, 3); //ushort类型数据读取
client.ReadInt32("8", stationNumber, 3); //int类型数据读取
client.ReadUInt32("12", stationNumber, 3); //uint类型数据读取
client.ReadInt64("16", stationNumber, 3); //long类型数据读取
client.ReadUInt64("20", stationNumber, 3); //ulong类型数据读取
client.ReadFloat("24", stationNumber, 3); //float类型数据读取
client.ReadDouble("28", stationNumber, 3); //double类型数据读取
client.ReadCoil("32", stationNumber, 1); //线圈类型数据读取
client.ReadDiscrete("32", stationNumber, 2);//离散类型数据读取
client.ReadString("100", stationNumber,10); //读取字符串
//4、如果没有主动Open,则会每次读写操作的时候自动打开自动和关闭连接,这样会使读写效率大大减低。所以建议手动Open和Close。
client.Open();
//5、读写操作都会返回操作结果对象Result
var result = client.ReadInt16("4", 2, 3);
//5.1 读取是否成功(true或false)
var isSucceed = result.IsSucceed;
//5.2 读取失败的异常信息
var errMsg = result.Err;
//5.3 读取操作实际发送的请求报文
var requst = result.Requst;
//5.4 读取操作服务端响应的报文
var response = result.Response;
//5.5 读取到的值
var value3 = result.Value;
//6、批量读取
var list = new List<ModBusInput>();
list.Add(new ModBusInput()
{
Address = "2",
DataType = DataTypeEnum.Int16,
FunctionCode = 3,
StationNumber = 1
});
list.Add(new ModBusInput()
{
Address = "2",
DataType = DataTypeEnum.Int16,
FunctionCode = 4,
StationNumber = 1
});
list.Add(new ModBusInput()
{
Address = "199",
DataType = DataTypeEnum.Int16,
FunctionCode = 3,
StationNumber = 1
});
var result = client.BatchRead(list);
//7、构造函数其他参数
//IP、端口、超时时间、大小端设置
ModBusTcpClient client = new ModBusTcpClient("127.0.0.1", 502, 1500, EndianFormat.ABCD);
3、ModBusRtu读写操作
//实例化客户端 - [COM端口名称,波特率,数据位,停止位,奇偶校验]
ModBusRtuClient client = new ModBusRtuClient("COM3", 9600, 8, StopBits.One, Parity.None);
//其他读写操作和ModBusTcpClient的读写操作一致
4、ModBusAscii读写操作
//实例化客户端 - [COM端口名称,波特率,数据位,停止位,奇偶校验]
ModbusAsciiClient client = new ModbusAsciiClient("COM3", 9600, 8, StopBits.One, Parity.None);
//其他读写操作和ModBusTcpClient的读写操作一致
5、ModbusRtuOverTcp读写操作
//串口透传 即:用Tcp的方式发送Rtu格式报文
//实例化客户端 - IP、端口、超时时间、大小端设置
ModbusRtuOverTcpClient client = new ModbusRtuOverTcpClient("127.0.0.1", 502, 1500, EndianFormat.ABCD);
//其他读写操作和ModBusTcpClient的读写操作一致
6、SiemensClient(西门子)读写操作
//1、实例化客户端 - 输入型号、IP和端口
//其他型号:SiemensVersion.S7_200、SiemensVersion.S7_300、SiemensVersion.S7_400、SiemensVersion.S7_1200、SiemensVersion.S7_1500
SiemensClient client = new SiemensClient(SiemensVersion.S7_200Smart, "127.0.0.1",102);
//2、写操作
client.Write("Q1.3", true);
client.Write("V2205", (short)11);
client.Write("V2209", 33);
client.Write("V2305", "orderCode"); //写入字符串
//3、读操作
var value1 = client.ReadBoolean("Q1.3").Value;
var value2 = client.ReadInt16("V2205").Value;
var value3 = client.ReadInt32("V2209").Value;
var value4 = client.ReadString("V2305").Value; //读取字符串
//4、如果没有主动Open,则会每次读写操作的时候自动打开自动和关闭连接,这样会使读写效率大大减低。所以建议手动Open和Close。
client.Open();
//5、读写操作都会返回操作结果对象Result
var result = client.ReadInt16("V2205");
//5.1 读取是否成功(true或false)
var isSucceed = result.IsSucceed;
//5.2 读取失败的异常信息
var errMsg = result.Err;
//5.3 读取操作实际发送的请求报文
var requst = result.Requst;
//5.4 读取操作服务端响应的报文
var response = result.Response;
//5.5 读取到的值
var value4 = result.Value;
7、SiemensClient最佳实践
1、什么时候不要主动Open
西门子plc一般最多允许8个长连接。所以当连接数不够用的时候或者做测试的时候就不要主动Open,这样组件会自动Open并即时Close。
2、什么时候主动Open
当长连接数量还够用,且想要提升读写性能。
3、除了主动Open连接,还可以通过批量读写,大幅提升读写性能。
//批量读取
Dictionary<string, DataTypeEnum> addresses = new Dictionary<string, DataTypeEnum>();
addresses.Add("DB4.24", DataTypeEnum.Float);
addresses.Add("DB1.434.0", DataTypeEnum.Bool);
addresses.Add("V4109", DataTypeEnum.Byte);
...
var result = client.BatchRead(addresses);
//批量写入
Dictionary<string, object> addresses = new Dictionary<string, object>();
addresses.Add("DB4.24", (float)1);
addresses.Add("DB4.0", (float)2);
addresses.Add("DB1.434.0", true);
...
var result = client.BatchWrite(addresses);
4、【注意】写入数据的时候需要明确数据类型
client.Write("DB4.12", 9); //写入的是int类型
client.Write("DB4.12", (float)9); //写入的是float类型
5、SiemensClient是线程安全类
由于plc长连接有限,SiemensClient被设计成线程安全类。可以把SiemensClient设置成单例,在多个线程之间使用SiemensClient的实例读写操作plc。
8、MitsubishiClient
//1、实例化客户端 - 输入正确的IP和端口
MitsubishiClient client = new MitsubishiClient(MitsubishiVersion.Qna_3E, "127.0.0.1",6000);
//2、写操作
client.Write("M100", true);
client.Write("D200", (short)11);
client.Write("D210", 33);
//3、读操作
var value1 = client.ReadBoolean("M100").Value;
var value2 = client.ReadInt16("D200").Value;
var value3 = client.ReadInt32("D210").Value;
//4、如果没有主动Open,则会每次读写操作的时候自动打开自动和关闭连接,这样会使读写效率大大减低。所以建议手动Open和Close。
client.Open();
//5、读写操作都会返回操作结果对象Result
var result = client.ReadInt16("D210");
//5.1 读取是否成功(true或false)
var isSucceed = result.IsSucceed;
//5.2 读取失败的异常信息
var errMsg = result.Err;
//5.3 读取操作实际发送的请求报文
var requst = result.Requst;
//5.4 读取操作服务端响应的报文
var response = result.Response;
//5.5 读取到的值
var value4 = result.Value;
9、OmronFinsClient(欧姆龙)读写操作
//1、实例化客户端 - 输入正确的IP和端口
OmronFinsClient client = new OmronFinsClient("127.0.0.1",6000);
//2、写操作
client.Write("M100", true);
client.Write("D200", (short)11);
client.Write("D210", 33);
//3、读操作
var value1 = client.ReadBoolean("M100").Value;
var value2 = client.ReadInt16("D200").Value;
var value3 = client.ReadInt32("D210").Value;
//4、如果没有主动Open,则会每次读写操作的时候自动打开自动和关闭连接,这样会使读写效率大大减低。所以建议手动Open和Close。
client.Open();
//5、读写操作都会返回操作结果对象Result
var result = client.ReadInt16("D210");
//5.1 读取是否成功(true或false)
var isSucceed = result.IsSucceed;
//5.2 读取失败的异常信息
var errMsg = result.Err;
//5.3 读取操作实际发送的请求报文
var requst = result.Requst;
//5.4 读取操作服务端响应的报文
var response = result.Response;
//5.5 读取到的值
var value4 = result.Value;
10、AllenBradleyClient(罗克韦尔)读写操作
//1、实例化客户端 - 输入正确的IP和端口
AllenBradleyClient client = new AllenBradleyClient("127.0.0.1",44818);
//2、写操作
client.Write("A1", (short)11);
//3、读操作
var value = client.ReadInt16("A1").Value;
//4、如果没有主动Open,则会每次读写操作的时候自动打开自动和关闭连接,这样会使读写效率大大减低。所以建议手动Open和Close。
client.Open();
//5、读写操作都会返回操作结果对象Result
var result = client.ReadInt16("A1");
//5.1 读取是否成功(true或false)
var isSucceed = result.IsSucceed;
//5.2 读取失败的异常信息
var errMsg = result.Err;
//5.3 读取操作实际发送的请求报文
var requst = result.Requst;
//5.4 读取操作服务端响应的报文
var response = result.Response;
//5.5 读取到的值
var value4 = result.Value;
IoTClient 库项目
IoTClient Tool 桌面程序工具
1、开源地址 https://github.com/zhaopeiym/IoTClient.Examples
2、可用来测试PLC和相关协议的通信
3、可作为IoTClient库使用例子。
4、IoTClient Tool效果图
iotgateway
1、开源地址 https://gitee.com/iioter/iotgateway
2、在线体验 http://online.iotgateway.net 用户名:admin 密码:iotgateway.net
3、基于.NET 5 的跨平台物联网网关。
4、通过可视化配置,轻松的连接到任何设备和系统(如PLC、扫码枪、CNC、数据库、串口设备、上位机、OPC Server、OPC UA Server、Mqtt Server等)
5、提供简单的驱动开发接口;当然也可以进行边缘计算。
6、系统页面展示
项目商用效果
1、 能源管理-现场-单项目
移动端
2、越邦智能分拣系统
项目地址
**github:**https://github.com/zhaopeiym/IoTClient
**gitee:**https://gitee.com/zhaopeiym/IoTClient
最后
如果你觉得这篇文章对你有帮助,不妨点个赞支持一下!你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助,欢迎随时留言。
也可以加入微信公众号**[DotNet技术匠]** 社区,与其他热爱技术的同行一起交流心得,共同成长!