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

java.lang.Object
- HslCommunication.Core.Net.NetworkBase.NetworkBase
- - HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
  - - HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase
    - - HslCommunication.Profinet.Melsec.MelsecMcRNet

所有已实现的接口:

IReadWriteDevice, IReadWriteNet, IReadWriteMc
```
public class MelsecMcRNet
extends NetworkDeviceBase
implements IReadWriteMc
```
三菱的R系列的MC协议，支持的地址类型和 MelsecMcNet 有区别，详细请查看对应的API文档说明

字段概要
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDeviceBase
  WordLength
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
  AlienSession, isPersistentConn, IsSocketError, isUseAccountCertificate, LogMsgFormatBinary, simpleHybirdLock
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase
  CoreSocket, fileCacheSize, LogNet, Token
- 从接口继承的字段 HslCommunication.Core.Net.IReadWriteNet
  LogNet

构造器概要

构造器
构造器和说明
`MelsecMcRNet()` 实例化三菱R系列的Qna兼容3E帧协议的通讯对象 Instantiate the communication object of Mitsubishi's Qna compatible 3E frame protocol
`MelsecMcRNet(String ipAddress, int port)` 指定ip地址和端口号来实例化一个默认的对象 Specify the IP address and port number to instantiate a default object

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static OperateResultExTwo<MelsecMcDataType,Integer>`	`AnalysisAddress(String address)` 分析三菱R系列的地址，并返回解析后的数据对象
`static byte[]`	`BuildReadMcCoreCommand(McAddressData address, boolean isBit)` 从三菱地址，是否位读取进行创建读取的MC的核心报文
`static byte[]`	`BuildWriteBitCoreCommand(McAddressData address, boolean[] value)` 以位为单位，创建数据写入的核心报文
`static byte[]`	`BuildWriteWordCoreCommand(McAddressData address, byte[] value)` 以字为单位，创建数据写入的核心报文
`byte[]`	`ExtractActualData(byte[] response, boolean isBit)` 从PLC反馈的数据中提取出实际的数据内容，需要传入反馈数据，是否位读取
`McType`	`getMcType()` 当前的MC协议的格式类型 The format type of the current MC protocol
`byte`	`getNetworkNumber()` 获取网络号
`byte`	`getNetworkStationNumber()` 获取网络站号
`protected INetMessage`	`GetNewNetMessage()` 获取一个新的消息对象的方法，需要在继承类里面进行重写 The method to get a new message object needs to be overridden in the inheritance class
`OperateResultExOne<McAddressData>`	`McAnalysisAddress(String address, short length)` 当前MC协议的分析地址的方法，对传入的字符串格式的地址进行数据解析。
`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[]>`	`ReadRandom(String[] address)` 参考`McHelper.ReadRandom(IReadWriteMc, String[])`注释
`OperateResultExOne<byte[]>`	`ReadRandom(String[] address, short[] length)` 参考`McHelper.ReadRandom(IReadWriteMc, String[], short[])`注释
`OperateResultExOne<short[]>`	`ReadRandomInt16(String[] address)` 参考`McHelper.ReadRandomInt16(IReadWriteMc, String[])`注释
`OperateResultExOne<int[]>`	`ReadRandomUInt16(String[] address)` 参考`McHelper.ReadRandomUInt16(IReadWriteMc, String[])`注释
`void`	`setNetworkNumber(byte networkNumber)` 设置网络号
`void`	`setNetworkStationNumber(byte networkStationNumber)` 设置网络站号
`String`	`toString()` 返回当前对象表示的字符串 Returns the string represented by the current object
`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.NetworkDeviceBase
ReadBool, ReadCustomer, ReadDouble, ReadDouble, ReadFloat, ReadFloat, ReadInt16, ReadInt16, ReadInt32, ReadInt32, ReadInt64, ReadInt64, ReadString, ReadString, ReadUInt16, ReadUInt16, ReadUInt32, ReadUInt32, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, Write, WriteCustomer, WriteUnicodeString, WriteUnicodeString

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
AccountCertificate, ConnectClose, ConnectServer, ConnectServer, ExtraAfterReadFromCoreServer, ExtraOnDisconnect, GetAvailableSocket, getByteTransform, getConnectionId, getConnectTimeOut, getIpAddress, getPort, getReceiveTimeOut, getSleepTime, InitializationOnConnect, IpAddressPing, ReadFromCoreServer, ReadFromCoreServer, ReadFromCoreServer, setByteTransform, setConnectionId, setConnectTimeOut, setIpAddress, SetLoginAccount, SetPersistentConnection, setPort, setReceiveTimeOut, setSleepTime

从类继承的方法 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

- 构造器详细资料
  - MelsecMcRNet
```
public MelsecMcRNet()
```
    实例化三菱R系列的Qna兼容3E帧协议的通讯对象
    Instantiate the communication object of Mitsubishi's Qna compatible 3E frame protocol
  - MelsecMcRNet
```
public MelsecMcRNet(String ipAddress,
                    int port)
```
    指定ip地址和端口号来实例化一个默认的对象
    Specify the IP address and port number to instantiate a default object
    
    参数:
    
    ipAddress - PLC的Ip地址
    
    port - PLC的端口
- 方法详细资料
  - GetNewNetMessage
