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

java.lang.Object
- HslCommunication.Core.Net.NetworkBase.NetworkBase
- - HslCommunication.Core.Net.NetworkBase.NetworkUdpBase
  - - HslCommunication.Core.Net.NetworkBase.NetworkUdpDeviceBase
    - - HslCommunication.Profinet.Melsec.MelsecMcUdp

所有已实现的接口:

IReadWriteDevice, IReadWriteNet, IReadWriteMc
```
public class MelsecMcUdp
extends NetworkUdpDeviceBase
implements IReadWriteMc
```
三菱PLC通讯类，采用UDP的协议实现，采用Qna兼容3E帧协议实现，需要在PLC侧先的以太网模块先进行配置，必须为二进制通讯
Mitsubishi PLC communication class is implemented using UDP protocol and Qna compatible 3E frame protocol. The Ethernet module needs to be configured first on the PLC side, and it must be binary communication.

字段概要
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkUdpDeviceBase
  WordLength
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkUdpBase
  simpleHybirdLock
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase
  CoreSocket, fileCacheSize, LogNet, Token
- 从接口继承的字段 HslCommunication.Core.Net.IReadWriteNet
  LogNet

构造器概要

构造器
构造器和说明

MelsecMcUdp()

MelsecMcUdp(String ipAddress, int port)

构造器
构造器和说明
`MelsecMcUdp()`
`MelsecMcUdp(String ipAddress, int port)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`OperateResult`	`ErrorStateReset()` LED 熄灭出错代码初始化 LED off Error code initialization
`byte[]`	`ExtractActualData(byte[] response, boolean isBit)` 从PLC反馈的数据中提取出实际的数据内容，需要传入反馈数据，是否位读取
`McType`	`getMcType()` 获取当前的PLC类型
`byte`	`getNetworkNumber()` 获取网络号
`byte`	`getNetworkStationNumber()` 获取网络站号
`OperateResultExOne<McAddressData>`	`McAnalysisAddress(String address, short length)` 当前MC协议的分析地址的方法，对传入的字符串格式的地址进行数据解析。
`protected byte[]`	`PackCommandWithHeader(byte[] command)` 对当前的命令进行打包处理，通常是携带命令头内容，标记当前的命令的长度信息，需要进行重写，否则默认不打包
`OperateResultExOne<byte[]>`	`Read(String address, short length)` 批量读取字节数组信息，需要指定地址和长度，返回原始的字节数组 Batch read byte array information, need to specify the address and length, return the original byte array
`OperateResultExOne<boolean[]>`	`ReadBool(String address, short length)` 批量读取 `Boolean` 数组信息，需要指定地址和长度，返回 `Boolean` 数组 Batch read `Boolean` array information, need to specify the address and length, return `Boolean` array
`OperateResultExOne<byte[]>`	`ReadExtend(short extend, String address, short length)` 读取扩展的数据信息，需要在原有的地址，长度信息之外，输入扩展值信息 To read the extended data information, you need to enter the extended value information in addition to the original address and length information
`OperateResultExOne<byte[]>`	`ReadMemory(String address, short length)` 读取缓冲寄存器的数据信息，地址直接为偏移地址 Read the data information of the buffer register, the address is directly the offset address
`OperateResultExOne<String>`	`ReadPlcType()` 读取PLC的型号信息，例如 Q02HCPU Read PLC model information, such as Q02HCPU
`OperateResultExOne<byte[]>`	`ReadRandom(String[] address)` 随机读取PLC的数据信息，可以跨地址，跨类型组合，但是每个地址只能读取一个word，也就是2个字节的内容。
`OperateResultExOne<byte[]>`	`ReadRandom(String[] address, short[] length)` 随机读取PLC的数据信息，可以跨地址，跨类型组合，每个地址是任意的长度。
`OperateResultExOne<short[]>`	`ReadRandomInt16(String[] address)` 随机读取PLC的数据信息，可以跨地址，跨类型组合，但是每个地址只能读取一个word，也就是2个字节的内容。
`OperateResultExOne<byte[]>`	`ReadTags(String[] tags, short[] length)` 读取PLC的标签信息，需要传入标签的名称，读取的字长度，标签举例：A; label[1]; bbb[10,10,10] To read the label information of the PLC, you need to pass in the name of the label, the length of the word read, and an example of the label: A; label [1]; bbb [10,10,10]
`OperateResultExOne<byte[]>`	`ReadTags(String tag, short length)` 读取PLC的标签信息，需要传入标签的名称，读取的字长度，标签举例：A; label[1]; bbb[10,10,10] To read the label information of the PLC, you need to pass in the name of the label, the length of the word read, and an example of the label: A; label [1]; bbb [10,10,10]
`OperateResult`	`RemoteReset()` 远程Reset操作 Remote Reset Operation
`OperateResult`	`RemoteRun()` 远程Run操作 Remote Run Operation
`OperateResult`	`RemoteStop()` 远程Stop操作 Remote Stop operation
`void`	`setNetworkNumber(byte networkNumber)` 设置网络号
`void`	`setNetworkStationNumber(byte networkStationNumber)` 设置网络站号
`String`	`toString()` 返回当前对象表示的字符串 Returns the string represented by the current object
`protected OperateResultExOne<byte[]>`	`UnpackResponseContent(byte[] send, byte[] response)` 根据对方返回的报文命令，对命令进行基本的拆包，例如各种Modbus协议拆包为统一的核心报文，还支持对报文的验证
`OperateResult`	`Write(String address, boolean[] values)` 批量写入 `Boolean` 数组数据，返回是否成功 Batch write `Boolean` array data, return whether the write was successful
`OperateResult`	`Write(String address, byte[] value)` 写入原始的byte数组数据到指定的地址，返回是否写入成功 Write the original byte array data to the specified address, and return whether the write was successful

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

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkUdpBase
getConnectionId, getIpAddress, getPort, getReceiveCacheLength, getReceiveTimeOut, ReadFromCoreServer, ReadFromCoreServer, setConnectionId, setIpAddress, setPort, setReceiveCacheLength, setReceiveTimeOut

从类继承的方法 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.Profinet.Melsec.Helper.IReadWriteMc
getByteTransform

从接口继承的方法 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, Write, Write, WriteCustomer

- 构造器详细资料
  - MelsecMcUdp
```
public MelsecMcUdp()
```
  - MelsecMcUdp
```
public MelsecMcUdp(String ipAddress,
                   int port)
