ModbusTcpNet (com.github.dathlin:HslCommunication 3.4.0 API)

java.lang.Object
- HslCommunication.Core.Net.NetworkBase.NetworkBase
- - HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
  - - HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase
    - - HslCommunication.ModBus.ModbusTcpNet

所有已实现的接口:

IReadWriteDevice, IReadWriteNet, IModbus

直接已知子类:

DeltaTcpNet, InovanceTcpNet, XinJETcpNet
```
public class ModbusTcpNet
extends NetworkDeviceBase
implements IModbus
```
Modbus-Tcp协议的客户端通讯类，方便的和服务器进行数据交互，支持标准的功能码，也支持扩展的功能码实现，地址采用富文本的形式，详细见备注说明
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.

字段概要
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase
  WordLength
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
  AlienSession, isPersistentConn, IsSocketError, isUseAccountCertificate, LogMsgFormatBinary, simpleHybirdLock
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase
  CoreSocket, fileCacheSize, LogNet, Token
- 从接口继承的字段 HslCommunication.Core.Net.IReadWriteNet
  LogNet

构造器概要

构造器
构造器和说明
`ModbusTcpNet()` 实例化一个Modbus-Tcp协议的客户端对象 Instantiate a client object of the Modbus-Tcp protocol
`ModbusTcpNet(String ipAddress, int port, byte station)` 指定服务器地址，端口号，客户端自己的站号来初始化 Specify the server address, port number, and client's own station number to initialize

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`getAddressStartWithZero()` 获取起始地址是否从0开始
`DataFormat`	`getDataFormat()` 获取多字节数据的反转类型，适用于int,float,double,long类型的数据
`protected INetMessage`	`GetNewNetMessage()` 获取一个新的消息对象的方法，需要在继承类里面进行重写 The method to get a new message object needs to be overridden in the inheritance class
`byte`	`getStation()` 获取站号
`boolean`	`isStringReverse()` 字符串数据是否发生反转
`protected byte[]`	`PackCommandWithHeader(byte[] command)` 对当前的命令进行打包处理，通常是携带命令头内容，标记当前的命令的长度信息，需要进行重写，否则默认不打包
`OperateResultExOne<byte[]>`	`Read(String address, short length)` 从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.
`OperateResultExOne<boolean[]>`	`ReadBool(String address, short length)` 批量读取线圈或是离散的数据信息，需要指定地址和长度，具体的结果取决于实现，如果富文本地址不指定，默认使用的功能码是 0x01 To read coils or discrete data in batches, you need to specify the address and length.
`OperateResultExOne<Boolean>`	`ReadCoil(String address)` 读取线圈，需要指定起始地址，如果富文本地址不指定，默认使用的功能码是 0x01 To read the coil, you need to specify the start address.
`OperateResultExOne<boolean[]>`	`ReadCoil(String address, short length)` 批量的读取线圈，需要指定起始地址，读取长度，如果富文本地址不指定，默认使用的功能码是 0x01 For batch reading coils, you need to specify the start address and read length.
`OperateResultExOne<Boolean>`	`ReadDiscrete(String address)` 读取输入线圈，需要指定起始地址，如果富文本地址不指定，默认使用的功能码是 0x02 To read the input coil, you need to specify the start address.
`OperateResultExOne<boolean[]>`	`ReadDiscrete(String address, short length)` 批量的读取输入点，需要指定起始地址，读取长度，如果富文本地址不指定，默认使用的功能码是 0x02 To read input points in batches, you need to specify the start address and read length.
`void`	`setAddressStartWithZero(boolean addressStartWithZero)` 设置起始地址是否从0开始
`void`	`setDataFormat(DataFormat dataFormat)` 设置多字节数据的反转类型，适用于int,float,double,long类型的数据
`void`	`setStation(byte station)` 设置站号
`void`	`setStringReverse(boolean stringReverse)` 设置字符串数据是否反转
`String`	`toString()` 返回表示当前对象的字符串
`OperateResultExOne<String>`	`TranslateToModbusAddress(String address, byte modbusCode)` 将当前的地址信息转换成Modbus格式的地址，如果转换失败，返回失败的消息。
`protected OperateResultExOne<byte[]>`	`UnpackResponseContent(byte[] send, byte[] response)` 根据对方返回的报文命令，对命令进行基本的拆包，例如各种Modbus协议拆包为统一的核心报文，还支持对报文的验证
`OperateResult`	`Write(String address, boolean value)` 向线圈中写入bool数值，返回是否写入成功，如果富文本地址不指定，默认使用的功能码是 0x05 Write bool value to the coil and return whether the writing is successful.
`OperateResult`	`Write(String address, boolean[] values)` 向线圈中写入bool数组，返回是否写入成功，如果富文本地址不指定，默认使用的功能码是 0x0F Write the bool array to the coil, and return whether the writing is successful.
`OperateResult`	`Write(String address, byte[] value)` 将数据写入到Modbus的寄存器上去，需要指定起始地址和数据内容，如果富文本地址不指定，默认使用的功能码是 0x10 To write data to Modbus registers, you need to specify the start address and data content.
`OperateResult`	`Write(String address, short value)` 将数据写入到Modbus的单个寄存器上去，需要指定起始地址和数据值，如果富文本地址不指定，默认使用的功能码是 0x06 To write data to a single register of Modbus, you need to specify the start address and data value.
`OperateResult`	`WriteMask(String address, short andMask, short orMask)` 向设备写入掩码数据，使用0x16功能码，需要确认对方是否支持相关的操作，掩码数据的操作主要针对寄存器。
`OperateResult`	`WriteOneRegister(String address, short value)` 将数据写入到Modbus的单个寄存器上去，需要指定起始地址和数据值，如果富文本地址不指定，默认使用的功能码是 0x06 To write data to a single register of Modbus, you need to specify the start address and data value.

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase
ReadBool, ReadCustomer, ReadDouble, ReadDouble, ReadFloat, ReadFloat, ReadInt16, ReadInt16, ReadInt32, ReadInt32, ReadInt64, ReadInt64, ReadString, ReadString, ReadUInt16, ReadUInt16, ReadUInt32, ReadUInt32, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, WriteCustomer, WriteUnicodeString, WriteUnicodeString

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
AccountCertificate, ConnectClose, ConnectServer, ConnectServer, ExtraAfterReadFromCoreServer, ExtraOnDisconnect, GetAvailableSocket, getByteTransform, getConnectionId, getConnectTimeOut, getIpAddress, getPort, getReceiveTimeOut, getSleepTime, InitializationOnConnect, IpAddressPing, ReadFromCoreServer, ReadFromCoreServer, ReadFromCoreServer, setByteTransform, setConnectionId, setConnectTimeOut, setIpAddress, SetLoginAccount, SetPersistentConnection, setPort, setReceiveTimeOut, setSleepTime

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkBase
CheckRemoteToken, CloseSocket, CreateSocketAndConnect, CreateSocketAndConnect, CreateSocketAndConnect, ReadStream, Receive, Receive, Receive, ReceiveAndCheckBytes, ReceiveByMessage, ReceiveByMessage, ReceiveBytesContentFromSocket, ReceiveBytesContentFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveFrameWebSocketPayload, ReceiveHslMessage, ReceiveMqttMessage, ReceiveRedisCommand, ReceiveRedisCommandString, ReceiveStringArrayContentFromSocket, ReceiveStringArrayContentFromSocket, ReceiveStringContentFromSocket, ReceiveStringContentFromSocket, ReceiveWebSocketPayload, Send, Send, SendAccountAndCheckReceive, SendBaseAndCheckReceive, SendBytesAndCheckReceive, SendStreamToSocket, SendStringAndCheckReceive, SendStringAndCheckReceive, ThreadPoolCheckTimeOut, WriteStream, WriteStreamFromSocket

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 HslCommunication.Core.Net.IReadWriteDevice
ReadFromCoreServer

