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

java.lang.Object
- HslCommunication.Profinet.FATEK.FatekProgramHelper

public class FatekProgramHelper
extends Object

构造器概要

构造器
构造器和说明

FatekProgramHelper()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static OperateResultExOne<ArrayList<byte[]>>`	`BuildReadBoolCommand(byte station, String address, short length)` 创建一条Bool读取的指令信息，需要指定一些参数
`static OperateResultExOne<ArrayList<byte[]>>`	`BuildReadWordCommand(byte station, String address, short length)` 创建一条Word读取的指令信息，需要指定一些参数
`static OperateResultExOne<byte[]>`	`BuildWriteBoolCommand(byte station, String address, boolean[] value)` 创建一条别入bool数据的指令信息，需要指定一些参数
`static OperateResultExOne<byte[]>`	`BuildWriteByteCommand(byte station, String address, byte[] value)` 创建一条别入byte数据的指令信息，需要指定一些参数，按照字单位
`static String`	`CalculateAcc(String data)` 计算指令的和校验码
`static OperateResult`	`CheckResponse(byte[] content)` 检查PLC反馈的报文是否正确，如果不正确，返回错误消息
`static byte[]`	`ExtraResponse(byte[] response, short length)` 提取当前的结果数据信息，针对的是字单位的方式
`static String`	`GetErrorDescriptionFromCode(char code)` 根据错误码获取到真实的文本信息
`static byte[]`	`PackFatekCommand(byte station, String cmd)` 将Fatek的基本命令打包成可以发送PLC的电文消息
`static OperateResultExOne<byte[]>`	`Read(IReadWriteDevice device, byte station, String address, short length)` 批量读取PLC的字节数据，以字为单位，支持读取X,Y,M,S,D,T,C,R,RT,RC具体的地址范围需要根据PLC型号来确认，地址可以携带站号信息，例如 s=2;D100 Read PLC byte data in batches, in word units.
`static OperateResultExOne<boolean[]>`	`ReadBool(IReadWriteDevice device, byte station, String address, short length)` 批量读取bool类型数据，支持的类型为X,Y,M,S,T,C，具体的地址范围取决于PLC的类型，地址可以携带站号信息，例如 s=2;M100 Read bool data in batches.
`static OperateResultExOne<boolean[]>`	`ReadStatus(IReadWriteDevice device, byte station)` 读取当前PLC的状态信息，返回一个bool数组，同时包含了几种电量信息，分别为 0: RUN/STOP, 1: BAT LOW/正常, 2: Ladder checksum error/正常, 3: 使用ROM PACK/未使用, 4: WDT Timeout/正常, 5: 设定ID/未设ID， 6：紧急停机/正常 Read the status information of the current PLC and return a bool array, which also contains several power information, 0: RUN/STOP, 1: BAT LOW/normal, 2: Ladder checksum error/normal, 3: Use ROM PACK/ Not used, 4: WDT Timeout/Normal, 5: ID set/ID not set, 6: Emergency stop/Normal
`static OperateResult`	`Run(IReadWriteDevice device, byte station)` 使PLC处于RUN的状态
`static OperateResult`	`Stop(IReadWriteDevice device, byte station)` 使PLC处于STOP状态
`static OperateResult`	`Write(IReadWriteDevice device, byte station, String address, boolean[] value)` 批量写入bool类型的数组，支持的类型为X,Y,M,S,T,C，具体的地址范围取决于PLC的类型，地址可以携带站号信息，例如 s=2;M100 Write arrays of type bool in batches.
`static OperateResult`	`Write(IReadWriteDevice device, byte station, String address, byte[] value)` 批量写入PLC的数据，以字为单位，也就是说最少2个字节信息，支持X,Y,M,S,D,T,C,R,RT,RC具体的地址范围需要根据PLC型号来确认，地址可以携带站号信息，例如 s=2;D100 The data written to the PLC in batches, in units of words, that is, at least 2 bytes of information, supporting X, Y, M, S, D, T, C, R, RT, and RC.

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

- 构造器详细资料
  - FatekProgramHelper
```
public FatekProgramHelper()
```
- 方法详细资料
  - CalculateAcc
```
public static String CalculateAcc(String data)
```
    计算指令的和校验码
    
    参数:
    
    data - 指令
    
    返回:
    
    校验之后的信息
  - PackFatekCommand
```
public static byte[] PackFatekCommand(byte station,
                                      String cmd)