```
- 方法详细资料
  - getNetworkNumber
```
public byte getNetworkNumber()
```
    获取网络号
    
    指定者:
    
    getNetworkNumber 在接口中 IReadWriteMc
    
    返回:
    
    网络号
  - setNetworkNumber
```
public void setNetworkNumber(byte networkNumber)
```
    设置网络号
    
    指定者:
    
    setNetworkNumber 在接口中 IReadWriteMc
    
    参数:
    
    networkNumber - 网络号
  - getNetworkStationNumber
```
public byte getNetworkStationNumber()
```
    获取网络站号
    
    指定者:
    
    getNetworkStationNumber 在接口中 IReadWriteMc
    
    返回:
    
    网络站号
  - setNetworkStationNumber
```
public void setNetworkStationNumber(byte networkStationNumber)
```
    设置网络站号
    
    指定者:
    
    setNetworkStationNumber 在接口中 IReadWriteMc
    
    参数:
    
    networkStationNumber - 网络站号
  - getMcType
```
public McType getMcType()
```
    获取当前的PLC类型
    
    指定者:
    
    getMcType 在接口中 IReadWriteMc
    
    返回:
    
    类型信息
  - McAnalysisAddress
```
public OperateResultExOne<McAddressData> McAnalysisAddress(String address,
                                                           short length)
```
    从接口复制的说明: IReadWriteMc
    
    当前MC协议的分析地址的方法，对传入的字符串格式的地址进行数据解析。
    The current MC protocol's address analysis method performs data parsing on the address of the incoming string format.
    
    指定者:
    
    McAnalysisAddress 在接口中 IReadWriteMc
    
    参数:
    
    address - 地址信息
    
    length - 数据长度
    
    返回:
    
    解析后的数据信息
  - PackCommandWithHeader
```
protected byte[] PackCommandWithHeader(byte[] command)
```
    从类复制的说明: NetworkUdpBase
    
    对当前的命令进行打包处理，通常是携带命令头内容，标记当前的命令的长度信息，需要进行重写，否则默认不打包
    
    覆盖:
    
    PackCommandWithHeader 在类中 NetworkUdpBase
    
    参数:
    
    command - 发送的数据命令内容
    
    返回:
    
    打包之后的数据结果信息
  - UnpackResponseContent
```
protected OperateResultExOne<byte[]> UnpackResponseContent(byte[] send,
                                                           byte[] response)
