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

java.lang.Object
- HslCommunication.Profinet.AllenBradley.AllenBradleyHelper

```
public class AllenBradleyHelper
extends Object
```
AB PLC的辅助类，用来辅助生成基本的指令信息

字段概要

字段
限定符和类型	字段和说明
`static int`	`CIP_Execute_PCCC` CIP命令中PCCC命令相关的信息
`static int`	`CIP_MULTIREAD_DATA` CIP命令中的对数据读取服务
`static int`	`CIP_READ_DATA` CIP命令中的读取数据的服务
`static int`	`CIP_READ_FRAGMENT` CIP命令中的读片段的数据服务
`static int`	`CIP_READ_LIST` CIP指令中读取数据的列表
`static int`	`CIP_READ_WRITE_DATA` CIP命令中的读并写的数据服务
`static int`	`CIP_Type_BitArray` 二进制数据内容
`static int`	`CIP_Type_Bool` bool型数据，一个字节长度
`static int`	`CIP_Type_Byte` byte型数据，一个字节长度
`static int`	`CIP_Type_D1` Bit string, 16-bits, WORD
`static int`	`CIP_Type_D2` Bit string, 32 bits, DWORD
`static int`	`CIP_Type_Double` 实数数据，八个字节的长度
`static int`	`CIP_Type_DWord` 长整型，四个字节长度
`static int`	`CIP_Type_LInt` 特长整型，8个字节
`static int`	`CIP_Type_Real` 实数数据，四个字节长度
`static int`	`CIP_Type_String` 字符串数据内容
`static int`	`CIP_Type_Struct` 结构体数据，不定长度
`static int`	`CIP_Type_UDint` Unsigned 32-bit integer, UDINT
`static int`	`CIP_Type_UInt` Unsigned 16-bit integer, UINT
`static int`	`CIP_Type_ULint` Unsigned 64-bit integer, ULINT
`static int`	`CIP_Type_USInt` Unsigned 8-bit integer, USINT
`static int`	`CIP_Type_Word` 整型，两个字节长度
`static int`	`CIP_WRITE_DATA` CIP命令中的写数据的服务
`static int`	`CIP_WRITE_FRAGMENT` CIP命令中的写片段的数据服务
`static int`	`OriginatorSerialNumber` 连接方的序列号
`static short`	`OriginatorVendorID` 连接方的厂商标识

构造器概要

构造器
构造器和说明

