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

java.lang.Object
- HslCommunication.Profinet.Keyence.KeyenceNanoHelper

public class KeyenceNanoHelper
extends Object

KeyenceNano的基本辅助方法

构造器概要

构造器
构造器和说明

KeyenceNanoHelper()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static OperateResultExOne<byte[]>`	`BuildReadCommand(String address, short length)` 建立读取PLC数据的指令，需要传入地址数据，以及读取的长度，地址示例参照类的说明文档 To create a command to read PLC data, you need to pass in the address data, and the length of the read.
`static OperateResultExOne<byte[]>`	`BuildWriteCommand(String address, boolean value)` 建立写入bool数据的指令，针对地址类型为 R,CR,MR,LR Create instructions to write bool data, address type is R, CR, MR, LR+
`static OperateResultExOne<byte[]>`	`BuildWriteCommand(String address, boolean[] value)` 批量写入数据位到plc地址，针对地址格式为 R,B,CR,MR,LR,VB Write data bits in batches to the plc address, and the address format is R, B, CR, MR, LR, VB
`static OperateResultExOne<byte[]>`	`BuildWriteCommand(String address, byte[] value)` 建立写入PLC数据的指令，需要传入地址数据，以及写入的数据信息，地址示例参照类的说明文档 To create a command to write PLC data, you need to pass in the address data and the written data information.
`static OperateResultExOne<byte[]>`	`BuildWriteExpansionMemoryCommand(byte unit, int address, byte[] value)` 构建写入扩展单元缓冲寄存器的报文命令，需要传入单元编号，地址，写入的数据，实际写入的数据格式才有无符号的方式 To construct a message command to write to the buffer register of the expansion unit, the unit number, address, and data to be written need to be passed in, and the format of the actually written data is unsigned.
`static OperateResult`	`CheckPlcReadResponse(byte[] ack)` 校验读取返回数据状态，主要返回的第一个字节是不是E Check the status of the data returned from reading, whether the first byte returned is E
`static OperateResult`	`CheckPlcWriteResponse(byte[] ack)` 校验写入返回数据状态，检测返回的数据是不是OK Verify the status of the returned data written and check whether the returned data is OK
`static OperateResultExOne<boolean[]>`	`ExtractActualBoolData(String addressType, byte[] response)` 从PLC反馈的数据进行提炼Bool操作 Refine Bool operation from data fed back from PLC
`static OperateResultExOne<byte[]>`	`ExtractActualData(String addressType, byte[] response)` 从PLC反馈的数据进行提炼操作 Refining operation from data fed back from PLC
`static byte[]`	`GetConnectCmd(byte station, boolean useStation)` 连接PLC的命令报文 Command message to connect to PLC
`static byte[]`	`GetDisConnectCmd(byte station, boolean useStation)` 断开PLC连接的命令报文 Command message to disconnect PLC
`static int`	`GetWordAddressMultiple(String type)` 获取当前的地址类型是字数据的倍数关系
`static OperateResultExTwo<String,Integer>`	`KvAnalysisAddress(String address)` 解析数据地址成不同的Keyence地址类型 Parse data addresses into different keyence address types
`static OperateResultExOne<byte[]>`	`Read(IReadWriteDevice keyence, String address, short length)`
`static OperateResultExOne<String>`	`ReadAddressAnnotation(IReadWriteDevice keyence, String address)` [商业授权] 读取指定软元件的注释信息 [Authorization] Read the comment information of the specified device
`static OperateResultExOne<boolean[]>`	`ReadBool(IReadWriteDevice keyence, String address, short length)`
`static OperateResultExOne<byte[]>`	`ReadExpansionMemory(IReadWriteDevice keyence, byte unit, short address, short length)` [商业授权] 从扩展单元缓冲存储器连续读取指定个数的数据，单位为字 [Authorization] Continuously read the specified number of data from the expansion unit buffer memory, the unit is word
`static OperateResultExOne<Integer>`	`ReadPlcMode(IReadWriteDevice keyence)` [商业授权] 读取当前PLC的模式，如果是0，代表 PROG模式或者梯形图未登录，如果为1，代表RUN模式 [Authorization] Read the current PLC mode, if it is 0, it means PROG mode or the ladder diagram is not registered, if it is 1, it means RUN mode
`static OperateResultExOne<KeyencePLCS>`	`ReadPlcType(IReadWriteDevice keyence)` [商业授权] 查询PLC的型号信息 [Authorization] Query PLC model information
`static OperateResult`	`SetPlcDateTime(IReadWriteDevice keyence, Date dateTime)` [商业授权] 设置PLC的时间 [Authorization] Set PLC time
`static OperateResult`	`Write(IReadWriteDevice keyence, String address, boolean value)`
`static OperateResult`	`Write(IReadWriteDevice keyence, String address, boolean[] value)`
`static OperateResult`	`Write(IReadWriteDevice keyence, String address, byte[] value)`
`static OperateResult`	`WriteExpansionMemory(IReadWriteDevice keyence, byte unit, short address, byte[] value)` [商业授权] 将原始字节数据写入到扩展的缓冲存储器，需要指定单元编号，偏移地址，写入的数据 [Authorization] To write the original byte data to the extended buffer memory, you need to specify the unit number, offset address, and write data

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

- 构造器详细资料
  - KeyenceNanoHelper
```
public KeyenceNanoHelper()
```
- 方法详细资料
  - GetConnectCmd
```
public static byte[] GetConnectCmd(byte station,
                                   boolean useStation)
