点击或拖拽改变大小

ModbusTcpNet 类

Modbus-Tcp协议的客户端通讯类,方便的和服务器进行数据交互,支持标准的功能码,也支持扩展的功能码实现,地址采用富文本的形式,详细见API文档说明
The client communication class of Modbus-Tcp protocol is convenient for data interaction with the server. It supports standard function codes and also supports extended function codes. The address is in rich text. For details, see the remarks.
继承层次
SystemObject
  HslCommunication.Core.NetBinaryCommunication
    HslCommunication.Core.DeviceDeviceCommunication
      HslCommunication.Core.DeviceDeviceTcpNet
        HslCommunication.ModBusModbusTcpNet
          更多...

命名空间:  HslCommunication.ModBus
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:12.0.2.0 (12.0.2.0)
语法
public class ModbusTcpNet : DeviceTcpNet, 
	IModbus, IReadWriteDevice, IReadWriteNet

ModbusTcpNet 类型公开以下成员。

构造函数
  名称说明
公共方法ModbusTcpNet
实例化一个Modbus-Tcp协议的客户端对象
Instantiate a client object of the Modbus-Tcp protocol
公共方法ModbusTcpNet(String, Int32, Byte)
指定服务器地址,端口号,客户端自己的站号来初始化
Specify the server address, port number, and client's own station number to initialize
Top
属性
  名称说明
公共属性AddressStartWithZero
获取或设置起始的地址是否从0开始,默认为True
Gets or sets whether the starting address starts from 0. The default is True
公共属性AlienSession
当前的异形连接对象,如果设置了异形连接的话,仅用于异形模式的情况使用
The current alien connection object, if alien connection is set, is only used in the case of alien mode
(继承自 DeviceTcpNet。)
公共属性代码示例ByteTransform
当前的数据变换机制,当你需要从字节数据转换类型数据的时候需要。
The current data transformation mechanism is required when you need to convert type data from byte data.
(继承自 DeviceCommunication。)
公共属性CommunicationPipe
获取或设置当前的管道信息,管道类型为CommunicationPipe的继承类,内置了PipeTcpNet管道,PipeUdpNet管道,PipeSerialPort管道等
(继承自 BinaryCommunication。)
公共属性ConnectionId
当前连接的唯一ID号,默认为长度20的guid码加随机数组成,方便列表管理,也可以自己指定
The unique ID number of the current connection. The default is a 20-digit guid code plus a random number.
(继承自 BinaryCommunication。)
公共属性代码示例ConnectTimeOut
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈
Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback
(继承自 DeviceTcpNet。)
公共属性DataFormat
获取或设置数据解析的格式,可选ABCD, BADC,CDAB,DCBA格式,对int,uint,float,double,long,ulong类型有作用
Get or set the format of the data analysis, optional ABCD, BADC, CDAB, DCBA format, effective for int, uint, float, double, long, ulong type
公共属性EnableWriteMaskCode
获取或设置当前掩码写入的功能码是否激活状态,设置为 false 时,再执行写入位时,会通过读字,修改位,写字的方式来间接实现。
When the function code is set to false, and then the write bit is executed, it will be indirectly implemented by reading, modifying the bit, and writing the word.
公共属性代码示例IpAddress
获取或是设置远程服务器的IP地址,如果是本机测试,那么需要设置为127.0.0.1
Get or set the IP address of the remote server. If it is a local test, then it needs to be set to 127.0.0.1
(继承自 DeviceTcpNet。)
公共属性IsCheckMessageId
获取或设置是否进行检查返回的消息ID和发送的消息ID是否一致,默认为true,也就是检查
Get or set whether to check whether the returned message ID is consistent with the sent message ID, the default is true, that is, check
公共属性IsStringReverse
字符串数据是否按照字来反转,默认为False
Whether the string data is reversed according to words. The default is False.
公共属性LocalBinding
获取或设置绑定的本地的IP地址和端口号信息,如果端口设置为0,代表任何可用的端口
Get or set the bound local IP address and port number information, if the port is set to 0, it means any available port
(继承自 DeviceTcpNet。)
公共属性代码示例LogNet
组件的日志工具,支持日志记录,只要实例化后,当前网络的基本信息,就以DEBUG等级进行输出
The component's logging tool supports logging. As long as the instantiation of the basic network information, the output will be output at DEBUG
(继承自 BinaryCommunication。)
公共属性MessageId
获取modbus协议自增的消息号,你可以自定义modbus的消息号的规则,详细参见ModbusTcpNet说明,也可以查找SoftIncrementCount说明。
Get the message number incremented by the modbus protocol. You can customize the rules of the message number of the modbus. For details, please refer to the description of ModbusTcpNet, or you can find the description of SoftIncrementCount
公共属性代码示例Port
获取或设置服务器的端口号,具体的值需要取决于对方的配置
Gets or sets the port number of the server. The specific value depends on the configuration of the other party.
(继承自 DeviceTcpNet。)
公共属性代码示例ReceiveTimeOut
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈
Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback
(继承自 BinaryCommunication。)
公共属性SendBeforeHex
获取或设置在发送通信报文前追加发送的字节信息,HEX格式,通常用于lora组网时,需要携带 00 00 00 02 四个字节的站地址功能。
Obtain or set the byte information sent before sending communication packets, HEX format, usually used for LORA networking, you need to carry 00 00 00 02 four-byte station address function.
(继承自 BinaryCommunication。)
公共属性SleepTime
获取或设置在正式接收对方返回数据前的时候,需要休息的时间,当设置为0的时候,不需要休息。
Get or set the time required to rest before officially receiving the data from the other party. When it is set to 0, no rest is required.
(继承自 BinaryCommunication。)
公共属性SocketKeepAliveTime
获取或设置客户端的Socket的心跳时间信息,这个是Socket底层自动实现的心跳包,不基于协议层实现。默认小于0,不开启心跳检测,如果需要开启,设置 60_000 比较合适,单位毫秒
Get or set the heartbeat time information of the Socket of the client. This is the heartbeat packet automatically implemented by the bottom layer of the Socket, not based on the protocol layer. The default value is less than 0, and heartbeat detection is not enabled. If you need to enable it, it is more appropriate to set 60_000, in milliseconds.
(继承自 DeviceTcpNet。)
公共属性Station
获取或者重新修改服务器的默认站号信息,当然,你可以再读写的时候动态指定,例如地址 "s=2;100", 更详细的例子可以参考DEMO界面上的地址示例。
Get or re-modify the server's default station number information, of course, you can dynamically specify when reading and writing, such as the address "s=2; 100", a more detailed example can refer to the DEMO interface address example.
受保护的属性WordLength
一个字单位的数据表示的地址长度,西门子为2,三菱,欧姆龙,modbusTcp就为1,AB PLC无效
The address length represented by one word of data, Siemens is 2, Mitsubishi, Omron, modbusTcp is 1, AB PLC is invalid
(继承自 DeviceCommunication。)
Top
方法
  名称说明