```
protected INetMessage GetNewNetMessage()
```
    从类复制的说明: NetworkDoubleBase
    
    获取一个新的消息对象的方法，需要在继承类里面进行重写
    The method to get a new message object needs to be overridden in the inheritance class
    
    覆盖:
    
    GetNewNetMessage 在类中 NetworkDoubleBase
    
    返回:
    
    消息类对象
  - getMcType
```
public McType getMcType()
```
    从接口复制的说明: IReadWriteMc
    
    当前的MC协议的格式类型
    The format type of the current MC protocol
    
    指定者:
    
    getMcType 在接口中 IReadWriteMc
    
    返回:
    
    PLC的协议类型
  - 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 - 网络站号
  - 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
```
public byte[] PackCommandWithHeader(byte[] command)
```
    从类复制的说明: NetworkDoubleBase
    
    对当前的命令进行打包处理，通常是携带命令头内容，标记当前的命令的长度信息，需要进行重写，否则默认不打包
    
    覆盖:
    
    PackCommandWithHeader 在类中 NetworkDoubleBase
    
    参数:
    
    command - 发送的数据命令内容
    
    返回:
    
    打包之后的数据结果信息
  - UnpackResponseContent
```
public OperateResultExOne<byte[]> UnpackResponseContent(byte[] send,
                                                        byte[] response)
```
    从类复制的说明: NetworkDoubleBase
    
    根据对方返回的报文命令，对命令进行基本的拆包，例如各种Modbus协议拆包为统一的核心报文，还支持对报文的验证
    
    覆盖:
    
    UnpackResponseContent 在类中 NetworkDoubleBase
    
    参数:
    
    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 在类中 NetworkDeviceBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的byte[]数组
  - 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 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - ReadRandom
```
public OperateResultExOne<byte[]> ReadRandom(String[] address)
```
    参考McHelper.ReadRandom(IReadWriteMc, String[])注释
    
    参数:
    
    address - PLC的地址数组
    
    返回:
    
    原始字节数组
  - ReadRandom
```
public OperateResultExOne<byte[]> ReadRandom(String[] address,
                                             short[] length)
```
    参考McHelper.ReadRandom(IReadWriteMc, String[], short[])注释
    
    参数:
    
    address - PLC的地址数组
    
    length - 长度数组
    
    返回:
    
    原始字节数组
  - ReadRandomInt16
```
public OperateResultExOne<short[]> ReadRandomInt16(String[] address)
```
    参考McHelper.ReadRandomInt16(IReadWriteMc, String[])注释
    
    参数:
    
    address - PLC的地址数组
    
    返回:
    
    原始字节数组
  - ReadRandomUInt16
```
public OperateResultExOne<int[]> ReadRandomUInt16(String[] address)
```
    参考McHelper.ReadRandomUInt16(IReadWriteMc, String[])注释
    
    参数:
    
    address - PLC的地址数组
    
    返回:
    
    原始字节数组
  - 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 在类中 NetworkDeviceBase
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的boolean[]数组
  - Write
```
public OperateResult Write(String address,
                           boolean[] values)
```
    从接口复制的说明: IReadWriteNet
    
    批量写入 Boolean 数组数据，返回是否成功
    Batch write Boolean array data, return whether the write was successful
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    是否写入成功
  - toString
```
public String toString()
```
    从类复制的说明: NetworkBase
    
    返回当前对象表示的字符串
    Returns the string represented by the current object
    
    覆盖:
    
    toString 在类中 NetworkDeviceBase
    
    返回:
    
    字符串信息
  - AnalysisAddress
```
public static OperateResultExTwo<MelsecMcDataType,Integer> AnalysisAddress(String address)
```
    分析三菱R系列的地址，并返回解析后的数据对象
    
    参数:
    
    address - 字符串地址
    
    返回:
    
    是否解析成功
  - BuildReadMcCoreCommand
```
public static byte[] BuildReadMcCoreCommand(McAddressData address,
                                            boolean isBit)
```
    从三菱地址，是否位读取进行创建读取的MC的核心报文
    
    参数:
    
    address - 地址数据
    
    isBit - 是否进行了位读取操作
    
    返回:
    
    带有成功标识的报文对象
  - BuildWriteWordCoreCommand
```
public static byte[] BuildWriteWordCoreCommand(McAddressData address,
                                               byte[] value)
```
    以字为单位，创建数据写入的核心报文
    
    参数:
    
    address - 三菱的数据地址
    
    value - 实际的原始数据信息
    
    返回:
    
    带有成功标识的报文对象
  - BuildWriteBitCoreCommand
```
public static byte[] BuildWriteBitCoreCommand(McAddressData address,
                                              boolean[] value)
```
    以位为单位，创建数据写入的核心报文
    
    参数:
    
    address - 三菱的地址信息
    
    value - 原始的bool数组数据
    
    返回:
    
    带有成功标识的报文对象

类 MelsecMcRNet

字段概要

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

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

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

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

构造器概要

方法概要

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

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

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

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

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

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

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

构造器详细资料

MelsecMcRNet

MelsecMcRNet

方法详细资料

GetNewNetMessage

getMcType

getNetworkNumber

setNetworkNumber

getNetworkStationNumber

setNetworkStationNumber

McAnalysisAddress

PackCommandWithHeader

UnpackResponseContent

ExtractActualData

Read

Write

ReadRandom

ReadRandom

ReadRandomInt16

ReadRandomUInt16

ReadBool

Write

toString

AnalysisAddress

BuildReadMcCoreCommand

BuildWriteWordCoreCommand

BuildWriteBitCoreCommand