DcsNanJingAuto 类 |
命名空间: HslCommunication.DCS
DcsNanJingAuto 类型公开以下成员。
名称 | 说明 | |
---|---|---|
DcsNanJingAuto |
实例化一个默认的对象 Instantiate a default object | |
DcsNanJingAuto(String, Int32, Byte) |
指定服务器地址,端口号,客户端自己的站号来初始化 Specify the server address, port number, and client's own station number to initialize |
名称 | 说明 | |
---|---|---|
AddressStartWithZero |
获取或设置起始的地址是否从0开始,默认为True (继承自 ModbusTcpNet。)Gets or sets whether the starting address starts from 0. The default is True | |
BroadcastStation |
获取或是设置当前广播模式对应的站号,广播模式意味着不接收设备方的数据返回操作,默认为 -1,表示不使用广播模式。 (继承自 ModbusTcpNet。)Gets or sets the station number corresponding to the current broadcast mode. Broadcast mode means that the data return operation of the device is not received. The default value is -1, indicating that broadcast mode is not used. | |
ByteTransform |
当前的数据变换机制,当你需要从字节数据转换类型数据的时候需要。 (继承自 DeviceCommunication。)The current data transformation mechanism is required when you need to convert type data from byte data. | |
CommunicationPipe | (继承自 BinaryCommunication。) | |
ConnectionId |
当前连接的唯一ID号,默认为长度20的guid码加随机数组成,方便列表管理,也可以自己指定 (继承自 BinaryCommunication。)The unique ID number of the current connection. The default is a 20-digit guid code plus a random number. | |
ConnectTimeOut |
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈 (继承自 DeviceTcpNet。)Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback | |
DataFormat |
获取或设置数据解析的格式,可选ABCD, BADC,CDAB,DCBA格式,对int,uint,float,double,long,ulong类型有作用 (继承自 ModbusTcpNet。)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 时,再执行写入位时,会通过读字,修改位,写字的方式来间接实现。 (继承自 ModbusTcpNet。)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 (继承自 DeviceTcpNet。)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 | |
IsCheckMessageId |
获取或设置是否进行检查返回的消息ID和发送的消息ID是否一致,默认为true,也就是检查 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)Whether the string data is reversed according to words. The default is False. | |
LocalBinding |
获取或设置绑定的本地的IP地址和端口号信息,如果端口设置为0,代表任何可用的端口 (继承自 DeviceTcpNet。)Get or set the bound local IP address and port number information, if the port is set to 0, it means any available port | |
LogNet |
组件的日志工具,支持日志记录,只要实例化后,当前网络的基本信息,就以DEBUG等级进行输出 (继承自 BinaryCommunication。)The component's logging tool supports logging. As long as the instantiation of the basic network information, the output will be output at DEBUG | |
MessageId |
获取modbus协议自增的消息号,你可以自定义modbus的消息号的规则,详细参见ModbusTcpNet说明,也可以查找SoftIncrementCount说明。 (继承自 ModbusTcpNet。)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 |
获取或设置服务器的端口号,具体的值需要取决于对方的配置 (继承自 DeviceTcpNet。)Gets or sets the port number of the server. The specific value depends on the configuration of the other party. | |
ReceiveTimeOut |
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈 (继承自 BinaryCommunication。)Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback | |
SendBeforeHex |
获取或设置在发送通信报文前追加发送的字节信息,HEX格式,通常用于lora组网时,需要携带 00 00 00 02 四个字节的站地址功能。 (继承自 BinaryCommunication。)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. | |
SleepTime |
获取或设置在正式接收对方返回数据前的时候,需要休息的时间,当设置为0的时候,不需要休息。 (继承自 BinaryCommunication。)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. | |
SocketKeepAliveTime |
获取或设置客户端的Socket的心跳时间信息,这个是Socket底层自动实现的心跳包,不基于协议层实现。默认小于0,不开启心跳检测,如果需要开启,设置 60_000 比较合适,单位毫秒 (继承自 DeviceTcpNet。)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. | |
Station |
获取或者重新修改服务器的默认站号信息,当然,你可以再读写的时候动态指定,例如地址 "s=2;100", 更详细的例子可以参考DEMO界面上的地址示例。 (继承自 ModbusTcpNet。)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无效 (继承自 DeviceCommunication。)The address length represented by one word of data, Siemens is 2, Mitsubishi, Omron, modbusTcp is 1, AB PLC is invalid |
名称 | 说明 | |
---|---|---|
ConnectClose |
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式 (继承自 DeviceTcpNet。)Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode | |
ConnectCloseAsync |
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式 (继承自 DeviceTcpNet。)Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode | |
ConnectServer |
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速 (继承自 DeviceTcpNet。)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. | |
ConnectServerAsync |
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速 (继承自 DeviceTcpNet。)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. | |
DecideWhetherQAMessage |
决定当前的消息是否是用于问答机制返回的消息,默认直接返回 true, 实际的情况需要根据协议进行重写方法 (继承自 BinaryCommunication。)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 | |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (继承自 DeviceCommunication。) | |
Dispose(Boolean) | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (继承自 DeviceCommunication。) | |
Equals | Determines whether the specified object is equal to the current object. (继承自 Object。) | |
ExtraAfterReadFromCoreServer |
和服务器交互完成的时候调用的方法,可以根据读写结果进行一些额外的操作,具体的操作需要根据实际的需求来重写实现 (继承自 BinaryCommunication。)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. | |
ExtraOnDisconnect |
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道 (继承自 BinaryCommunication。)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. | |
ExtraOnDisconnectAsync |
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道 (继承自 BinaryCommunication。)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. | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (继承自 Object。) | |
GetHashCode | Serves as the default hash function. (继承自 Object。) | |
GetLogTextFromBinary |
获取当前的报文进行日志记录的时候,是否使用二进制的格式记录,默认返回 LogMsgFormatBinary,重写可以根据session对象分别返回不同记录模式 (继承自 BinaryCommunication。)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 | |
GetNewNetMessage |
获取一个新的消息对象的方法,需要在继承类里面进行重写 (重写 ModbusTcpNetGetNewNetMessage.)The method to get a new message object needs to be overridden in the inheritance class | |
GetType | Gets the Type of the current instance. (继承自 Object。) | |
GetWordLength |
一个字单位的数据表示的地址长度,西门子为2,三菱,欧姆龙,modbusTcp就为1,AB PLC无效 (继承自 DeviceCommunication。)The address length represented by one word of data, Siemens is 2, Mitsubishi, Omron, modbusTcp is 1, AB PLC is invalid | |
InitializationOnConnect |
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。 (重写 BinaryCommunicationInitializationOnConnect.)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. | |
InitializationOnConnectAsync |
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。 (重写 BinaryCommunicationInitializationOnConnectAsync.)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. | |
IpAddressPing |
对当前设备的IP地址进行PING的操作,返回PING的结果,正常来说,返回Success (继承自 DeviceTcpNet。)PING the IP address of the current device and return the PING result. Normally, it returns Success | |
LogRevcMessage(Byte) |
使用日志记录一个接收的报文信息 (继承自 BinaryCommunication。)` Logs are used to record information about a received packet | |
LogRevcMessage(Byte, PipeSession) |
使用日志记录一个接收的报文信息 (继承自 BinaryCommunication。)` Logs are used to record information about a received packet | |
LogSendMessage(Byte) |
使用日志记录一个发送的报文信息 (继承自 BinaryCommunication。)Logs are used to record information about a send packet | |
LogSendMessage(Byte, PipeSession) |
使用日志记录一个发送的报文信息 (继承自 BinaryCommunication。)Logs are used to record information about a send packet | |
MemberwiseClone | Creates a shallow copy of the current Object. (继承自 Object。) | |
PackCommandWithHeader |
对当前的命令进行打包处理,通常是携带命令头内容,标记当前的命令的长度信息,需要进行重写,否则默认不打包 (继承自 ModbusTcpNet。)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 | |
Read(String, UInt16) |
从Modbus服务器批量读取寄存器的信息,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x03,如果需要使用04功能码,那么地址就写成 x=4;100 (继承自 ModbusTcpNet。)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 | |
ReadT |
读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明,或是官网的详细文档 (继承自 DeviceCommunication。)Read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details. | |
ReadAsync(String, UInt16) |
从Modbus服务器批量读取寄存器的信息,需要指定起始地址,读取长度,如果富文本地址不指定,默认使用的功能码是 0x03,如果需要使用04功能码,那么地址就写成 x=4;100 (继承自 ModbusTcpNet。)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 | |
ReadAsyncT |
异步读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明 (继承自 DeviceCommunication。)Asynchronously read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details. | |
ReadBool(String) |
读取单个的Boolean数据信息 (继承自 DeviceCommunication。)Read a single Boolean data message | |
ReadBool(String, UInt16) |
批量读取线圈或是离散的数据信息,需要指定地址和长度,具体的结果取决于实现,如果富文本地址不指定,默认使用的功能码是 0x01 (继承自 ModbusTcpNet。)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. | |
ReadBoolAsync(String) |
异步读取单个的Boolean数据信息 (继承自 DeviceCommunication。)Asynchronously read a single Boolean data message | |
ReadBoolAsync(String, UInt16) |
批量读取线圈或是离散的数据信息,需要指定地址和长度,具体的结果取决于实现,如果富文本地址不指定,默认使用的功能码是 0x01 (继承自 ModbusTcpNet。)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. | |
ReadCoil(String) |
读取线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x01 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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接口,返回一个新的类型的实例对象。 (继承自 DeviceCommunication。)To read a custom data type, you need to inherit from the IDataTransfer interface and return an instance object of a new type. | |
ReadCustomerT(String, T) |
读取自定义的数据类型,需要继承自IDataTransfer接口,传入一个实例,对这个实例进行赋值,并返回该实例的对象。 (继承自 DeviceCommunication。)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. | |
ReadCustomerAsyncT(String) |
读取自定义的数据类型,需要继承自IDataTransfer接口,返回一个新的类型的实例对象。 (继承自 DeviceCommunication。)To read a custom data type, you need to inherit from the IDataTransfer interface and return an instance object of a new type. | |
ReadCustomerAsyncT(String, T) |
读取自定义的数据类型,需要继承自IDataTransfer接口,传入一个实例,对这个实例进行赋值,并返回该实例的对象。 (继承自 DeviceCommunication。)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. | |
ReadDiscrete(String) |
读取输入线圈,需要指定起始地址,如果富文本地址不指定,默认使用的功能码是 0x02 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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) |
读取双浮点的数据 (继承自 DeviceCommunication。)Read double floating point data | |
ReadDouble(String, UInt16) |
读取双浮点数据的数组 (继承自 ModbusTcpNet。)Read double floating point data array | |
ReadDoubleAsync(String) |
异步读取双浮点的数据 (继承自 DeviceCommunication。)Asynchronously read double floating point data | |
ReadDoubleAsync(String, UInt16) |
异步读取双浮点数据的数组 (继承自 ModbusTcpNet。)Asynchronously read double floating point data array | |
ReadFloat(String) |
读取单浮点数据 (继承自 DeviceCommunication。)Read single floating point data | |
ReadFloat(String, UInt16) |
读取单浮点精度的数组 (继承自 ModbusTcpNet。)Read single floating point array | |
ReadFloatAsync(String) |
异步读取单浮点数据 (继承自 DeviceCommunication。)Asynchronously read single floating point data | |
ReadFloatAsync(String, UInt16) |
异步读取单浮点精度的数组 (继承自 ModbusTcpNet。)Asynchronously read single floating point array | |
ReadFromCoreServer(IEnumerableByte) |
将多个数据报文按顺序发到设备,并从设备接收返回的数据内容,然后拼接成一个Byte[]信息,需要重写UnpackResponseContent(Byte, Byte)方法才能返回正确的结果。 (继承自 BinaryCommunication。)Send multiple data packets to the device in sequence, and receive the returned data content from the device, and then splicing them into a Byte[] message, you need to rewrite UnpackResponseContent(Byte, Byte) method to return the correct result. | |
ReadFromCoreServer(Byte) |
将Modbus报文数据发送到当前的通道中,并从通道中接收Modbus的报文,通道将根据当前连接自动获取,本方法是线程安全的。 (继承自 ModbusTcpNet。)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. | |
ReadFromCoreServer(Byte, Boolean, Boolean) |
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。 (继承自 BinaryCommunication。)Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object | |
ReadFromCoreServer(CommunicationPipe, Byte, Boolean, Boolean) |
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(重写 BinaryCommunicationReadFromCoreServer(CommunicationPipe, Byte, Boolean, Boolean).) | |
ReadFromCoreServerAsync(IEnumerableByte) |
将多个数据报文按顺序发到设备,并从设备接收返回的数据内容,然后拼接成一个Byte[]信息,需要重写UnpackResponseContent(Byte, Byte)方法才能返回正确的结果。 (继承自 BinaryCommunication。)Send multiple data packets to the device in sequence, and receive the returned data content from the device, and then splicing them into a Byte[] message, you need to rewrite UnpackResponseContent(Byte, Byte) method to return the correct result. | |
ReadFromCoreServerAsync(Byte) |
将Modbus报文数据发送到当前的通道中,并从通道中接收Modbus的报文,通道将根据当前连接自动获取,本方法是线程安全的。 (继承自 ModbusTcpNet。)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. | |
ReadFromCoreServerAsync(Byte, Boolean, Boolean) |
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。 (继承自 BinaryCommunication。)Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object | |
ReadFromCoreServerAsync(CommunicationPipe, Byte, Boolean, Boolean) |
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(重写 BinaryCommunicationReadFromCoreServerAsync(CommunicationPipe, Byte, Boolean, Boolean).) | |
ReadInt16(String) |
读取16位的有符号的整型数据 (继承自 DeviceCommunication。)Read 16-bit signed integer data | |
ReadInt16(String, UInt16) |
读取16位的有符号整型数组 (继承自 DeviceCommunication。)Read 16-bit signed integer array | |
ReadInt16Async(String) |
异步读取16位的有符号的整型数据 (继承自 DeviceCommunication。)Asynchronously read 16-bit signed integer data | |
ReadInt16Async(String, UInt16) |
异步读取16位的有符号整型数组 (继承自 DeviceCommunication。)Asynchronously read 16-bit signed integer array | |
ReadInt32(String) |
读取32位的有符号整型 (继承自 DeviceCommunication。)Read 32-bit signed integer | |
ReadInt32(String, UInt16) |
读取32位有符号整型数组 (继承自 ModbusTcpNet。)Read 32-bit signed integer array | |
ReadInt32Async(String) |
异步读取32位的有符号整型 (继承自 DeviceCommunication。)Asynchronously read 32-bit signed integer | |
ReadInt32Async(String, UInt16) |
异步读取32位有符号整型数组 (继承自 ModbusTcpNet。)Asynchronously read 32-bit signed integer array | |
ReadInt64(String) |
读取64位的有符号整型 (继承自 DeviceCommunication。)Read 64-bit signed integer | |
ReadInt64(String, UInt16) |
读取64位的有符号整型数组 (继承自 ModbusTcpNet。)Read 64-bit signed integer array | |
ReadInt64Async(String) |
异步读取64位的有符号整型 (继承自 DeviceCommunication。)Asynchronously read 64-bit signed integer | |
ReadInt64Async(String, UInt16) |
异步读取64位的有符号整型数组 (继承自 ModbusTcpNet。)Asynchronously read 64-bit signed integer array | |
ReadString(String, UInt16) |
读取字符串数据,默认为最常见的ASCII编码 (继承自 DeviceCommunication。)Read string data, default is the most common ASCII encoding | |
ReadString(String, UInt16, Encoding) |
使用指定的编码,读取字符串数据 (继承自 DeviceCommunication。)Reads string data using the specified encoding | |
ReadStringAsync(String, UInt16) |
异步读取字符串数据,默认为最常见的ASCII编码 (继承自 DeviceCommunication。)Asynchronously read string data, default is the most common ASCII encoding | |
ReadStringAsync(String, UInt16, Encoding) |
异步使用指定的编码,读取字符串数据 (继承自 DeviceCommunication。)Asynchronously reads string data using the specified encoding | |
ReadStructT |
读取结构体类型的数据,根据结构体自身的定义,读取原始字节数组,然后解析出实际的结构体数据,结构体需要实现HslStructAttribute特性
(继承自 DeviceCommunication。) | |
ReadStructAsyncT |
读取结构体类型的数据,根据结构体自身的定义,读取原始字节数组,然后解析出实际的结构体数据,结构体需要实现HslStructAttribute特性
(继承自 DeviceCommunication。) | |
ReadUInt16(String) |
读取16位的无符号整型 (继承自 DeviceCommunication。)Read 16-bit unsigned integer | |
ReadUInt16(String, UInt16) |
读取16位的无符号整型数组 (继承自 DeviceCommunication。)Read 16-bit unsigned integer array | |
ReadUInt16Async(String) |
异步读取16位的无符号整型 (继承自 DeviceCommunication。)Asynchronously read 16-bit unsigned integer | |
ReadUInt16Async(String, UInt16) |
异步读取16位的无符号整型数组 (继承自 DeviceCommunication。)Asynchronously read 16-bit unsigned integer array | |
ReadUInt32(String) |
读取32位的无符号整型 (继承自 DeviceCommunication。)Read 32-bit unsigned integer | |
ReadUInt32(String, UInt16) |
读取32位的无符号整型数组 (继承自 ModbusTcpNet。)Read 32-bit unsigned integer array | |
ReadUInt32Async(String) |
异步读取32位的无符号整型 (继承自 DeviceCommunication。)Asynchronously read 32-bit unsigned integer | |
ReadUInt32Async(String, UInt16) |
异步读取32位的无符号整型数组 (继承自 ModbusTcpNet。)Asynchronously read 32-bit unsigned integer array | |
ReadUInt64(String) |
读取64位的无符号整型 (继承自 DeviceCommunication。)Read 64-bit unsigned integer | |
ReadUInt64(String, UInt16) |
读取64位的无符号整型的数组 (继承自 ModbusTcpNet。)Read 64-bit unsigned integer array | |
ReadUInt64Async(String) |
异步读取64位的无符号整型 (继承自 DeviceCommunication。)Asynchronously read 64-bit unsigned integer | |
ReadUInt64Async(String, UInt16) |
异步读取64位的无符号整型的数组 (继承自 ModbusTcpNet。)Asynchronously read 64-bit unsigned integer array | |
ReadWrite |
使用0x17功能码来实现同时写入并读取数据的操作,使用一条报文来实现,需要指定读取的地址,长度,写入的地址,写入的数据信息,返回读取的结果数据。 (继承自 ModbusTcpNet。)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功能码来实现同时写入并读取数据的操作,使用一条报文来实现,需要指定读取的地址,长度,写入的地址,写入的数据信息,返回读取的结果数据。 (继承自 ModbusTcpNet。)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。 (继承自 ModbusTcpNet。)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. | |
SetDtuPipe |
将当前的通信对象设置DTU模式,允许传入现成的管道,并返回初始化结果,如果该设备重写了握手报文,就是返回握手结果 (继承自 BinaryCommunication。)Set the current communication object to DTU mode, allow the existing pipe to be passed in, and return the initialization result, if the device rewrites the handshake packet, the handshake result is returned | |
SetDtuPipeAsync |
将当前的通信对象设置DTU模式,允许传入现成的管道,并返回初始化结果,如果该设备重写了握手报文,就是返回握手结果 (继承自 BinaryCommunication。)Set the current communication object to DTU mode, allow the existing pipe to be passed in, and return the initialization result, if the device rewrites the handshake packet, the handshake result is returned | |
SetPersistentConnection |
已过时。
V11版本及之前设置长连接的方法,在V12版本以上中没有任何效果,默认长连接,删除调用即可,此处保留方法是为了部分用户保持兼容性升级。 (继承自 DeviceTcpNet。)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. | |
ToString | Returns a string that represents the current object. (继承自 ModbusTcpNet。) | |
TranslateToModbusAddress |
将当前的地址信息转换成Modbus格式的地址,如果转换失败,返回失败的消息。默认不进行任何的转换。 (继承自 ModbusTcpNet。)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协议拆包为统一的核心报文,还支持对报文的验证 (继承自 ModbusTcpNet。)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 | |
Wait(String, Boolean, Int32, Int32) |
等待指定地址的Boolean值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Wait(String, Int16, Int32, Int32) |
等待指定地址的Int16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Wait(String, Int32, Int32, Int32) |
等待指定地址的Int32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Wait(String, Int64, Int32, Int32) |
等待指定地址的Int64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Wait(String, UInt16, Int32, Int32) |
等待指定地址的UInt16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Wait(String, UInt32, Int32, Int32) |
等待指定地址的UInt32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Wait(String, UInt64, Int32, Int32) |
等待指定地址的UInt64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, Boolean, Int32, Int32) |
等待指定地址的Boolean值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, Int16, Int32, Int32) |
等待指定地址的Int16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, Int32, Int32, Int32) |
等待指定地址的Int32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, Int64, Int32, Int32) |
等待指定地址的Int64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, UInt16, Int32, Int32) |
等待指定地址的UInt16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, UInt32, Int32, Int32) |
等待指定地址的UInt32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
WaitAsync(String, UInt64, Int32, Int32) |
等待指定地址的UInt64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 (继承自 DeviceCommunication。)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. | |
Write(String, Double) |
写入double数据,返回是否成功 (继承自 DeviceCommunication。)Write double data, return whether the write was successful | |
Write(String, Int16) |
写入short数组,返回是否成功 (继承自 DeviceCommunication。)Write short array, return whether the write was successful | |
Write(String, Int32) |
写入int数据,返回是否成功 (继承自 DeviceCommunication。)Write int data, return whether the write was successful | |
Write(String, Int64) |
写入long数据,返回是否成功 (继承自 DeviceCommunication。)Write long data, return whether the write was successful | |
Write(String, Single) |
写入float数据,返回是否成功 (继承自 DeviceCommunication。)Write float data, return whether the write was successful | |
Write(String, String) |
写入字符串信息,编码为ASCII (继承自 DeviceCommunication。)Write string information, encoded as ASCII | |
Write(String, UInt16) |
写入ushort数组,返回是否成功 (继承自 DeviceCommunication。)Write ushort array, return whether the write was successful | |
Write(String, UInt32) |
写入uint数据,返回是否成功 (继承自 DeviceCommunication。)Write uint data, return whether the write was successful | |
Write(String, UInt64) |
写入ulong数据,返回是否成功 (继承自 DeviceCommunication。)Write ulong data, return whether the write was successful | |
Write(String, Boolean) |
向线圈中写入bool数值,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x05,
如果你的地址为字地址,例如100.2,那么将使用0x16的功能码,通过掩码的方式来修改寄存器的某一位,需要Modbus服务器支持,否则自动切换为读取字数据,修改位,在写入字的方式。 (继承自 ModbusTcpNet。)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. | |
Write(String, Boolean) |
向线圈中写入bool数组,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x0F (继承自 ModbusTcpNet。)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. | |
Write(String, Byte) |
将数据写入到Modbus的寄存器上去,需要指定起始地址和数据内容,如果富文本地址不指定,默认使用的功能码是 0x10 (继承自 ModbusTcpNet。)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 | |
Write(String, Double) |
写入double数组,返回是否成功 (继承自 ModbusTcpNet。)Write double array, return whether the write was successful | |
Write(String, Int16) |
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06 (继承自 ModbusTcpNet。)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. | |
Write(String, Int32) |
写入int[]数组,返回是否成功 (继承自 ModbusTcpNet。)Write int array, return whether the write was successful | |
Write(String, Int64) |
写入long数组,返回是否成功 (继承自 ModbusTcpNet。)Write long array, return whether the write was successful | |
Write(String, Single) |
写入float数组,返回是否成功 (继承自 ModbusTcpNet。)Write float array, return whether the write was successful | |
Write(String, UInt16) |
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06 (继承自 ModbusTcpNet。)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. | |
Write(String, UInt32) |
写入uint[]数组,返回是否成功 (继承自 ModbusTcpNet。)Write uint array, return whether the write was successful | |
Write(String, UInt64) |
写入ulong数组,返回是否成功 (继承自 ModbusTcpNet。)Write ulong array, return whether the write was successful | |
Write(String, String, Int32) |
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII (继承自 DeviceCommunication。)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. | |
Write(String, String, Encoding) |
写入字符串信息,需要指定的编码信息 (继承自 DeviceCommunication。)Write string information, need to specify the encoding information | |
Write(String, String, Int32, Encoding) |
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息 (继承自 DeviceCommunication。)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 | |
WriteT(T) |
写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明 (继承自 DeviceCommunication。)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. | |
WriteAsync(String, Double) |
异步写入double数据,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write double data, return whether the write was successful | |
WriteAsync(String, Int16) |
异步写入short数组,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write short array, return whether the write was successful | |
WriteAsync(String, Int32) |
异步写入int数据,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write int data, return whether the write was successful | |
WriteAsync(String, Int64) |
异步写入long数据,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write long data, return whether the write was successful | |
WriteAsync(String, Single) |
异步写入float数据,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write float data, return whether the write was successful | |
WriteAsync(String, String) |
异步写入字符串信息,编码为ASCII (继承自 DeviceCommunication。)Asynchronously write string information, encoded as ASCII | |
WriteAsync(String, UInt16) |
异步写入ushort数组,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write ushort array, return whether the write was successful | |
WriteAsync(String, UInt32) |
异步写入uint数据,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write uint data, return whether the write was successful | |
WriteAsync(String, UInt64) |
异步写入ulong数据,返回是否成功 (继承自 DeviceCommunication。)Asynchronously write ulong data, return whether the write was successful | |
WriteAsync(String, Boolean) |
向线圈中写入bool数值,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x05,
如果你的地址为字地址,例如100.2,那么将使用0x16的功能码,通过掩码的方式来修改寄存器的某一位,需要Modbus服务器支持,否则自动切换为读取字数据,修改位,在写入字的方式。 (继承自 ModbusTcpNet。)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. | |
WriteAsync(String, Boolean) |
向线圈中写入bool数组,返回是否写入成功,如果富文本地址不指定,默认使用的功能码是 0x0F (继承自 ModbusTcpNet。)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. | |
WriteAsync(String, Byte) |
将数据写入到Modbus的寄存器上去,需要指定起始地址和数据内容,如果富文本地址不指定,默认使用的功能码是 0x10 (继承自 ModbusTcpNet。)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 | |
WriteAsync(String, Double) |
异步写入double数组,返回是否成功 (继承自 ModbusTcpNet。)Asynchronously write double array, return whether the write was successful | |
WriteAsync(String, Int16) |
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06 (继承自 ModbusTcpNet。)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. | |
WriteAsync(String, Int32) |
异步写入int[]数组,返回是否成功 (继承自 ModbusTcpNet。)Asynchronously write int array, return whether the write was successful | |
WriteAsync(String, Int64) |
异步写入long数组,返回是否成功 (继承自 ModbusTcpNet。)Asynchronously write long array, return whether the write was successful | |
WriteAsync(String, Single) |
异步写入float数组,返回是否成功 (继承自 ModbusTcpNet。)Asynchronously write float array, return whether the write was successful | |
WriteAsync(String, UInt16) |
将数据写入到Modbus的单个寄存器上去,需要指定起始地址和数据值,如果富文本地址不指定,默认使用的功能码是 0x06 (继承自 ModbusTcpNet。)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. | |
WriteAsync(String, UInt32) |
异步写入uint[]数组,返回是否成功 (继承自 ModbusTcpNet。)Asynchronously write uint array, return whether the write was successful | |
WriteAsync(String, UInt64) |
异步写入ulong数组,返回是否成功 (继承自 ModbusTcpNet。)Asynchronously write ulong array, return whether the write was successful | |
WriteAsync(String, String, Int32) |
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII (继承自 DeviceCommunication。)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. | |
WriteAsync(String, String, Encoding) |
异步写入字符串信息,需要指定的编码信息 (继承自 DeviceCommunication。)Asynchronously write string information, need to specify the encoding information | |
WriteAsync(String, String, Int32, Encoding) |
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息 (继承自 DeviceCommunication。)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 | |
WriteAsyncT(T) |
异步写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明 (继承自 DeviceCommunication。)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. | |
WriteCustomerT |
写入自定义类型的数据,该类型必须继承自IDataTransfer接口 (继承自 DeviceCommunication。)Write data of a custom type, which must inherit from the IDataTransfer interface | |
WriteCustomerAsyncT |
写入自定义类型的数据,该类型必须继承自IDataTransfer接口 (继承自 DeviceCommunication。)Write data of a custom type, which must inherit from the IDataTransfer interface | |
WriteMask |
向设备写入掩码数据,使用0x16功能码,需要确认对方是否支持相关的操作,掩码数据的操作主要针对寄存器。 (继承自 ModbusTcpNet。)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功能码,需要确认对方是否支持相关的操作,掩码数据的操作主要针对寄存器。 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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 (继承自 ModbusTcpNet。)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. |
名称 | 说明 | |
---|---|---|
LogMsgFormatBinary |
设置日志记录报文是否二进制,如果为False,那就使用ASCII码 (继承自 BinaryCommunication。)Set whether the log message is binary, if it is False, then use ASCII code |
名称 | 说明 | |
---|---|---|
ToJsonString |
获取当前对象的JSON格式表示的字符串。 (由 HslExtension 定义。)Gets the string represented by the JSON format of the current object. |