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

java.lang.Object
- HslCommunication.ModBus.ModbusInfo

```
public class ModbusInfo
extends Object
```
Modbus协议相关的一些信息，包括功能码定义，报文的生成的定义等等信息
Some information related to Modbus protocol, including function code definition, definition of message generation, etc.

字段概要

字段
限定符和类型	字段和说明
`static byte`	`FunctionCodeNotSupport` 不支持该功能码
`static byte`	`FunctionCodeOverBound` 该地址越界
`static byte`	`FunctionCodeQuantityOver` 读取长度超过最大值
`static byte`	`FunctionCodeReadWriteException` 读写异常
`static byte`	`NoMean` 没有意思
`static byte`	`ReadCoil` 读取线圈
`static byte`	`ReadDiscrete` 读取离散量
`static byte`	`ReadInputRegister` 读取输入寄存器
`static byte`	`ReadRegister` 读取寄存器
`static byte`	`WriteCoil` 写多个线圈
`static byte`	`WriteMaskRegister` 写多个寄存器
`static byte`	`WriteOneCoil` 写单个线圈
`static byte`	`WriteOneRegister` 写单个寄存器
`static byte`	`WriteRegister` 写多个寄存器

构造器概要

构造器
构造器和说明

ModbusInfo()

构造器
构造器和说明
`ModbusInfo()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static OperateResultExOne<ModbusAddress>`	`AnalysisAddress(String address, byte defaultStation, boolean isStartWithZero, byte defaultFunction)` 分析Modbus协议的地址信息，该地址适应于tcp及rtu模式
`static OperateResultExOne<byte[][]>`	`BuildReadModbusCommand(ModbusAddress mAddress, short length)` 构建Modbus读取数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码应该根据bool或是字来区分
`static OperateResultExOne<byte[][]>`	`BuildReadModbusCommand(String address, short length, byte station, boolean isStartWithZero, byte defaultFunction)` 构建Modbus读取数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码应该根据bool或是字来区分
`static OperateResultExOne<byte[]>`	`BuildWriteBoolModbusCommand(ModbusAddress mAddress, boolean value)` 构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteBoolModbusCommand(ModbusAddress mAddress, boolean[] values)` 构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteBoolModbusCommand(String address, boolean[] values, byte station, boolean isStartWithZero, byte defaultFunction)` 构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteBoolModbusCommand(String address, boolean value, byte station, boolean isStartWithZero, byte defaultFunction)` 构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteMaskModbusCommand(ModbusAddress mAddress, short andMask, short orMask)` 构建Modbus写入掩码数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteMaskModbusCommand(String address, short andMask, short orMask, byte station, boolean isStartWithZero, byte defaultFunction)` 构建Modbus写入掩码的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteOneRegisterModbusCommand(ModbusAddress mAddress, short value)` 构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteWordModbusCommand(ModbusAddress mAddress, byte[] values)` 构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteWordModbusCommand(String address, byte[] values, byte station, boolean isStartWithZero, byte defaultFunction)` 构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static OperateResultExOne<byte[]>`	`BuildWriteWordModbusCommand(String address, short value, byte station, boolean isStartWithZero, byte defaultFunction)` 构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
`static byte[]`	`ExplodeRtuCommandToCore(byte[] value)` 将modbus-rtu的数据重新还原成modbus数据
`static byte[]`	`ExplodeTcpCommandToCore(byte[] value)` 将modbus-tcp的数据重新还原成modbus数据
`static OperateResultExOne<byte[]>`	`ExtractActualData(byte[] response)` 从返回的modbus的书内容中，提取出真实的数据，适用于写入和读取操作
`static String`	`GetDescriptionByErrorCode(byte code)` 通过错误码来获取到对应的文本消息
`static byte[]`	`PackCommandToRtu(byte[] value)` 将modbus指令打包成Modbus-Rtu指令
`static byte[]`	`PackCommandToTcp(byte[] value, int id)` 将modbus指令打包成Modbus-Tcp指令
`static OperateResultExOne<byte[]>`	`TransAsciiPackCommandToRtu(byte[] value)` 将一个modbus-ascii的数据报文，转换成的modbus核心数据报文
`static byte[]`	`TransRtuToAsciiPackCommand(byte[] value)` 将一个modbus-rtu的数据报文，转换成modbus-ascii的数据报文

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

- 字段详细资料
  - ReadCoil
```
public static final byte ReadCoil
```
    读取线圈
    
    另请参阅:
    
    常量字段值
  - ReadDiscrete
```
public static final byte ReadDiscrete
```
    读取离散量
    
    另请参阅:
    
    常量字段值
  - ReadRegister
```
public static final byte ReadRegister
```
    读取寄存器
    
    另请参阅:
    
    常量字段值
  - ReadInputRegister
```
public static final byte ReadInputRegister
```
    读取输入寄存器
    
    另请参阅:
    
    常量字段值
  - WriteOneCoil
```
public static final byte WriteOneCoil
```
    写单个线圈
    
    另请参阅:
    
    常量字段值
  - WriteOneRegister
```
public static final byte WriteOneRegister
```
    写单个寄存器
    
    另请参阅:
    
    常量字段值
  - WriteCoil
```
public static final byte WriteCoil
```
    写多个线圈
    
    另请参阅:
    
    常量字段值
  - WriteRegister
```
public static final byte WriteRegister
```
    写多个寄存器
    
    另请参阅:
    
    常量字段值
  - WriteMaskRegister
```
public static final byte WriteMaskRegister
```
    写多个寄存器
    
    另请参阅:
    
    常量字段值
  - NoMean
```
public static final byte NoMean
```
    没有意思
    
    另请参阅:
    
    常量字段值
  - FunctionCodeNotSupport
```
public static final byte FunctionCodeNotSupport
```
    不支持该功能码
    
    另请参阅:
    
    常量字段值
  - FunctionCodeOverBound
```
public static final byte FunctionCodeOverBound
```
    该地址越界
    
    另请参阅:
    
    常量字段值
  - FunctionCodeQuantityOver
```
public static final byte FunctionCodeQuantityOver
```
    读取长度超过最大值
    
    另请参阅:
    
    常量字段值
  - FunctionCodeReadWriteException
```
public static final byte FunctionCodeReadWriteException
```
    读写异常
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ModbusInfo
```
public ModbusInfo()
```
- 方法详细资料
  - BuildReadModbusCommand
```
public static OperateResultExOne<byte[][]> BuildReadModbusCommand(String address,
                                                                  short length,
                                                                  byte station,
                                                                  boolean isStartWithZero,
                                                                  byte defaultFunction)