```
    连接PLC的命令报文
    Command message to connect to PLC
    
    参数:
    
    station - 当前PLC的站号信息
    
    useStation - 是否启动站号命令
    
    返回:
    
    连接的报文命令
  - GetDisConnectCmd
```
public static byte[] GetDisConnectCmd(byte station,
                                      boolean useStation)
```
    断开PLC连接的命令报文
    Command message to disconnect PLC
    
    参数:
    
    station - 当前PLC的站号信息
    
    useStation - 是否启动站号命令
    
    返回:
    
    断开的报文命令
  - GetWordAddressMultiple
```
public static int GetWordAddressMultiple(String type)
```
    获取当前的地址类型是字数据的倍数关系
    
    参数:
    
    type - 地址的类型
    
    返回:
    
    倍数关系
  - BuildReadCommand
```
public static OperateResultExOne<byte[]> BuildReadCommand(String address,
                                                          short length)
```
    建立读取PLC数据的指令，需要传入地址数据，以及读取的长度，地址示例参照类的说明文档
    To create a command to read PLC data, you need to pass in the address data, and the length of the read. For an example of the address, refer to the class documentation
    
    参数:
    
    address - 软元件地址
    
    length - 读取长度
    
    返回:
    
    是否建立成功
  - BuildWriteCommand
```
public static OperateResultExOne<byte[]> BuildWriteCommand(String address,
                                                           byte[] value)
```
    建立写入PLC数据的指令，需要传入地址数据，以及写入的数据信息，地址示例参照类的说明文档
    To create a command to write PLC data, you need to pass in the address data and the written data information. For an example of the address, refer to the class documentation
    
    参数:
    
    address - 软元件地址
    
    value - 转换后的数据
    
    返回:
    
    是否成功的信息
  - BuildWriteExpansionMemoryCommand
```
public static OperateResultExOne<byte[]> BuildWriteExpansionMemoryCommand(byte unit,
                                                                          int address,
                                                                          byte[] value)
```
    构建写入扩展单元缓冲寄存器的报文命令，需要传入单元编号，地址，写入的数据，实际写入的数据格式才有无符号的方式
    To construct a message command to write to the buffer register of the expansion unit, the unit number, address, and data to be written need to be passed in, and the format of the actually written data is unsigned.
    
    参数:
    
    unit - 单元编号0~48
    
    address - 地址0~32767
    
    value - 写入的数据信息，单次交互最大256个字
    
    返回:
    
    包含是否成功的报文对象
  - BuildWriteCommand
```
public static OperateResultExOne<byte[]> BuildWriteCommand(String address,
                                                           boolean value)
```
    建立写入bool数据的指令，针对地址类型为 R,CR,MR,LR
    Create instructions to write bool data, address type is R, CR, MR, LR+
    
    参数:
    
    address - 软元件地址
    
    value - 转换后的数据
    
    返回:
    
    是否成功的信息
  - BuildWriteCommand
```
public static OperateResultExOne<byte[]> BuildWriteCommand(String address,
                                                           boolean[] value)
```
    批量写入数据位到plc地址，针对地址格式为 R,B,CR,MR,LR,VB
    Write data bits in batches to the plc address, and the address format is R, B, CR, MR, LR, VB
    
    参数:
    
    address - PLC的地址
    
    value - 等待写入的bool数组
    
    返回:
    
    写入bool数组的命令报文
  - CheckPlcReadResponse
```
public static OperateResult CheckPlcReadResponse(byte[] ack)
```
    校验读取返回数据状态，主要返回的第一个字节是不是E
    Check the status of the data returned from reading, whether the first byte returned is E
    
    参数:
    
    ack - 反馈信息
    
    返回:
    
    是否成功的信息
  - CheckPlcWriteResponse
```
public static OperateResult CheckPlcWriteResponse(byte[] ack)
```
    校验写入返回数据状态，检测返回的数据是不是OK
    Verify the status of the returned data written and check whether the returned data is OK
    
    参数:
    
    ack - 反馈信息
    
    返回:
    
    是否成功的信息
  - ExtractActualBoolData
```
public static OperateResultExOne<boolean[]> ExtractActualBoolData(String addressType,
                                                                  byte[] response)
```
    从PLC反馈的数据进行提炼Bool操作
    Refine Bool operation from data fed back from PLC
    
    参数:
    
    addressType - 地址的数据类型
    
    response - PLC反馈的真实数据
    
    返回:
    
    数据提炼后的真实数据
  - ExtractActualData
```
public static OperateResultExOne<byte[]> ExtractActualData(String addressType,
                                                           byte[] response)