AllenBradleyHelper()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static OperateResultExTwo<String,Integer>`	`AnalysisArrayIndex(String address)` 分析地址数据信息里的位索引的信息，例如a[10] 返回 a 和 10 索引，如果没有指定索引，就默认为0
`static OperateResult`	`CheckResponse(byte[] response)` 初步检查返回的CIP协议的报文是否正确 Initially check whether the returned CIP protocol message is correct
`static OperateResultExThree<byte[],Short,Boolean>`	`ExtractActualData(byte[] response, boolean isRead)` 从PLC反馈的数据解析
`static byte[]`	`PackCleanCommandService(byte[] portSlot, byte[]... cips)` 将所有的cip指定进行打包操作。
`static byte[]`	`PackCommandService(byte[] portSlot, byte[]... cips)` 将所有的cip指定进行打包操作。
`static byte[]`	`PackCommandSingleService(byte[] command, int code, boolean isConnected)` 将所有的cip指定进行打包操作。
`static byte[]`	`PackCommandSpecificData(byte[]... service)` 生成读取直接节点数据信息的内容
`static OperateResultExOne<byte[]>`	`PackExecutePCCCRead(int tns, String address, short length)` 打包一个PCCC的读取的命令报文
`static OperateResultExOne<byte[]>`	`PackExecutePCCCWrite(int tns, String address, byte[] value)` 打包一个PCCC的写入的命令报文
`static OperateResultExOne<byte[]>`	`PackExecutePCCCWrite(int tns, String address, int bitIndex, boolean value)`
`static byte[]`	`PackRequestHeader(int command, int session, byte[] commandSpecificData)` 将CommandSpecificData的命令，打包成可发送的数据指令
`static byte[]`	`PackRequestHeader(int command, int session, byte[] commandSpecificData, byte[] senderContext)`
`static byte[]`	`PackRequestReadSegment(String address, int startIndex, int length)` 打包生成一个请求读取数据片段的节点信息，CIP指令信息
`static byte[]`	`PackRequestWrite(String address, boolean value)` 写入Bool数据的基本指令信息
`static byte[]`	`PackRequestWrite(String address, int typeCode, byte[] value)` 根据指定的数据和类型，生成对应的数据
`static byte[]`	`PackRequestWrite(String address, int typeCode, byte[] value, int length)` 根据指定的数据和类型，生成对应的数据
`static byte[]`	`PackRequestWrite(String address, int typeCode, byte[] value, int length, boolean isConnectedAddress)` 根据指定的数据和类型，生成对应的数据
`static byte[]`	`PackRequsetRead(String address, int length)` 打包生成一个请求读取数据的节点信息，CIP指令信息
`static byte[]`	`PackRequsetRead(String address, int length, boolean isConnectedAddress)` 打包生成一个请求读取数据的节点信息，CIP指令信息
`static OperateResultExOne<String>`	`ReadPlcType(IReadWriteDevice plc)` 从PLC里读取当前PLC的型号信息 Read the current PLC model information from the PLC
`static byte[]`	`RegisterSessionHandle()` 向PLC注册会话ID的报文 Register a message with the PLC for the session ID
`static byte[]`	`RegisterSessionHandle(byte[] senderContext)` 向PLC注册会话ID的报文 Register a message with the PLC for the session ID
`static byte[]`	`UnRegisterSessionHandle(int sessionHandle)` 获取卸载一个已注册的会话的报文 Get a message to uninstall a registered session

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

- 字段详细资料
  - CIP_Execute_PCCC
```
public static final int CIP_Execute_PCCC
```
    CIP命令中PCCC命令相关的信息
    
    另请参阅:
    
    常量字段值
  - CIP_READ_DATA
```
public static final int CIP_READ_DATA
```
    CIP命令中的读取数据的服务
    
    另请参阅:
    
    常量字段值
  - CIP_WRITE_DATA
```
public static final int CIP_WRITE_DATA
```
    CIP命令中的写数据的服务
    
    另请参阅:
    
    常量字段值
  - CIP_READ_WRITE_DATA
```
public static final int CIP_READ_WRITE_DATA
```
    CIP命令中的读并写的数据服务
    
    另请参阅:
    
    常量字段值
  - CIP_READ_FRAGMENT
```
public static final int CIP_READ_FRAGMENT
```
    CIP命令中的读片段的数据服务
    
    另请参阅:
    
    常量字段值
  - CIP_WRITE_FRAGMENT
```
public static final int CIP_WRITE_FRAGMENT
```
    CIP命令中的写片段的数据服务
    
    另请参阅:
    
    常量字段值
  - CIP_READ_LIST
```
public static final int CIP_READ_LIST
```
    CIP指令中读取数据的列表
    
    另请参阅:
    
    常量字段值
  - CIP_MULTIREAD_DATA
```
public static final int CIP_MULTIREAD_DATA
```
    CIP命令中的对数据读取服务
    
    另请参阅:
    
    常量字段值
  - CIP_Type_Bool
```
public static final int CIP_Type_Bool
```
    bool型数据，一个字节长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_Byte
```
public static final int CIP_Type_Byte
```
    byte型数据，一个字节长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_Word
```
public static final int CIP_Type_Word
```
    整型，两个字节长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_DWord
```
public static final int CIP_Type_DWord
```
    长整型，四个字节长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_LInt
```
public static final int CIP_Type_LInt
```
    特长整型，8个字节
    
    另请参阅:
    
    常量字段值
  - CIP_Type_USInt
```
public static final int CIP_Type_USInt
```
    Unsigned 8-bit integer, USINT
    
    另请参阅:
    
    常量字段值
  - CIP_Type_UInt
```
public static final int CIP_Type_UInt
```
    Unsigned 16-bit integer, UINT
    
    另请参阅:
    
    常量字段值
  - CIP_Type_UDint
```
public static final int CIP_Type_UDint
```
    Unsigned 32-bit integer, UDINT
    
    另请参阅:
    
    常量字段值
  - CIP_Type_ULint
```
public static final int CIP_Type_ULint
```
    Unsigned 64-bit integer, ULINT
    
    另请参阅:
    
    常量字段值
  - CIP_Type_Real
```
public static final int CIP_Type_Real
```
    实数数据，四个字节长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_Double
```
public static final int CIP_Type_Double
```
    实数数据，八个字节的长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_Struct
```
public static final int CIP_Type_Struct
```
    结构体数据，不定长度
    
    另请参阅:
    
    常量字段值
  - CIP_Type_String
```
public static final int CIP_Type_String
```
    字符串数据内容
    
    另请参阅:
    
    常量字段值
  - CIP_Type_D1
```
public static final int CIP_Type_D1
```
    Bit string, 16-bits, WORD
    
    另请参阅:
    
    常量字段值
  - CIP_Type_D2
```
public static final int CIP_Type_D2
```
    Bit string, 32 bits, DWORD
    
    另请参阅:
    
    常量字段值
  - CIP_Type_BitArray
```
public static final int CIP_Type_BitArray
```
    二进制数据内容
    
    另请参阅:
    
    常量字段值
  - OriginatorVendorID
```
public static final short OriginatorVendorID
```
    连接方的厂商标识
    
    另请参阅:
    
    常量字段值
  - OriginatorSerialNumber
```
public static final int OriginatorSerialNumber
```
    连接方的序列号
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AllenBradleyHelper
```
public AllenBradleyHelper()
```
- 方法详细资料
  - PackRequsetRead
```
public static byte[] PackRequsetRead(String address,
                                     int length)