从接口继承的方法 HslCommunication.Core.Net.IReadWriteNet
ConnectClose, getConnectionId, ReadBool, ReadCustomer, ReadDouble, ReadDouble, ReadFloat, ReadFloat, ReadInt16, ReadInt16, ReadInt32, ReadInt32, ReadInt64, ReadInt64, ReadString, ReadString, ReadUInt16, ReadUInt16, ReadUInt32, ReadUInt32, setConnectionId, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, WriteCustomer

- 构造器详细资料
  - ModbusTcpNet
```
public ModbusTcpNet()
```
    实例化一个Modbus-Tcp协议的客户端对象
    Instantiate a client object of the Modbus-Tcp protocol
  - ModbusTcpNet
```
public ModbusTcpNet(String ipAddress,
                    int port,
                    byte station)
```
    指定服务器地址，端口号，客户端自己的站号来初始化
    Specify the server address, port number, and client's own station number to initialize
    
    参数:
    
    ipAddress - 服务器的Ip地址
    
    port - 服务器的端口号
    
    station - 客户端自身的站号，可以在读取的时候动态配置
- 方法详细资料
  - GetNewNetMessage
```
protected INetMessage GetNewNetMessage()
```
    从类复制的说明: NetworkDoubleBase
    
    获取一个新的消息对象的方法，需要在继承类里面进行重写
    The method to get a new message object needs to be overridden in the inheritance class
    
    覆盖:
    
    GetNewNetMessage 在类中 NetworkDoubleBase
    
    返回:
    
    消息类对象
  - getAddressStartWithZero