```
    从类复制的说明: NetworkUdpBase
    
    根据对方返回的报文命令，对命令进行基本的拆包，例如各种Modbus协议拆包为统一的核心报文，还支持对报文的验证
    
    覆盖:
    
    UnpackResponseContent 在类中 NetworkUdpBase
    
    参数:
    
    send - 发送的原始报文数据
    
    response - 设备方反馈的原始报文内容
    
    返回:
    
    返回拆包之后的报文信息，默认不进行任何的拆包操作
  - ExtractActualData
```
public byte[] ExtractActualData(byte[] response,
                                boolean isBit)
```
    从接口复制的说明: IReadWriteMc
    
    从PLC反馈的数据中提取出实际的数据内容，需要传入反馈数据，是否位读取
    
    指定者:
    
    ExtractActualData 在接口中 IReadWriteMc
    
    参数:
    
    response - 反馈的数据内容
    
    isBit - 是否位读取
    
    返回:
    
    解析后的结果对象
  - Read
```
public OperateResultExOne<byte[]> Read(String address,
                                       short length)
```
    从接口复制的说明: IReadWriteNet
    
    批量读取字节数组信息，需要指定地址和长度，返回原始的字节数组
    Batch read byte array information, need to specify the address and length, return the original byte array
    
    指定者:
    
    Read 在接口中 IReadWriteNet
    
    覆盖:
    
    Read 在类中 NetworkUdpDeviceBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的byte[]数组
  - ReadBool
```
public OperateResultExOne<boolean[]> ReadBool(String address,
                                              short length)
```
    从接口复制的说明: IReadWriteNet
    
    批量读取 Boolean 数组信息，需要指定地址和长度，返回 Boolean 数组
    Batch read Boolean array information, need to specify the address and length, return Boolean array
    
    指定者:
    
    ReadBool 在接口中 IReadWriteNet
    
    覆盖:
    
    ReadBool 在类中 NetworkUdpDeviceBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的boolean[]数组
  - Write
```
public OperateResult Write(String address,
                           byte[] value)
```
    从接口复制的说明: IReadWriteNet
    
    写入原始的byte数组数据到指定的地址，返回是否写入成功
    Write the original byte array data to the specified address, and return whether the write was successful
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkUdpDeviceBase
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
public OperateResult Write(String address,
                           boolean[] values)
```
    从接口复制的说明: IReadWriteNet
    
    批量写入 Boolean 数组数据，返回是否成功
    Batch write Boolean array data, return whether the write was successful
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkUdpDeviceBase
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    是否写入成功
  - ReadRandom
```
public OperateResultExOne<byte[]> ReadRandom(String[] address)
```
    随机读取PLC的数据信息，可以跨地址，跨类型组合，但是每个地址只能读取一个word，也就是2个字节的内容。收到结果后，需要自行解析数据
    Randomly read PLC data information, which can be combined across addresses and types, but each address can only read one word, which is the content of 2 bytes. After receiving the results, you need to parse the data yourself
    
    参数:
    
    address - 所有的地址的集合
    
    返回:
    
    结果
  - ReadRandom
```
public OperateResultExOne<byte[]> ReadRandom(String[] address,
                                             short[] length)
```
    随机读取PLC的数据信息，可以跨地址，跨类型组合，每个地址是任意的长度。收到结果后，需要自行解析数据，目前只支持字地址，比如D区，W区，R区，不支持X，Y，M，B，L等等
    Read the data information of the PLC randomly. It can be combined across addresses and types. Each address is of any length. After receiving the results, you need to parse the data yourself. Currently, only word addresses are supported, such as D area, W area, R area. X, Y, M, B, L, etc
    
    参数:
    
    address - 所有的地址的集合
    
    length - 每个地址的长度信息
    
    返回:
    
    结果
  - ReadRandomInt16