```
    打包生成一个请求读取数据的节点信息，CIP指令信息
    
    参数:
    
    address - 地址
    
    length - 指代数组的长度
    
    返回:
    
    CIP的指令信息
  - PackRequsetRead
```
public static byte[] PackRequsetRead(String address,
                                     int length,
                                     boolean isConnectedAddress)
```
    打包生成一个请求读取数据的节点信息，CIP指令信息
    
    参数:
    
    address - 地址
    
    length - 指代数组的长度
    
    isConnectedAddress - 是否基于连接的协议的格式
    
    返回:
    
    CIP的指令信息
  - PackRequestReadSegment
```
public static byte[] PackRequestReadSegment(String address,
                                            int startIndex,
                                            int length)
                                     throws IOException
```
    打包生成一个请求读取数据片段的节点信息，CIP指令信息
    
    参数:
    
    address - 节点的名称
    
    startIndex - 起始的索引位置
    
    length - 读取的数据长度，对于short来说，最大是489长度
    
    返回:
    
    CIP的指令信息
    
    抛出:
    
    IOException
  - PackRequestWrite
```
public static byte[] PackRequestWrite(String address,
                                      int typeCode,
                                      byte[] value)
```
    根据指定的数据和类型，生成对应的数据
    
    参数:
    
    address - 地址信息
    
    typeCode - 数据类型
    
    value - 字节值
    
    返回:
    
    CIP的指令信息
  - PackRequestWrite
```
public static byte[] PackRequestWrite(String address,
                                      int typeCode,
                                      byte[] value,
                                      int length)
```
    根据指定的数据和类型，生成对应的数据
    
    参数:
    
    address - 地址信息
    
    typeCode - 数据类型
    
    value - 字节值
    
    length - 如果节点为数组，就是数组长度
    
    返回:
    
    CIP的指令信息
  - PackRequestWrite
```
public static byte[] PackRequestWrite(String address,
                                      int typeCode,
                                      byte[] value,
                                      int length,
                                      boolean isConnectedAddress)
```
    根据指定的数据和类型，生成对应的数据
    
    参数:
    
    address - 地址信息
    
    typeCode - 数据类型
    
    value - 字节值
    
    length - 如果节点为数组，就是数组长度
    
    isConnectedAddress - 是否基于连接的协议实现
    
    返回:
    
    CIP的指令信息
  - PackRequestWrite
```
public static byte[] PackRequestWrite(String address,
                                      boolean value)
                               throws IOException
```
    写入Bool数据的基本指令信息
    
    参数:
    
    address - 地址
    
    value - 值
    
    返回:
    
    报文信息
    
    抛出:
    
    IOException - 错误信息
  - AnalysisArrayIndex
```
public static OperateResultExTwo<String,Integer> AnalysisArrayIndex(String address)
```
    分析地址数据信息里的位索引的信息，例如a[10] 返回 a 和 10 索引，如果没有指定索引，就默认为0
    
    参数:
    
    address - 数据地址
    
    返回:
    
    地址信息及位索引
  - PackCommandService
```
public static byte[] PackCommandService(byte[] portSlot,
                                        byte[]... cips)
                                 throws IOException
```
    将所有的cip指定进行打包操作。
    
    参数:
    
    portSlot - PLC所在的面板槽号
    
    cips - 所有的cip打包指令信息
    
    返回:
    
    包含服务的信息
    
    抛出:
    
    IOException
  - PackCommandSingleService
```
public static byte[] PackCommandSingleService(byte[] command,
                                              int code,
                                              boolean isConnected)
```
    将所有的cip指定进行打包操作。
    
    参数:
    
    command - 指令信息
    
    code - 服务器的代号信息
    
    isConnected - 是否基于连接的服务
    
    返回:
    
    包含服务的信息
  - PackCommandSpecificData
```
public static byte[] PackCommandSpecificData(byte[]... service)
```
    生成读取直接节点数据信息的内容
    
    参数:
    
    service - cip指令内容
    
    返回:
    
    最终的指令值
    
    抛出:
    
    IOException
  - PackExecutePCCCRead
```
public static OperateResultExOne<byte[]> PackExecutePCCCRead(int tns,
                                                             String address,
                                                             short length)
```
    打包一个PCCC的读取的命令报文
    
    参数:
    
    tns - 请求序号信息
    
    address - 请求的文件地址，地址示例：N7:1
    
    length - 请求的字节长度
    
    返回:
    
    PCCC的读取报文信息
  - PackExecutePCCCWrite
```
public static OperateResultExOne<byte[]> PackExecutePCCCWrite(int tns,
                                                              String address,
                                                              byte[] value)