```
public boolean getAddressStartWithZero()
```
    从接口复制的说明: IModbus
    
    获取起始地址是否从0开始
    
    指定者:
    
    getAddressStartWithZero 在接口中 IModbus
    
    返回:
    
    bool值
  - setAddressStartWithZero
```
public void setAddressStartWithZero(boolean addressStartWithZero)
```
    从接口复制的说明: IModbus
    
    设置起始地址是否从0开始
    
    指定者:
    
    setAddressStartWithZero 在接口中 IModbus
    
    参数:
    
    addressStartWithZero - true代表从0开始，false代表从1开始
  - getStation
```
public byte getStation()
```
    从接口复制的说明: IModbus
    
    获取站号
    
    指定者:
    
    getStation 在接口中 IModbus
    
    返回:
    
    站号
  - setStation
```
public void setStation(byte station)
```
    从接口复制的说明: IModbus
    
    设置站号
    
    指定者:
    
    setStation 在接口中 IModbus
    
    参数:
    
    station - 站号
  - setDataFormat
```
public void setDataFormat(DataFormat dataFormat)
```
    从接口复制的说明: IModbus
    
    设置多字节数据的反转类型，适用于int,float,double,long类型的数据
    
    指定者:
    
    setDataFormat 在接口中 IModbus
    
    参数:
    
    dataFormat - 数据类型
  - getDataFormat
```
public DataFormat getDataFormat()
```
    从接口复制的说明: IModbus
    
    获取多字节数据的反转类型，适用于int,float,double,long类型的数据
    
    指定者:
    
    getDataFormat 在接口中 IModbus
    
    返回:
  - isStringReverse
```
public boolean isStringReverse()
```
    从接口复制的说明: IModbus
    
    字符串数据是否发生反转
    
    指定者:
    
    isStringReverse 在接口中 IModbus
    
    返回:
    
    bool值
  - setStringReverse
```
public void setStringReverse(boolean stringReverse)
```
    从接口复制的说明: IModbus
    
    设置字符串数据是否反转
    
    指定者:
    
    setStringReverse 在接口中 IModbus
    
    参数:
    
    stringReverse - bool值
  - PackCommandWithHeader
```
protected byte[] PackCommandWithHeader(byte[] command)
```
    从类复制的说明: NetworkDoubleBase
    
    对当前的命令进行打包处理，通常是携带命令头内容，标记当前的命令的长度信息，需要进行重写，否则默认不打包
    
    覆盖:
    
    PackCommandWithHeader 在类中 NetworkDoubleBase
    
    参数:
    
    command - 发送的数据命令内容
    
    返回:
    
    打包之后的数据结果信息
  - UnpackResponseContent
```
protected OperateResultExOne<byte[]> UnpackResponseContent(byte[] send,
                                                           byte[] response)
```
    从类复制的说明: NetworkDoubleBase
    
    根据对方返回的报文命令，对命令进行基本的拆包，例如各种Modbus协议拆包为统一的核心报文，还支持对报文的验证
    
    覆盖:
    
    UnpackResponseContent 在类中 NetworkDoubleBase
    
    参数:
    
    send - 发送的原始报文数据
    
    response - 设备方反馈的原始报文内容
    
    返回:
    
    返回拆包之后的报文信息，默认不进行任何的拆包操作
  - TranslateToModbusAddress
```
public OperateResultExOne<String> TranslateToModbusAddress(String address,
                                                           byte modbusCode)
```
    从接口复制的说明: IModbus
    
    将当前的地址信息转换成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.
    
    指定者:
    
    TranslateToModbusAddress 在接口中 IModbus
    
    参数:
    
    address - 传入的地址
    
    modbusCode - Modbus的功能码
    
    返回:
    
    转换之后Modbus的地址
  - ReadCoil
```
public OperateResultExOne<Boolean> ReadCoil(String address)
```
    读取线圈，需要指定起始地址，如果富文本地址不指定，默认使用的功能码是 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.
    
    参数:
    
    address - 起始地址，格式为"1234"
    
    返回:
    
    带有成功标志的bool对象
  - ReadCoil
```
public OperateResultExOne<boolean[]> ReadCoil(String address,
                                              short length)
```
    批量的读取线圈，需要指定起始地址，读取长度，如果富文本地址不指定，默认使用的功能码是 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.
    
    参数:
    
    address - 起始地址，格式为"1234"
    
    length - 读取长度
    
    返回:
    
    带有成功标志的bool数组对象
  - ReadDiscrete