```
    将Fatek的基本命令打包成可以发送PLC的电文消息
    
    参数:
    
    station - PLC的站号信息
    
    cmd - 基本命令信息
    
    返回:
    
    发送PLC的电文消息
  - BuildReadWordCommand
```
public static OperateResultExOne<ArrayList<byte[]>> BuildReadWordCommand(byte station,
                                                                         String address,
                                                                         short length)
```
    创建一条Word读取的指令信息，需要指定一些参数
    
    参数:
    
    station - PLC的站号
    
    address - 地址信息
    
    length - 数据长度
    
    返回:
    
    是否成功的结果对象
  - BuildReadBoolCommand
```
public static OperateResultExOne<ArrayList<byte[]>> BuildReadBoolCommand(byte station,
                                                                         String address,
                                                                         short length)
```
    创建一条Bool读取的指令信息，需要指定一些参数
    
    参数:
    
    station - PLC的站号
    
    address - 地址信息
    
    length - 数据长度
    
    返回:
    
    是否成功的结果对象
  - ExtraResponse
```
public static byte[] ExtraResponse(byte[] response,
                                   short length)
```
    提取当前的结果数据信息，针对的是字单位的方式
    
    参数:
    
    response - PLC返回的数据信息
    
    length - 读取的长度内容
    
    返回:
    
    结果数组
  - BuildWriteBoolCommand
```
public static OperateResultExOne<byte[]> BuildWriteBoolCommand(byte station,
                                                               String address,
                                                               boolean[] value)
```
    创建一条别入bool数据的指令信息，需要指定一些参数
    
    参数:
    
    station - 站号
    
    address - 地址
    
    value - 数组值
    
    返回:
    
    是否创建成功
  - BuildWriteByteCommand
```
public static OperateResultExOne<byte[]> BuildWriteByteCommand(byte station,
                                                               String address,
                                                               byte[] value)
```
    创建一条别入byte数据的指令信息，需要指定一些参数，按照字单位
    
    参数:
    
    station - 站号
    
    address - 地址
    
    value - 数组值
    
    返回:
    
    是否创建成功
  - CheckResponse
```
public static OperateResult CheckResponse(byte[] content)
```
    检查PLC反馈的报文是否正确，如果不正确，返回错误消息
    
    参数:
    
    content - PLC反馈的报文信息
    
    返回:
    
    反馈的报文是否正确
  - GetErrorDescriptionFromCode
```
public static String GetErrorDescriptionFromCode(char code)
```
    根据错误码获取到真实的文本信息
    
    参数:
    
    code - 错误码
    
    返回:
    
    错误的文本描述
  - Read
```
public static OperateResultExOne<byte[]> Read(IReadWriteDevice device,
                                              byte station,
                                              String address,
                                              short length)
```
    批量读取PLC的字节数据，以字为单位，支持读取X,Y,M,S,D,T,C,R,RT,RC具体的地址范围需要根据PLC型号来确认，地址可以携带站号信息，例如 s=2;D100
    Read PLC byte data in batches, in word units. Supports reading X, Y, M, S, D, T, C, R, RT, RC. The specific address range needs to be confirmed according to the PLC model, The address can carry station number information, such as s=2;D100
    
    参数:
    
    device - PLC通信的对象
    
    station - 设备的站点信息
    
    address - 地址信息
    
    length - 数据长度
    
    返回:
    
    读取结果信息
  - Write
```
public static OperateResult Write(IReadWriteDevice device,
                                  byte station,
                                  String address,
                                  byte[] value)