```
    从PLC反馈的数据进行提炼操作
    Refining operation from data fed back from PLC
    
    参数:
    
    addressType - 地址的数据类型
    
    response - PLC反馈的真实数据
    
    返回:
    
    数据提炼后的真实数据
  - KvAnalysisAddress
```
public static OperateResultExTwo<String,Integer> KvAnalysisAddress(String address)
```
    解析数据地址成不同的Keyence地址类型
    Parse data addresses into different keyence address types
    
    参数:
    
    address - 数据地址
    
    返回:
    
    地址结果对象
  - Read
```
public static OperateResultExOne<byte[]> Read(IReadWriteDevice keyence,
                                              String address,
                                              short length)
```
  - Write
```
public static OperateResult Write(IReadWriteDevice keyence,
                                  String address,
                                  byte[] value)
```
  - ReadBool
```
public static OperateResultExOne<boolean[]> ReadBool(IReadWriteDevice keyence,
                                                     String address,
                                                     short length)
```
  - Write
```
public static OperateResult Write(IReadWriteDevice keyence,
                                  String address,
                                  boolean value)
```
  - Write
```
public static OperateResult Write(IReadWriteDevice keyence,
                                  String address,
                                  boolean[] value)
```
  - ReadPlcType
```
public static OperateResultExOne<KeyencePLCS> ReadPlcType(IReadWriteDevice keyence)
```
    [商业授权] 查询PLC的型号信息
    [Authorization] Query PLC model information
    
    参数:
    
    keyence - PLC通信对象
    
    返回:
    
    包含型号的结果对象
  - ReadPlcMode
```
public static OperateResultExOne<Integer> ReadPlcMode(IReadWriteDevice keyence)
```
    [商业授权] 读取当前PLC的模式，如果是0，代表 PROG模式或者梯形图未登录，如果为1，代表RUN模式
    [Authorization] Read the current PLC mode, if it is 0, it means PROG mode or the ladder diagram is not registered, if it is 1, it means RUN mode
    
    参数:
    
    keyence - PLC通信对象
    
    返回:
    
    包含模式的结果对象
  - SetPlcDateTime
```
public static OperateResult SetPlcDateTime(IReadWriteDevice keyence,
                                           Date dateTime)
```
    [商业授权] 设置PLC的时间
    [Authorization] Set PLC time
    
    参数:
    
    keyence - PLC通信对象
    
    dateTime - 时间数据
    
    返回:
    
    是否设置成功
  - ReadAddressAnnotation
```
public static OperateResultExOne<String> ReadAddressAnnotation(IReadWriteDevice keyence,
                                                               String address)
```
    [商业授权] 读取指定软元件的注释信息
    [Authorization] Read the comment information of the specified device
    
    参数:
    
    keyence - PLC通信对象
    
    address - 软元件的地址
    
    返回:
    
    软元件的注释信息
  - ReadExpansionMemory
```
public static OperateResultExOne<byte[]> ReadExpansionMemory(IReadWriteDevice keyence,
                                                             byte unit,
                                                             short address,
                                                             short length)
```
    [商业授权] 从扩展单元缓冲存储器连续读取指定个数的数据，单位为字
    [Authorization] Continuously read the specified number of data from the expansion unit buffer memory, the unit is word
    
    参数:
    
    keyence - PLC的通信对象
    
    unit - 单元编号
    
    address - 偏移地址
    
    length - 读取的长度，单位为字
    
    返回:
    
    包含是否成功的原始字节数组
  - WriteExpansionMemory
```
public static OperateResult WriteExpansionMemory(IReadWriteDevice keyence,
                                                 byte unit,
                                                 short address,
                                                 byte[] value)
```
    [商业授权] 将原始字节数据写入到扩展的缓冲存储器，需要指定单元编号，偏移地址，写入的数据
    [Authorization] To write the original byte data to the extended buffer memory, you need to specify the unit number, offset address, and write data
    
    参数:
    
    keyence - PLC通信对象信息
    
    unit - 单元编号
    
    address - 偏移地址
    
    value - 等待写入的原始字节数据
    
    返回:
    
    是否写入成功的结果对象

类 KeyenceNanoHelper

构造器概要

方法概要

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

构造器详细资料

KeyenceNanoHelper

方法详细资料

GetConnectCmd

GetDisConnectCmd

GetWordAddressMultiple

BuildReadCommand

BuildWriteCommand

BuildWriteExpansionMemoryCommand

BuildWriteCommand

BuildWriteCommand

CheckPlcReadResponse

CheckPlcWriteResponse

ExtractActualBoolData

ExtractActualData

KvAnalysisAddress

Read

Write

ReadBool

Write

Write

ReadPlcType

ReadPlcMode

SetPlcDateTime

ReadAddressAnnotation

ReadExpansionMemory

WriteExpansionMemory