```
public OperateResultExOne<Boolean> ReadDiscrete(String address)
```
    读取输入线圈，需要指定起始地址，如果富文本地址不指定，默认使用的功能码是 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.
    
    参数:
    
    address - 起始地址，格式为"1234"
    
    返回:
    
    带有成功标志的bool对象
  - ReadDiscrete
```
public OperateResultExOne<boolean[]> ReadDiscrete(String address,
                                                  short length)
```
    批量的读取输入点，需要指定起始地址，读取长度，如果富文本地址不指定，默认使用的功能码是 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
    
    参数:
    
    address - 起始地址，格式为"1234"
    
    length - 读取长度
    
    返回:
    
    带有成功标志的bool数组对象
  - Read
```
public OperateResultExOne<byte[]> Read(String address,
                                       short length)
```
    从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"
    
    指定者:
    
    Read 在接口中 IReadWriteNet
    
    覆盖:
    
    Read 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，比如"100"，"x=4;100"，"s=1;100","s=1;x=4;100"
    
    length - 读取的数量
    
    返回:
    
    带有成功标志的字节信息
  - Write
```
public OperateResult Write(String address,
                           byte[] value)
```
    将数据写入到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
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，比如"100"，"x=4;100"，"s=1;100","s=1;x=4;100"
    
    value - 写入的数据，长度根据data的长度来指示
    
    返回:
    
    返回写入结果
  - Write
```
public OperateResult Write(String address,
                           short value)
```
    将数据写入到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.
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，比如"100"，"x=4;100"，"s=1;100","s=1;x=4;100"
    
    value - 写入的short数据
    
    返回:
    
    是否写入成功
  - WriteMask
```
public OperateResult WriteMask(String address,
                               short andMask,
                               short orMask)
```
    向设备写入掩码数据，使用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.
    
    参数:
    
    address - 起始地址，比如"100"，"x=4;100"，"s=1;100","s=1;x=4;100"
    
    andMask - 等待与操作的掩码数据
    
    orMask - 等待或操作的掩码数据
    
    返回:
    
    是否写入成功
  - WriteOneRegister
```
public OperateResult WriteOneRegister(String address,
                                      short value)
```
    将数据写入到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.
    
    参数:
    
    address - 起始地址，比如"100"，"x=4;100"，"s=1;100","s=1;x=4;100"
    
    value - 写入的short数据
    
    返回:
    
    是否写入成功
  - ReadBool
```
public OperateResultExOne<boolean[]> ReadBool(String address,
                                              short length)
```
    批量读取线圈或是离散的数据信息，需要指定地址和长度，具体的结果取决于实现，如果富文本地址不指定，默认使用的功能码是 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.
    
    指定者:
    
    ReadBool 在接口中 IReadWriteNet
    
    覆盖:
    
    ReadBool 在类中 NetworkDeviceBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的bool[]数组
  - Write
```
public OperateResult Write(String address,
                           boolean[] values)
```
    向线圈中写入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.
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 要写入的数据地址
    
    values - 要写入的实际数组
    
    返回:
    
    返回写入结果
  - Write
```
public OperateResult Write(String address,
                           boolean value)
```
    向线圈中写入bool数值，返回是否写入成功，如果富文本地址不指定，默认使用的功能码是 0x05
    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.
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 要写入的数据地址
    
    value - 要写入的实际数据
    
    返回:
    
    返回写入结果
  - toString
```
public String toString()
```
    返回表示当前对象的字符串
    
    覆盖:
    
    toString 在类中 NetworkDeviceBase
    
    返回:
    
    字符串信息

类 ModbusTcpNet

字段概要

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase

从接口继承的字段 HslCommunication.Core.Net.IReadWriteNet

构造器概要

方法概要

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkBase

从类继承的方法 java.lang.Object

从接口继承的方法 HslCommunication.Core.Net.IReadWriteDevice

从接口继承的方法 HslCommunication.Core.Net.IReadWriteNet

构造器详细资料

ModbusTcpNet

ModbusTcpNet

方法详细资料

GetNewNetMessage

getAddressStartWithZero

setAddressStartWithZero

getStation

setStation

setDataFormat

getDataFormat

isStringReverse

setStringReverse

PackCommandWithHeader

UnpackResponseContent

TranslateToModbusAddress

ReadCoil

ReadCoil

ReadDiscrete

ReadDiscrete

Read

Write

Write

WriteMask

WriteOneRegister

ReadBool

Write

Write

toString