```
    构建Modbus读取数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码应该根据bool或是字来区分
    
    参数:
    
    address - Modbus的富文本地址
    
    length - 读取的数据长度
    
    station - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码
    
    返回:
    
    包含最终命令的结果对象
  - BuildReadModbusCommand
```
public static OperateResultExOne<byte[][]> BuildReadModbusCommand(ModbusAddress mAddress,
                                                                  short length)
```
    构建Modbus读取数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码应该根据bool或是字来区分
    
    参数:
    
    mAddress - Modbus的富文本地址
    
    length - 读取的数据长度
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteBoolModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteBoolModbusCommand(String address,
                                                                     boolean[] values,
                                                                     byte station,
                                                                     boolean isStartWithZero,
                                                                     byte defaultFunction)
```
    构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    address - Modbus的富文本地址
    
    values - bool数组的信息
    
    station - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteBoolModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteBoolModbusCommand(String address,
                                                                     boolean value,
                                                                     byte station,
                                                                     boolean isStartWithZero,
                                                                     byte defaultFunction)
```
    构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    address - Modbus的富文本地址
    
    value - bool的信息
    
    station - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteBoolModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteBoolModbusCommand(ModbusAddress mAddress,
                                                                     boolean[] values)
```
    构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    mAddress - Modbus的富文本地址
    
    values - bool数组的信息
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteBoolModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteBoolModbusCommand(ModbusAddress mAddress,
                                                                     boolean value)
```
    构建Modbus写入bool数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    mAddress - Modbus的富文本地址
    
    value - bool数值的信息
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteWordModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteWordModbusCommand(String address,
                                                                     byte[] values,
                                                                     byte station,
                                                                     boolean isStartWithZero,
                                                                     byte defaultFunction)
```
    构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    address - Modbus的富文本地址
    
    values - bool数组的信息
    
    station - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteWordModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteWordModbusCommand(String address,
                                                                     short value,
                                                                     byte station,
                                                                     boolean isStartWithZero,
                                                                     byte defaultFunction)
```
    构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    address - Modbus的富文本地址
    
    value - short数据信息
    
    station - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteMaskModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteMaskModbusCommand(String address,
                                                                     short andMask,
                                                                     short orMask,
                                                                     byte station,
                                                                     boolean isStartWithZero,
                                                                     byte defaultFunction)
```
    构建Modbus写入掩码的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    address - Modbus的富文本地址
    
    andMask - 进行与操作的掩码信息
    
    orMask - 进行或操作的掩码信息
    
    station - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteWordModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteWordModbusCommand(ModbusAddress mAddress,
                                                                     byte[] values)
```
    构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    mAddress - Modbus的富文本地址
    
    values - bool数组的信息
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteMaskModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteMaskModbusCommand(ModbusAddress mAddress,
                                                                     short andMask,
                                                                     short orMask)
```
    构建Modbus写入掩码数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    mAddress - Modbus的富文本地址
    
    andMask - 等待进行与操作的掩码
    
    orMask - 等待进行或操作的掩码
    
    返回:
    
    包含最终命令的结果对象
  - BuildWriteOneRegisterModbusCommand