公共方法代码示例ConnectClose
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式
Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode
(继承自 DeviceTcpNet。)
公共方法代码示例ConnectCloseAsync
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式
Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode
(继承自 DeviceTcpNet。)
公共方法代码示例ConnectServer
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速
Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster.
(继承自 DeviceTcpNet。)
公共方法代码示例ConnectServer(AlienSession)
使用指定的套接字创建异形客户端,在异形客户端的模式下,网络通道需要被动创建。
Use the specified socket to create the alien client. In the alien client mode, the network channel needs to be created passively.
(继承自 DeviceTcpNet。)
公共方法代码示例ConnectServerAsync
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速
Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster.
(继承自 DeviceTcpNet。)
受保护的方法DecideWhetherQAMessage
决定当前的消息是否是用于问答机制返回的消息,默认直接返回 true, 实际的情况需要根据协议进行重写方法
To determine whether the current message is the message returned by the question answering mechanism, the default is true. In actual cases, the rewriting method needs to be performed according to the protocol
(继承自 BinaryCommunication。)
公共方法Dispose (继承自 DeviceCommunication。)
受保护的方法Dispose(Boolean) (继承自 DeviceCommunication。)
公共方法Equals (继承自 Object。)
受保护的方法ExtraAfterReadFromCoreServer
和服务器交互完成的时候调用的方法,可以根据读写结果进行一些额外的操作,具体的操作需要根据实际的需求来重写实现
The method called when the interaction with the server is completed can perform some additional operations based on the read and write results. The specific operations need to be rewritten according to actual needs.
(继承自 BinaryCommunication。)
受保护的方法代码示例ExtraOnDisconnect
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
(继承自 BinaryCommunication。)
受保护的方法代码示例ExtraOnDisconnectAsync
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
(继承自 BinaryCommunication。)
受保护的方法Finalize (继承自 Object。)
公共方法GetHashCode (继承自 Object。)
受保护的方法GetLogTextFromBinary
获取当前的报文进行日志记录的时候,是否使用二进制的格式记录,默认返回 LogMsgFormatBinary,重写可以根据session对象分别返回不同记录模式
Whether to log the current packet in binary format, the default return is LogMsgFormatBinary. If you want to override it, different recording modes can be returned according to session
(继承自 BinaryCommunication。)
受保护的方法GetNewNetMessage
获取一个新的消息对象的方法,需要在继承类里面进行重写
The method to get a new message object needs to be overridden in the inheritance class
(重写 BinaryCommunicationGetNewNetMessage.)
公共方法GetType (继承自 Object。)
受保护的方法GetWordLength
一个字单位的数据表示的地址长度,西门子为2,三菱,欧姆龙,modbusTcp就为1,AB PLC无效
The address length represented by one word of data, Siemens is 2, Mitsubishi, Omron, modbusTcp is 1, AB PLC is invalid
(继承自 DeviceCommunication。)
受保护的方法代码示例InitializationOnConnect
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created.
(继承自 BinaryCommunication。)
受保护的方法代码示例InitializationOnConnectAsync
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created.
(继承自 BinaryCommunication。)
公共方法IpAddressPing
对当前设备的IP地址进行PING的操作,返回PING的结果,正常来说,返回Success
PING the IP address of the current device and return the PING result. Normally, it returns Success
(继承自 DeviceTcpNet。)
受保护的方法LogRevcMessage(Byte)
使用日志记录一个接收的报文信息
` Logs are used to record information about a received packet
(继承自 BinaryCommunication。)
受保护的方法LogRevcMessage(Byte, PipeSession)
使用日志记录一个接收的报文信息
` Logs are used to record information about a received packet
(继承自 BinaryCommunication。)
受保护的方法LogSendMessage(Byte)
使用日志记录一个发送的报文信息
Logs are used to record information about a send packet
(继承自 BinaryCommunication。)
受保护的方法LogSendMessage(Byte, PipeSession)
使用日志记录一个发送的报文信息
Logs are used to record information about a send packet
(继承自 BinaryCommunication。)
受保护的方法MemberwiseClone (继承自 Object。)
公共方法PackCommandWithHeader
对当前的命令进行打包处理,通常是携带命令头内容,标记当前的命令的长度信息,需要进行重写,否则默认不打包
The current command is packaged, usually carrying the content of the command header, marking the length of the current command, and it needs to be rewritten, otherwise it is not packaged by default
(重写 BinaryCommunicationPackCommandWithHeader(Byte).)
公共方法代码示例Read(String, UInt16)
从Modbus服务器批量读取寄存器的信息,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x03,如果需要使用04功能码,那么地址就写成 x=4;100
To read the register information from the Modbus server in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x03. If you need to use the 04 function code, the address is written as x = 4; 100
(重写 DeviceCommunicationRead(String, UInt16).)
公共方法代码示例ReadT
读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 DeviceCommunication。)
公共方法代码示例ReadAsync(String, UInt16)
从Modbus服务器批量读取寄存器的信息,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x03,如果需要使用04功能码,那么地址就写成 x=4;100
To read the register information from the Modbus server in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x03. If you need to use the 04 function code, the address is written as x = 4; 100
(重写 DeviceCommunicationReadAsync(String, UInt16).)
公共方法代码示例ReadAsyncT
异步读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Asynchronously read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 DeviceCommunication。)
公共方法ReadBool(String)
读取单个的Boolean数据信息
Read a single Boolean data message
(继承自 DeviceCommunication。)
公共方法ReadBool(String, UInt16)
批量读取线圈或是离散的数据信息,需要指定地址和长度,具体的结果取决于实现,如果富文本地址不指定,默认使用的功能码是 0x01
To read coils or discrete data in batches, you need to specify the address and length. The specific result depends on the implementation. If the rich text address is not specified, the default function code is 0x01.
(重写 DeviceCommunicationReadBool(String, UInt16).)
公共方法ReadBoolAsync(String)
异步读取单个的Boolean数据信息
Asynchronously read a single Boolean data message
(继承自 DeviceCommunication。)
公共方法ReadBoolAsync(String, UInt16)
批量读取线圈或是离散的数据信息,需要指定地址和长度,具体的结果取决于实现,如果富文本地址不指定,默认使用的功能码是 0x01
To read coils or discrete data in batches, you need to specify the address and length. The specific result depends on the implementation. If the rich text address is not specified, the default function code is 0x01.
(重写 DeviceCommunicationReadBoolAsync(String, UInt16).)
公共方法ReadCoil(String)
读取线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x01
To read the coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x01.
公共方法ReadCoil(String, UInt16)
批量的读取线圈,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x01
For batch reading coils, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x01.
公共方法ReadCoilAsync(String)
读取线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x01
To read the coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x01.
公共方法ReadCoilAsync(String, UInt16)
批量的读取线圈,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x01
For batch reading coils, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x01.
公共方法代码示例ReadCustomerT(String)
读取自定义的数据类型,需要继承自IDataTransfer接口,返回一个新的类型的实例对象。
To read a custom data type, you need to inherit from the IDataTransfer interface and return an instance object of a new type.
(继承自 DeviceCommunication。)
公共方法代码示例ReadCustomerT(String, T)
读取自定义的数据类型,需要继承自IDataTransfer接口,传入一个实例,对这个实例进行赋值,并返回该实例的对象。
To read a custom data type, you need to inherit from the IDataTransfer interface, pass in an instance, assign a value to this instance, and return the object of the instance.
(继承自 DeviceCommunication。)
公共方法代码示例ReadCustomerAsyncT(String)
读取自定义的数据类型,需要继承自IDataTransfer接口,返回一个新的类型的实例对象。
To read a custom data type, you need to inherit from the IDataTransfer interface and return an instance object of a new type.
(继承自 DeviceCommunication。)
公共方法代码示例ReadCustomerAsyncT(String, T)
读取自定义的数据类型,需要继承自IDataTransfer接口,传入一个实例,对这个实例进行赋值,并返回该实例的对象。
To read a custom data type, you need to inherit from the IDataTransfer interface, pass in an instance, assign a value to this instance, and return the object of the instance.
(继承自 DeviceCommunication。)
公共方法ReadDiscrete(String)
读取输入线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x02
To read the input coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x02.
公共方法ReadDiscrete(String, UInt16)
批量的读取输入点,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x02
To read input points in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x02
公共方法ReadDiscreteAsync(String)
读取输入线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x02
To read the input coil, you need to specify the start address. If the rich text address is not specified, the default function code is 0x02.
公共方法ReadDiscreteAsync(String, UInt16)
批量的读取输入点,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x02
To read input points in batches, you need to specify the start address and read length. If the rich text address is not specified, the default function code is 0x02
公共方法代码示例ReadDouble(String)
读取双浮点的数据
Read double floating point data
(继承自 DeviceCommunication。)
公共方法代码示例ReadDouble(String, UInt16)
读取双浮点数据的数组
Read double floating point data array
(重写 DeviceCommunicationReadDouble(String, UInt16).)
公共方法代码示例ReadDoubleAsync(String)
异步读取双浮点的数据
Asynchronously read double floating point data
(继承自 DeviceCommunication。)
公共方法代码示例ReadDoubleAsync(String, UInt16)
异步读取双浮点数据的数组
Asynchronously read double floating point data array
(重写 DeviceCommunicationReadDoubleAsync(String, UInt16).)
公共方法代码示例ReadFloat(String)
读取单浮点数据
Read single floating point data
(继承自 DeviceCommunication。)
公共方法代码示例ReadFloat(String, UInt16)
读取单浮点精度的数组
Read single floating point array
(重写 DeviceCommunicationReadFloat(String, UInt16).)
公共方法代码示例ReadFloatAsync(String)
异步读取单浮点数据
Asynchronously read single floating point data
(继承自 DeviceCommunication。)
公共方法代码示例ReadFloatAsync(String, UInt16)
异步读取单浮点精度的数组
Asynchronously read single floating point array
(重写 DeviceCommunicationReadFloatAsync(String, UInt16).)
公共方法ReadFromCoreServer(IEnumerableByte) (继承自 BinaryCommunication。)
公共方法ReadFromCoreServer(Byte)
将Modbus报文数据发送到当前的通道中,并从通道中接收Modbus的报文,通道将根据当前连接自动获取,本方法是线程安全的。
Send Modbus message data to the current channel, and receive Modbus messages from the channel. The channel will automatically obtain it according to the current connection. This method is thread-safe.
(重写 BinaryCommunicationReadFromCoreServer(Byte).)
公共方法代码示例ReadFromCoreServer(Byte, Boolean, Boolean)
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。
Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServer(CommunicationPipe, Byte, Boolean, Boolean)
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServerAsync(IEnumerableByte) (继承自 BinaryCommunication。)
公共方法ReadFromCoreServerAsync(Byte)
将Modbus报文数据发送到当前的通道中,并从通道中接收Modbus的报文,通道将根据当前连接自动获取,本方法是线程安全的。
Send Modbus message data to the current channel, and receive Modbus messages from the channel. The channel will automatically obtain it according to the current connection. This method is thread-safe.
(重写 BinaryCommunicationReadFromCoreServerAsync(Byte).)
公共方法代码示例ReadFromCoreServerAsync(Byte, Boolean, Boolean)
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。
Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServerAsync(CommunicationPipe, Byte, Boolean, Boolean)
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(继承自 BinaryCommunication。)
公共方法代码示例ReadInt16(String)
读取16位的有符号的整型数据
Read 16-bit signed integer data
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt16(String, UInt16)
读取16位的有符号整型数组
Read 16-bit signed integer array
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt16Async(String)
异步读取16位的有符号的整型数据
Asynchronously read 16-bit signed integer data
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt16Async(String, UInt16)
异步读取16位的有符号整型数组
Asynchronously read 16-bit signed integer array
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt32(String)
读取32位的有符号整型
Read 32-bit signed integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt32(String, UInt16)
读取32位有符号整型数组
Read 32-bit signed integer array
(重写 DeviceCommunicationReadInt32(String, UInt16).)
公共方法代码示例ReadInt32Async(String)
异步读取32位的有符号整型
Asynchronously read 32-bit signed integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt32Async(String, UInt16)
异步读取32位有符号整型数组
Asynchronously read 32-bit signed integer array
(重写 DeviceCommunicationReadInt32Async(String, UInt16).)
公共方法代码示例ReadInt64(String)
读取64位的有符号整型
Read 64-bit signed integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt64(String, UInt16)
读取64位的有符号整型数组
Read 64-bit signed integer array
(重写 DeviceCommunicationReadInt64(String, UInt16).)
公共方法代码示例ReadInt64Async(String)
异步读取64位的有符号整型
Asynchronously read 64-bit signed integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadInt64Async(String, UInt16)
异步读取64位的有符号整型数组
Asynchronously read 64-bit signed integer array
(重写 DeviceCommunicationReadInt64Async(String, UInt16).)
公共方法代码示例ReadString(String, UInt16)
读取字符串数据,默认为最常见的ASCII编码
Read string data, default is the most common ASCII encoding
(继承自 DeviceCommunication。)
公共方法代码示例ReadString(String, UInt16, Encoding)
使用指定的编码,读取字符串数据
Reads string data using the specified encoding
(继承自 DeviceCommunication。)
公共方法代码示例ReadStringAsync(String, UInt16)
异步读取字符串数据,默认为最常见的ASCII编码
Asynchronously read string data, default is the most common ASCII encoding
(继承自 DeviceCommunication。)
公共方法代码示例ReadStringAsync(String, UInt16, Encoding)
异步使用指定的编码,读取字符串数据
Asynchronously reads string data using the specified encoding
(继承自 DeviceCommunication。)
公共方法代码示例ReadStructT
读取结构体类型的数据,根据结构体自身的定义,读取原始字节数组,然后解析出实际的结构体数据,结构体需要实现HslStructAttribute特性
(继承自 DeviceCommunication。)
公共方法代码示例ReadStructAsyncT
读取结构体类型的数据,根据结构体自身的定义,读取原始字节数组,然后解析出实际的结构体数据,结构体需要实现HslStructAttribute特性
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt16(String)
读取16位的无符号整型
Read 16-bit unsigned integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt16(String, UInt16)
读取16位的无符号整型数组
Read 16-bit unsigned integer array
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt16Async(String)
异步读取16位的无符号整型
Asynchronously read 16-bit unsigned integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt16Async(String, UInt16)
异步读取16位的无符号整型数组
Asynchronously read 16-bit unsigned integer array
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt32(String)
读取32位的无符号整型
Read 32-bit unsigned integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt32(String, UInt16)
读取32位的无符号整型数组
Read 32-bit unsigned integer array
(重写 DeviceCommunicationReadUInt32(String, UInt16).)
公共方法代码示例ReadUInt32Async(String)
异步读取32位的无符号整型
Asynchronously read 32-bit unsigned integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt32Async(String, UInt16)
异步读取32位的无符号整型数组
Asynchronously read 32-bit unsigned integer array
(重写 DeviceCommunicationReadUInt32Async(String, UInt16).)
公共方法代码示例ReadUInt64(String)
读取64位的无符号整型
Read 64-bit unsigned integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt64(String, UInt16)
读取64位的无符号整型的数组
Read 64-bit unsigned integer array
(重写 DeviceCommunicationReadUInt64(String, UInt16).)
公共方法代码示例ReadUInt64Async(String)
异步读取64位的无符号整型
Asynchronously read 64-bit unsigned integer
(继承自 DeviceCommunication。)
公共方法代码示例ReadUInt64Async(String, UInt16)
异步读取64位的无符号整型的数组
Asynchronously read 64-bit unsigned integer array
(重写 DeviceCommunicationReadUInt64Async(String, UInt16).)
公共方法ReadWrite
使用0x17功能码来实现同时写入并读取数据的操作,使用一条报文来实现,需要指定读取的地址,长度,写入的地址,写入的数据信息,返回读取的结果数据。
Use 0x17 function code to write and read data at the same time, and use a message to implement it, you need to specify the read address, length, written address, written data information, and return the read result data.
公共方法ReadWriteAsync
使用0x17功能码来实现同时写入并读取数据的操作,使用一条报文来实现,需要指定读取的地址,长度,写入的地址,写入的数据信息,返回读取的结果数据。
Use 0x17 function code to write and read data at the same time, and use a message to implement it, you need to specify the read address, length, written address, written data information, and return the read result data.
公共方法RegisteredAddressMapping
注册一个新的地址映射关系,注册地址映射关系后,就可以使用新的地址来读写Modbus数据了,通常用于其他的支持Modbus协议的PLC。
After registering a new address mapping, you can use the new address to read and write Modbus data, which is usually used for other PLCs that support the Modbus protocol.
公共方法SetPersistentConnection 已过时。
V11版本及之前设置长连接的方法,在V12版本以上中没有任何效果,默认长连接,删除调用即可,此处保留方法是为了部分用户保持兼容性升级。
The method of setting the long connection in V11 and before, has no effect in V12 and above. this method can be deleted. The method is retained here to maintain compatibility upgrades for some users.
(继承自 DeviceTcpNet。)
公共方法ToString (重写 DeviceTcpNetToString.)
公共方法TranslateToModbusAddress
将当前的地址信息转换成Modbus格式的地址,如果转换失败,返回失败的消息。默认不进行任何的转换。
Convert the current address information into a Modbus format address. If the conversion fails, a failure message will be returned. No conversion is performed by default.
公共方法UnpackResponseContent
根据对方返回的报文命令,对命令进行基本的拆包,例如各种Modbus协议拆包为统一的核心报文,还支持对报文的验证
According to the message command returned by the other party, the command is basically unpacked, for example, various Modbus protocols are unpacked into a unified core message, and the verification of the message is also supported
(重写 BinaryCommunicationUnpackResponseContent(Byte, Byte).)
公共方法Wait(String, Boolean, Int32, Int32)
等待指定地址的Boolean值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Boolean value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法Wait(String, Int16, Int32, Int32)
等待指定地址的Int16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Int16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法Wait(String, Int32, Int32, Int32)
等待指定地址的Int32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Int32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法Wait(String, Int64, Int32, Int32)
等待指定地址的Int64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Int64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法Wait(String, UInt16, Int32, Int32)
等待指定地址的UInt16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the UInt16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法Wait(String, UInt32, Int32, Int32)
等待指定地址的UInt32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the UInt32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法Wait(String, UInt64, Int32, Int32)
等待指定地址的UInt64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the UInt64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, Boolean, Int32, Int32)
等待指定地址的Boolean值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Boolean value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, Int16, Int32, Int32)
等待指定地址的Int16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Int16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, Int32, Int32, Int32)
等待指定地址的Int32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Int32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, Int64, Int32, Int32)
等待指定地址的Int64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the Int64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, UInt16, Int32, Int32)
等待指定地址的UInt16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the UInt16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, UInt32, Int32, Int32)
等待指定地址的UInt32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the UInt32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法WaitAsync(String, UInt64, Int32, Int32)
等待指定地址的UInt64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。
Waiting for the UInt64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait.
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, Double)
写入double数据,返回是否成功
Write double data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, Int16)
写入short数组,返回是否成功
Write short array, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, Int32)
写入int数据,返回是否成功
Write int data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, Int64)
写入long数据,返回是否成功
Write long data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, Single)
写入float数据,返回是否成功
Write float data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, String)
写入字符串信息,编码为ASCII
Write string information, encoded as ASCII
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, UInt16)
写入ushort数组,返回是否成功
Write ushort array, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, UInt32)
写入uint数据,返回是否成功
Write uint data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, UInt64)
写入ulong数据,返回是否成功
Write ulong data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法Write(String, Boolean)
向线圈中写入bool数值,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x05, 如果你的地址为字地址,例如100.2,那么将使用0x16的功能码,通过掩码的方式来修改寄存器的某一位,需要Modbus服务器支持,否则自动切换为读取字数据,修改位,在写入字的方式。
Write bool value to the coil and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x05. If your address is a word address, such as 100.2, then you will use the function code of 0x16 to modify a bit of the register through a mask. It needs Modbus server support, Otherwise, it automatically switches to read the word data, modifies the bits, and writes the word in the way.
(重写 DeviceCommunicationWrite(String, Boolean).)
公共方法Write(String, Boolean)
向线圈中写入bool数组,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x0F
Write the bool array to the coil, and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x0F.
(重写 DeviceCommunicationWrite(String, Boolean).)
公共方法代码示例Write(String, Byte)
将数据写入到Modbus的寄存器上去,需要指定起始地址和数据内容,如果富文本地址不指定,默认使用的功能码是 0x10
To write data to Modbus registers, you need to specify the start address and data content. If the rich text address is not specified, the default function code is 0x10
(重写 DeviceCommunicationWrite(String, Byte).)
公共方法代码示例Write(String, Double)
写入double数组,返回是否成功
Write double array, return whether the write was successful
(重写 DeviceCommunicationWrite(String, Double).)
公共方法Write(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 DeviceCommunicationWrite(String, Int16).)
公共方法代码示例Write(String, Int32)
写入int[]数组,返回是否成功
Write int array, return whether the write was successful
(重写 DeviceCommunicationWrite(String, Int32).)
公共方法代码示例Write(String, Int64)
写入long数组,返回是否成功
Write long array, return whether the write was successful
(重写 DeviceCommunicationWrite(String, Int64).)
公共方法代码示例Write(String, Single)
写入float数组,返回是否成功
Write float array, return whether the write was successful
(重写 DeviceCommunicationWrite(String, Single).)
公共方法Write(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 DeviceCommunicationWrite(String, UInt16).)
公共方法代码示例Write(String, UInt32)
写入uint[]数组,返回是否成功
Write uint array, return whether the write was successful
(重写 DeviceCommunicationWrite(String, UInt32).)
公共方法代码示例Write(String, UInt64)
写入ulong数组,返回是否成功
Write ulong array, return whether the write was successful
(重写 DeviceCommunicationWrite(String, UInt64).)
公共方法代码示例Write(String, String, Int32)
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII
Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII.
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, String, Encoding)
写入字符串信息,需要指定的编码信息
Write string information, need to specify the encoding information
(继承自 DeviceCommunication。)
公共方法代码示例Write(String, String, Int32, Encoding)
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息
Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information
(继承自 DeviceCommunication。)
公共方法代码示例WriteT(T)
写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Write data that supports the Hsl attribute, and return whether the write was successful. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, Double)
异步写入double数据,返回是否成功
Asynchronously write double data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, Int16)
异步写入short数组,返回是否成功
Asynchronously write short array, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, Int32)
异步写入int数据,返回是否成功
Asynchronously write int data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, Int64)
异步写入long数据,返回是否成功
Asynchronously write long data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, Single)
异步写入float数据,返回是否成功
Asynchronously write float data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, String)
异步写入字符串信息,编码为ASCII
Asynchronously write string information, encoded as ASCII
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, UInt16)
异步写入ushort数组,返回是否成功
Asynchronously write ushort array, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, UInt32)
异步写入uint数据,返回是否成功
Asynchronously write uint data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, UInt64)
异步写入ulong数据,返回是否成功
Asynchronously write ulong data, return whether the write was successful
(继承自 DeviceCommunication。)
公共方法WriteAsync(String, Boolean)
向线圈中写入bool数值,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x05, 如果你的地址为字地址,例如100.2,那么将使用0x16的功能码,通过掩码的方式来修改寄存器的某一位,需要Modbus服务器支持,否则自动切换为读取字数据,修改位,在写入字的方式。
Write bool value to the coil and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x05. If your address is a word address, such as 100.2, then you will use the function code of 0x16 to modify a bit of the register through a mask. It needs Modbus server support, Otherwise, it automatically switches to read the word data, modifies the bits, and writes the word in the way.
(重写 DeviceCommunicationWriteAsync(String, Boolean).)
公共方法WriteAsync(String, Boolean)
向线圈中写入bool数组,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x0F
Write the bool array to the coil, and return whether the writing is successful. If the rich text address is not specified, the default function code is 0x0F.
(重写 DeviceCommunicationWriteAsync(String, Boolean).)
公共方法代码示例WriteAsync(String, Byte)
将数据写入到Modbus的寄存器上去,需要指定起始地址和数据内容,如果富文本地址不指定,默认使用的功能码是 0x10
To write data to Modbus registers, you need to specify the start address and data content. If the rich text address is not specified, the default function code is 0x10
(重写 DeviceCommunicationWriteAsync(String, Byte).)
公共方法代码示例WriteAsync(String, Double)
异步写入double数组,返回是否成功
Asynchronously write double array, return whether the write was successful
(重写 DeviceCommunicationWriteAsync(String, Double).)
公共方法WriteAsync(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 DeviceCommunicationWriteAsync(String, Int16).)
公共方法代码示例WriteAsync(String, Int32)
异步写入int[]数组,返回是否成功
Asynchronously write int array, return whether the write was successful
(重写 DeviceCommunicationWriteAsync(String, Int32).)
公共方法代码示例WriteAsync(String, Int64)
异步写入long数组,返回是否成功
Asynchronously write long array, return whether the write was successful
(重写 DeviceCommunicationWriteAsync(String, Int64).)
公共方法代码示例WriteAsync(String, Single)
异步写入float数组,返回是否成功
Asynchronously write float array, return whether the write was successful
(重写 DeviceCommunicationWriteAsync(String, Single).)
公共方法WriteAsync(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
(重写 DeviceCommunicationWriteAsync(String, UInt16).)
公共方法代码示例WriteAsync(String, UInt32)
异步写入uint[]数组,返回是否成功
Asynchronously write uint array, return whether the write was successful
(重写 DeviceCommunicationWriteAsync(String, UInt32).)
公共方法代码示例WriteAsync(String, UInt64)
异步写入ulong数组,返回是否成功
Asynchronously write ulong array, return whether the write was successful
(重写 DeviceCommunicationWriteAsync(String, UInt64).)
公共方法WriteAsync(String, String, Int32)
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII
Asynchronously write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII.
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsync(String, String, Encoding)
异步写入字符串信息,需要指定的编码信息
Asynchronously write string information, need to specify the encoding information
(继承自 DeviceCommunication。)
公共方法WriteAsync(String, String, Int32, Encoding)
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息
Asynchronously write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information
(继承自 DeviceCommunication。)
公共方法代码示例WriteAsyncT(T)
异步写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明
Asynchronously write data that supports the Hsl attribute, and return whether the write was successful. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details.
(继承自 DeviceCommunication。)
公共方法代码示例WriteCustomerT
写入自定义类型的数据,该类型必须继承自IDataTransfer接口
Write data of a custom type, which must inherit from the IDataTransfer interface
(继承自 DeviceCommunication。)
公共方法代码示例WriteCustomerAsyncT
写入自定义类型的数据,该类型必须继承自IDataTransfer接口
Write data of a custom type, which must inherit from the IDataTransfer interface
(继承自 DeviceCommunication。)
公共方法WriteMask
向设备写入掩码数据,使用0x16功能码,需要确认对方是否支持相关的操作,掩码数据的操作主要针对寄存器。
To write mask data to the server, using the 0x16 function code, you need to confirm whether the other party supports related operations. The operation of mask data is mainly directed to the register.
公共方法WriteMaskAsync
向设备写入掩码数据,使用0x16功能码,需要确认对方是否支持相关的操作,掩码数据的操作主要针对寄存器。
To write mask data to the server, using the 0x16 function code, you need to confirm whether the other party supports related operations. The operation of mask data is mainly directed to the register.
公共方法WriteOneRegister(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
公共方法WriteOneRegister(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
公共方法WriteOneRegisterAsync(String, Int16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
公共方法WriteOneRegisterAsync(String, UInt16)
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06
To write data to a single register of Modbus, you need to specify the start address and data value. If the rich text address is not specified, the default function code is 0x06.
Top
字段
  名称说明
受保护的字段LogMsgFormatBinary
设置日志记录报文是否二进制,如果为False,那就使用ASCII码
Set whether the log message is binary, if it is False, then use ASCII code
(继承自 BinaryCommunication。)
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
备注
本客户端支持的标准的modbus协议,Modbus-Tcp及Modbus-Udp内置的消息号会进行自增,地址支持富文本格式,具体参考示例代码。
读取线圈,输入线圈,寄存器,输入寄存器的方法中的读取长度对商业授权用户不限制,内部自动切割读取,结果合并。
示例
本客户端支持的标准的modbus协议,Modbus-Tcp及Modbus-Udp内置的消息号会进行自增,比如我们想要控制消息号在0-1000之间自增,不能超过一千,可以写如下的代码:
序号示例
// modbus-tcp和udp的例子是一样的,只是实例化方面不一样,对于rtu及ascii则没有消息号这一个功能
ModbusTcpNet modbusTcp = new ModbusTcpNet( "127.0.0.1", 502 );
// 如果是modbus-udp
ModbusUdpNet modbusUdp = new ModbusUdpNet( "127.0.0.1", 502 );

// 重置最大值,这样的话,消息号就在0-1000
modbusTcp.MessageId.ResetMaxValue( 1000 );

// 如果我们需要一直保持消息号在0,不需要增长的计数
modbusTcp.MessageId.IncreaseTick = 0;

// 同理,我们需要消息号保持在1000
modbusTcp.MessageId.ResetCurrentValue( 1000 );
modbusTcp.MessageId.IncreaseTick = 0;

// 如果消息号需要为1,3,5,7,9,......999
modbusTcp.MessageId.ResetStartValue( 1 );
modbusTcp.MessageId.ResetMaxValue( 999 );
modbusTcp.MessageId.IncreaseTick = 2;

// 更加详细的用法需要参考SoftIncrementCount类
在标准的Modbus协议里面,客户端发送消息ID给服务器,服务器是需要复制返回客户端的,在HSL里会默认进行检查操作,如果想要忽略消息ID一致性的检查,可以编写如下的方法。
重要事项 重要事项
地址共可以携带4个信息,常见的使用表示方式"s=2;x=3;100",对应的modbus报文是 02 03 00 64 00 01 的前四个字节,站号,功能码,起始地址,下面举例
当读写int, uint, float, double, long, ulong类型的时候,支持动态指定数据格式,也就是 DataFormat 信息,本部分内容为商业授权用户专有,感谢支持。
ReadInt32("format=BADC;100") 指示使用BADC的格式来解析byte数组,从而获得int数据,同时支持和站号信息叠加,例如:ReadInt32("format=BADC;s=2;100")
读取线圈
ReadCoil("100")表示读取线圈100的值,ReadCoil("s=2;100")表示读取站号为2,线圈地址为100的值
读取离散输入
ReadDiscrete("100")表示读取离散输入100的值,ReadDiscrete("s=2;100")表示读取站号为2,离散地址为100的值
读取寄存器
ReadInt16("100")表示读取寄存器100的值,ReadInt16("s=2;100")表示读取站号为2,寄存器100的值
读取输入寄存器
ReadInt16("x=4;100")表示读取输入寄存器100的值,ReadInt16("s=2;x=4;100")表示读取站号为2,输入寄存器100的值
读取寄存器的位
ReadBool("100.0")表示读取寄存器100第0位的值,ReadBool("s=2;100.0")表示读取站号为2,寄存器100第0位的值,支持读连续的多个位
读取输入寄存器的位
ReadBool("x=4;100.0")表示读取输入寄存器100第0位的值,ReadBool("s=2;x=4;100.0")表示读取站号为2,输入寄存器100第0位的值,支持读连续的多个位
对于写入来说也是一致的
写入线圈
WriteCoil("100",true)表示读取线圈100的值,WriteCoil("s=2;100",true)表示读取站号为2,线圈地址为100的值
写入寄存器
Write("100",(short)123)表示写寄存器100的值123,Write("s=2;100",(short)123)表示写入站号为2,寄存器100的值123
特殊说明部分:
当碰到自定义的功能码时,比如读取功能码 07,写入功能码 08 的自定义寄存器时,地址可以这么写
ReadInt16("s=2;x=7;w=8;100")表示读取这个自定义寄存器地址 100 的数据,读取使用的是 07 功能码,写入使用的是 08 功能码,也就是说 w=8 可以强制指定写入的功能码信息
01功能码
ReadBool("100")
02功能码
ReadBool("x=2;100")
03功能码
Read("100")
04功能码
Read("x=4;100")
05功能码
Write("100", True)
06功能码
Write("100", (short)100);Write("100", (ushort)100)
0F功能码
Write("100", new bool[]{True}) 注意:这里和05功能码传递的参数类型不一样
10功能码
如果写一个short想用10功能码:Write("100", new short[]{100})
16功能码
Write("100.2", True) 当写入bool值的方法里,地址格式变为字地址时,就使用16功能码,通过掩码的方式来修改寄存器的某一位, 需要Modbus服务器支持,对于不支持该功能码的写入无效。
特别说明:调用写入 short 及 ushort 类型写入方法时,自动使用06功能码写入。需要需要使用 16 功能码写入 short 数值,可以参考下面的两种方式:
1. modbus.Write("100", new short[]{ 1 });
2. modbus.Write("w=16;100", (short)1); (这个地址读short也能读取到正确的值)
基本的用法请参照下面的代码示例
Modbus示例
// 本类支持的读写操作提供了非常多的重载方法,总有你想要的方法
private ModbusTcpNet modbus = new ModbusTcpNet( "192.168.0.1" );   // 实例化
// 如果你的是rtu
private ModbusRtu modbusRtu = new ModbusRtu( 1 );// 实例化

// 方法的调用都是一模一样的。

private void CoilExample()
{
    // 读取线圈示例,使用01功能码
    bool coil100 = modbus.ReadCoil( "100" ).Content;

    // 判断是否读取成功
    OperateResult<bool> result_coil100 = modbus.ReadCoil( "100" );
    if(result_coil100.IsSuccess)
    {
        // success
        bool value = result_coil100.Content;
    }
    else
    {
        // failed
    }

    // 假设读取站号10的线圈100的值
    bool coil_station_ten_100 = modbus.ReadCoil( "s=10;100" ).Content;

    // =============================================================================================
    // 写入也是同理,线圈100写通,使用的是05功能码
    modbus.Write( "100", true );

    // 站号10的线圈写通
    modbus.Write( "s=10;100", true );

    // 想要判断是否写入成功
    if(modbus.Write( "s=10;100", true ).IsSuccess)
    {
        // success
    }
    else
    {
        // failed
    }



    // ===========================================================================================
    // 批量读写也是类似,批量的读取,使用01功能码
    bool[] coil10_19 = modbus.ReadCoil( "100", 10 ).Content;

    // 写入也是同理,使用的0F功能码
    modbus.Write( "100", new bool[] { true, false, true, false, false, false, true, false, false, false } );


    // 离散输入的数据读取同理
    ModbusTcpNet plc = modbus;
    OperateResult write = plc.Write( "100", "ABCDEF" );
    if (write.IsSuccess)
        Console.WriteLine( "Write Address[100] Success!" );
    else
        Console.WriteLine( "Write Address[100] failed: " + write.Message );

    OperateResult<string> read = plc.ReadString( "100", 3 );
    if (read.IsSuccess)
        Console.WriteLine( "Read Address[100] Success: " + read.Content );
    else
        Console.WriteLine( "Read Address[100] Failed: " + read.Message );

}


private void RegisterExample( )
{
    // 读取寄存器100的值,使用的03功能码
    short register100 = modbus.ReadInt16( "100" ).Content;

    // 批量读取寄存器100-109的值
    short[] register100_109 = modbus.ReadInt16( "100", 10 ).Content;

    // 写入寄存器100的值,注意,一定要强制转换short类型,使用的是06功能码
    modbus.Write( "100", (short)123 );

    // 批量写,使用的是10功能码
    modbus.Write( "100", new short[] { 123, -123, 4244 } );


    // ==============================================================================================
    // 以下是一些常规的操作,不再对是否成功的结果进行判断
    // 读取操作,除了第一个,其他都是03功能码
    bool coil100 = modbus.ReadCoil( "100" ).Content;          // 读取线圈100的通断,01功能码
    short short100 = modbus.ReadInt16( "100" ).Content;       // 读取寄存器100的short值
    ushort ushort100 = modbus.ReadUInt16( "100" ).Content;    // 读取寄存器100的ushort值
    int int100 = modbus.ReadInt32( "100" ).Content;           // 读取寄存器100-101的int值
    uint uint100 = modbus.ReadUInt32( "100" ).Content;        // 读取寄存器100-101的uint值
    float float100 = modbus.ReadFloat( "100" ).Content;       // 读取寄存器100-101的float值
    long long100 = modbus.ReadInt64( "100" ).Content;         // 读取寄存器100-103的long值
    ulong ulong100 = modbus.ReadUInt64( "100" ).Content;      // 读取寄存器100-103的ulong值
    double double100 = modbus.ReadDouble( "100" ).Content;    // 读取寄存器100-103的double值
    string str100 = modbus.ReadString( "100", 5 ).Content;    // 读取100到104共10个字符的字符串

    // 写入操作,第一个05功能码,第二第三是06功能码,后面是10功能码
    modbus.Write( "100", true );                              // 写入线圈100为通
    modbus.Write( "100", (short)12345 );                      // 写入寄存器100为12345
    modbus.Write( "100", (ushort)45678 );                     // 写入寄存器100为45678
    modbus.Write( "100", 123456789 );                         // 写入寄存器100-101为123456789
    modbus.Write( "100", (uint)123456778 );                   // 写入寄存器100-101为123456778
    modbus.Write( "100", 123.456 );                           // 写入寄存器100-101为123.456
    modbus.Write( "100", 12312312312414L );                   //写入寄存器100-103为一个大数据
    modbus.Write( "100", 12634534534543656UL );               // 写入寄存器100-103为一个大数据
    modbus.Write( "100", 123.456d );                          // 写入寄存器100-103为一个双精度的数据
    modbus.Write( "100", "K123456789" );
    modbus.Write( "100", "测试数据", Encoding.Unicode );      // 写入unicode编码的中文

    // ===============================================================================================
    // 读取输入寄存器,使用的04功能码
    short input_short100 = modbus.ReadInt16( "x=4;100" ).Content;    // 读取寄存器100的short值
    ushort input_ushort100 = modbus.ReadUInt16( "x=4;100" ).Content; // 读取寄存器100的ushort值
    int input_int100 = modbus.ReadInt32( "x=4;100" ).Content;        // 读取寄存器100-101的int值
    uint input_uint100 = modbus.ReadUInt32( "x=4;100" ).Content;     // 读取寄存器100-101的uint值
    float input_float100 = modbus.ReadFloat( "x=4;100" ).Content;    // 读取寄存器100-101的float值
    long input_long100 = modbus.ReadInt64( "x=4;100" ).Content;      // 读取寄存器100-103的long值
    ulong input_ulong100 = modbus.ReadUInt64( "x=4;100" ).Content;   // 读取寄存器100-103的ulong值
    double input_double100 = modbus.ReadDouble( "x=4;100" ).Content; // 读取寄存器100-103的double值
    string input_str100 = modbus.ReadString( "x=4;100", 5 ).Content; // 读取100到104共10个字符的字符串
}
参见
继承层次
SystemObject
  HslCommunication.Core.NetBinaryCommunication
    HslCommunication.Core.DeviceDeviceCommunication
      HslCommunication.Core.DeviceDeviceTcpNet
        HslCommunication.ModBusModbusTcpNet
          HslCommunication.DCSDcsNanJingAuto
          HslCommunication.ModBusModbusUdpNet
          HslCommunication.Profinet.DeltaDeltaTcpNet
          HslCommunication.Profinet.InovanceInovanceTcpNet
          HslCommunication.Profinet.MegMeetMegMeetTcpNet
          HslCommunication.Profinet.XINJEXinJETcpNet
          HslCommunication.Robot.EstunEstunTcpNet