```
    打包一个PCCC的写入的命令报文
    
    参数:
    
    tns - 请求序号信息
    
    address - 请求的文件地址，地址示例：N7:1
    
    value - 写入的原始数据信息
    
    返回:
    
    PCCC的写入报文信息
  - PackExecutePCCCWrite
```
public static OperateResultExOne<byte[]> PackExecutePCCCWrite(int tns,
                                                              String address,
                                                              int bitIndex,
                                                              boolean value)
```
  - RegisterSessionHandle
```
public static byte[] RegisterSessionHandle()
```
    向PLC注册会话ID的报文
    Register a message with the PLC for the session ID
    
    返回:
    
    报文信息 -> Message information
  - RegisterSessionHandle
```
public static byte[] RegisterSessionHandle(byte[] senderContext)
```
    向PLC注册会话ID的报文
    Register a message with the PLC for the session ID
    
    参数:
    
    senderContext - 发送的上下文信息
    
    返回:
    
    报文信息 -> Message information
  - UnRegisterSessionHandle
```
public static byte[] UnRegisterSessionHandle(int sessionHandle)
```
    获取卸载一个已注册的会话的报文
    Get a message to uninstall a registered session
    
    参数:
    
    sessionHandle - 当前会话的ID信息
    
    返回:
    
    字节报文信息 -> BYTE message information
  - CheckResponse
```
public static OperateResult CheckResponse(byte[] response)
```
    初步检查返回的CIP协议的报文是否正确
    Initially check whether the returned CIP protocol message is correct
    
    参数:
    
    response - CIP的报文信息
    
    返回:
    
    是否正确的结果信息
  - PackRequestHeader
```
public static byte[] PackRequestHeader(int command,
                                       int session,
                                       byte[] commandSpecificData)
```
    将CommandSpecificData的命令，打包成可发送的数据指令
    
    参数:
    
    command - 实际的命令暗号
    
    session - 当前会话的id
    
    commandSpecificData - CommandSpecificData命令
    
    返回:
    
    最终可发送的数据命令
  - PackRequestHeader
```
public static byte[] PackRequestHeader(int command,
                                       int session,
                                       byte[] commandSpecificData,
                                       byte[] senderContext)
```
  - ExtractActualData
```
public static OperateResultExThree<byte[],Short,Boolean> ExtractActualData(byte[] response,
                                                                           boolean isRead)
```
    从PLC反馈的数据解析
    
    参数:
    
    response - PLC的反馈数据
    
    isRead - 是否是返回的操作
    
    返回:
    
    带有结果标识的最终数据
  - ReadPlcType
```
public static OperateResultExOne<String> ReadPlcType(IReadWriteDevice plc)
```
    从PLC里读取当前PLC的型号信息
    Read the current PLC model information from the PLC
    
    参数:
    
    plc - PLC对象
    
    返回:
    
    型号数据信息
  - PackCleanCommandService
```
public static byte[] PackCleanCommandService(byte[] portSlot,
                                             byte[]... cips)
```
    将所有的cip指定进行打包操作。
    
    参数:
    
    portSlot - PLC所在的面板槽号
    
    cips - 所有的cip打包指令信息
    
    返回:
    
    包含服务的信息

类 AllenBradleyHelper

字段概要

构造器概要

方法概要

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

字段详细资料

CIP_Execute_PCCC

CIP_READ_DATA

CIP_WRITE_DATA

CIP_READ_WRITE_DATA

CIP_READ_FRAGMENT

CIP_WRITE_FRAGMENT

CIP_READ_LIST

CIP_MULTIREAD_DATA

CIP_Type_Bool

CIP_Type_Byte

CIP_Type_Word

CIP_Type_DWord

CIP_Type_LInt

CIP_Type_USInt

CIP_Type_UInt

CIP_Type_UDint

CIP_Type_ULint

CIP_Type_Real

CIP_Type_Double

CIP_Type_Struct

CIP_Type_String

CIP_Type_D1

CIP_Type_D2

CIP_Type_BitArray

OriginatorVendorID

OriginatorSerialNumber

构造器详细资料

AllenBradleyHelper

方法详细资料

PackRequsetRead

PackRequsetRead

PackRequestReadSegment

PackRequestWrite

PackRequestWrite

PackRequestWrite

PackRequestWrite

AnalysisArrayIndex

PackCommandService

PackCommandSingleService

PackCommandSpecificData

PackExecutePCCCRead

PackExecutePCCCWrite

PackExecutePCCCWrite

RegisterSessionHandle

RegisterSessionHandle

UnRegisterSessionHandle

CheckResponse

PackRequestHeader

PackRequestHeader

ExtractActualData

ReadPlcType

PackCleanCommandService