```
public static OperateResultExOne<byte[]> BuildWriteOneRegisterModbusCommand(ModbusAddress mAddress,
                                                                            short value)
```
    构建Modbus写入字数据的核心报文，需要指定地址，长度，站号，是否起始地址0，默认的功能码
    
    参数:
    
    mAddress - Modbus的富文本地址
    
    value - sho 包含最终命令的结果对象rt的值
    
    返回:
  - ExtractActualData
```
public static OperateResultExOne<byte[]> ExtractActualData(byte[] response)
```
    从返回的modbus的书内容中，提取出真实的数据，适用于写入和读取操作
    
    参数:
    
    response - 返回的核心modbus报文信息
    
    返回:
    
    结果数据内容
  - PackCommandToTcp
```
public static byte[] PackCommandToTcp(byte[] value,
                                      int id)
```
    将modbus指令打包成Modbus-Tcp指令
    
    参数:
    
    value - Modbus指令
    
    id - 消息的序号
    
    返回:
    
    Modbus-Tcp指令
  - ExplodeTcpCommandToCore
```
public static byte[] ExplodeTcpCommandToCore(byte[] value)
```
    将modbus-tcp的数据重新还原成modbus数据
    
    参数:
    
    value - modbus-tcp的报文
    
    返回:
    
    modbus数据报文
  - ExplodeRtuCommandToCore
```
public static byte[] ExplodeRtuCommandToCore(byte[] value)
```
    将modbus-rtu的数据重新还原成modbus数据
    
    参数:
    
    value - modbus-rtu的报文
    
    返回:
    
    modbus数据报文
  - PackCommandToRtu
```
public static byte[] PackCommandToRtu(byte[] value)
```
    将modbus指令打包成Modbus-Rtu指令
    
    参数:
    
    value - Modbus指令
    
    返回:
    
    Modbus-Rtu指令
  - TransRtuToAsciiPackCommand
```
public static byte[] TransRtuToAsciiPackCommand(byte[] value)
```
    将一个modbus-rtu的数据报文，转换成modbus-ascii的数据报文
    
    参数:
    
    value - modbus-rtu的完整报文，携带相关的校验码
    
    返回:
    
    可以用于直接发送的modbus-ascii的报文
  - TransAsciiPackCommandToRtu
```
public static OperateResultExOne<byte[]> TransAsciiPackCommandToRtu(byte[] value)
```
    将一个modbus-ascii的数据报文，转换成的modbus核心数据报文
    
    参数:
    
    value - modbus-ascii的完整报文，携带相关的校验码
    
    返回:
    
    可以用于直接发送的modbus的报文
  - AnalysisAddress
```
public static OperateResultExOne<ModbusAddress> AnalysisAddress(String address,
                                                                byte defaultStation,
                                                                boolean isStartWithZero,
                                                                byte defaultFunction)
```
    分析Modbus协议的地址信息，该地址适应于tcp及rtu模式
    
    参数:
    
    address - 带格式的地址，比如"100"，"x=4;100"，"s=1;100","s=1;x=4;100"
    
    defaultStation - 默认的站号信息
    
    isStartWithZero - 起始地址是否从0开始
    
    defaultFunction - 默认的功能码信息
    
    返回:
    
    转换后的地址信息
  - GetDescriptionByErrorCode
```
public static String GetDescriptionByErrorCode(byte code)
```
    通过错误码来获取到对应的文本消息
    
    参数:
    
    code - 错误码
    
    返回:
    
    错误的文本描述

类 ModbusInfo

字段概要

构造器概要

方法概要

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

字段详细资料

ReadCoil

ReadDiscrete

ReadRegister

ReadInputRegister

WriteOneCoil

WriteOneRegister

WriteCoil

WriteRegister

WriteMaskRegister

NoMean

FunctionCodeNotSupport

FunctionCodeOverBound

FunctionCodeQuantityOver

FunctionCodeReadWriteException

构造器详细资料

ModbusInfo

方法详细资料

BuildReadModbusCommand

BuildReadModbusCommand

BuildWriteBoolModbusCommand

BuildWriteBoolModbusCommand

BuildWriteBoolModbusCommand

BuildWriteBoolModbusCommand

BuildWriteWordModbusCommand

BuildWriteWordModbusCommand

BuildWriteMaskModbusCommand

BuildWriteWordModbusCommand

BuildWriteMaskModbusCommand

BuildWriteOneRegisterModbusCommand

ExtractActualData

PackCommandToTcp

ExplodeTcpCommandToCore

ExplodeRtuCommandToCore

PackCommandToRtu

TransRtuToAsciiPackCommand

TransAsciiPackCommandToRtu

AnalysisAddress

GetDescriptionByErrorCode