```
public OperateResultExOne<short[]> ReadRandomInt16(String[] address)
```
    随机读取PLC的数据信息，可以跨地址，跨类型组合，但是每个地址只能读取一个word，也就是2个字节的内容。收到结果后，自动转换为了short类型的数组
    Randomly read PLC data information, which can be combined across addresses and types, but each address can only read one word, which is the content of 2 bytes. After receiving the result, it is automatically converted to an array of type short.
    
    参数:
    
    address - 所有的地址的集合
    
    返回:
    
    结果
  - ReadTags
```
public OperateResultExOne<byte[]> ReadTags(String tag,
                                           short length)
```
    读取PLC的标签信息，需要传入标签的名称，读取的字长度，标签举例：A; label[1]; bbb[10,10,10]
    To read the label information of the PLC, you need to pass in the name of the label, the length of the word read, and an example of the label: A; label [1]; bbb [10,10,10]
    
    参数:
    
    tag - 标签名
    
    length - 读取长度
    
    返回:
    
    是否成功
  - ReadTags
```
public OperateResultExOne<byte[]> ReadTags(String[] tags,
                                           short[] length)
```
    读取PLC的标签信息，需要传入标签的名称，读取的字长度，标签举例：A; label[1]; bbb[10,10,10]
    To read the label information of the PLC, you need to pass in the name of the label, the length of the word read, and an example of the label: A; label [1]; bbb [10,10,10]
    
    参数:
    
    tags - 标签名
    
    length - 读取长度
    
    返回:
    
    是否成功
  - ReadExtend
```
public OperateResultExOne<byte[]> ReadExtend(short extend,
                                             String address,
                                             short length)
```
    读取扩展的数据信息，需要在原有的地址，长度信息之外，输入扩展值信息
    To read the extended data information, you need to enter the extended value information in addition to the original address and length information
    
    参数:
    
    extend - 扩展信息
    
    address - 地址
    
    length - 数据长度
    
    返回:
    
    返回结果
  - ReadMemory
```
public OperateResultExOne<byte[]> ReadMemory(String address,
                                             short length)
```
    读取缓冲寄存器的数据信息，地址直接为偏移地址
    Read the data information of the buffer register, the address is directly the offset address
    
    参数:
    
    address - 偏移地址
    
    length - 读取长度
    
    返回:
    
    读取的内容
  - RemoteRun
```
public OperateResult RemoteRun()
```
    远程Run操作
    Remote Run Operation
    
    返回:
    
    是否成功
  - RemoteStop
```
public OperateResult RemoteStop()
```
    远程Stop操作
    Remote Stop operation
    
    返回:
    
    是否成功
  - RemoteReset
```
public OperateResult RemoteReset()
```
    远程Reset操作
    Remote Reset Operation
    
    返回:
    
    是否成功
  - ReadPlcType
```
public OperateResultExOne<String> ReadPlcType()
```
    读取PLC的型号信息，例如 Q02HCPU
    Read PLC model information, such as Q02HCPU
    
    返回:
    
    返回型号的结果对象
  - ErrorStateReset
```
public OperateResult ErrorStateReset()
```
    LED 熄灭出错代码初始化
    LED off Error code initialization
    
    返回:
    
    是否成功
  - toString
```
public String toString()
```
    从类复制的说明: NetworkBase
    
    返回当前对象表示的字符串
    Returns the string represented by the current object
    
    覆盖:
    
    toString 在类中 NetworkUdpDeviceBase
    
    返回:
    
    字符串信息

类 MelsecMcUdp

字段概要

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

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

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

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

构造器概要

方法概要

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

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

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

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

从接口继承的方法 HslCommunication.Profinet.Melsec.Helper.IReadWriteMc

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

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

构造器详细资料

MelsecMcUdp

MelsecMcUdp

方法详细资料

getNetworkNumber

setNetworkNumber

getNetworkStationNumber

setNetworkStationNumber

getMcType

McAnalysisAddress

PackCommandWithHeader

UnpackResponseContent

ExtractActualData

Read

ReadBool

Write

Write

ReadRandom

ReadRandom

ReadRandomInt16

ReadTags

ReadTags

ReadExtend

ReadMemory

RemoteRun

RemoteStop

RemoteReset

ReadPlcType

ErrorStateReset

toString