```
    批量写入PLC的数据，以字为单位，也就是说最少2个字节信息，支持X,Y,M,S,D,T,C,R,RT,RC具体的地址范围需要根据PLC型号来确认，地址可以携带站号信息，例如 s=2;D100
    The data written to the PLC in batches, in units of words, that is, at least 2 bytes of information, supporting X, Y, M, S, D, T, C, R, RT, and RC. The specific address range needs to be based on the PLC model To confirm, The address can carry station number information, such as s=2;D100
    
    参数:
    
    device - PLC通信的对象
    
    station - 设备的站号信息
    
    address - 地址信息，举例，D100，R200，RC100，RT200
    
    value - 数据值
    
    返回:
    
    是否写入成功
  - ReadBool
```
public static OperateResultExOne<boolean[]> ReadBool(IReadWriteDevice device,
                                                     byte station,
                                                     String address,
                                                     short length)
```
    批量读取bool类型数据，支持的类型为X,Y,M,S,T,C，具体的地址范围取决于PLC的类型，地址可以携带站号信息，例如 s=2;M100
    Read bool data in batches. The supported types are X, Y, M, S, T, C. The specific address range depends on the type of PLC, The address can carry station number information, such as s=2;M100
    
    参数:
    
    device - PLC通信对象
    
    station - 设备的站号信息
    
    address - 地址信息，比如X10，Y17，M100
    
    length - 读取的长度
    
    返回:
    
    读取结果信息
  - Write
```
public static OperateResult Write(IReadWriteDevice device,
                                  byte station,
                                  String address,
                                  boolean[] value)
```
    批量写入bool类型的数组，支持的类型为X,Y,M,S,T,C，具体的地址范围取决于PLC的类型，地址可以携带站号信息，例如 s=2;M100
    Write arrays of type bool in batches. The supported types are X, Y, M, S, T, C. The specific address range depends on the type of PLC, The address can carry station number information, such as s=2;M100
    
    参数:
    
    device - PLC通信对象
    
    station - 站号信息
    
    address - PLC的地址信息
    
    value - 数据信息
    
    返回:
    
    是否写入成功
  - Run
```
public static OperateResult Run(IReadWriteDevice device,
                                byte station)
```
    使PLC处于RUN的状态
    
    参数:
    
    device - PLC通信对象
    
    station - 站号信息
    
    返回:
    
    是否操作成功
  - Stop
```
public static OperateResult Stop(IReadWriteDevice device,
                                 byte station)
```
    使PLC处于STOP状态
    
    参数:
    
    device - PLC通信对象
    
    station - 站号信息
    
    返回:
    
    是否操作成功
  - ReadStatus
```
public static OperateResultExOne<boolean[]> ReadStatus(IReadWriteDevice device,
                                                       byte station)
```
    读取当前PLC的状态信息，返回一个bool数组，同时包含了几种电量信息，分别为 0: RUN/STOP, 1: BAT LOW/正常, 2: Ladder checksum error/正常, 3: 使用ROM PACK/未使用, 4: WDT Timeout/正常, 5: 设定ID/未设ID， 6：紧急停机/正常
    Read the status information of the current PLC and return a bool array, which also contains several power information, 0: RUN/STOP, 1: BAT LOW/normal, 2: Ladder checksum error/normal, 3: Use ROM PACK/ Not used, 4: WDT Timeout/Normal, 5: ID set/ID not set, 6: Emergency stop/Normal
    
    参数:
    
    device - PLC通信对象
    
    station - 站号信息
    
    返回:
    
    状态结果信息

类 FatekProgramHelper

构造器概要

方法概要

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

构造器详细资料

FatekProgramHelper

方法详细资料

CalculateAcc

PackFatekCommand

BuildReadWordCommand

BuildReadBoolCommand

ExtraResponse

BuildWriteBoolCommand

BuildWriteByteCommand

CheckResponse

GetErrorDescriptionFromCode

Read

Write

ReadBool

Write

Run

Stop

ReadStatus