SiemensS7Net (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.Siemens.SiemensS7Net

所有已实现的接口:

IReadWriteDevice, IReadWriteNet
```
public class SiemensS7Net
extends NetworkDeviceBase
```
西门子的数据交互类，采用s7协议实现，地址支持I,Q,M,DB，AI,AQ，举例：I100,Q0,M100,DB1.0,AI0,AQ16，支持单个位的读写，暂时不支持批量位写入操作

字段概要
- 从类继承的字段 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

构造器概要

构造器
构造器和说明
`SiemensS7Net(SiemensPLCS siemens)` 实例化一个西门子的S7协议的通讯对象
`SiemensS7Net(SiemensPLCS siemens, String ipAddress)` 实例化一个西门子的S7协议的通讯对象并指定Ip地址

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static OperateResultExOne<byte[]>`	`BuildBitReadCommand(String address)` 生成一个位读取数据指令头的通用方法
`static OperateResultExOne<byte[]>`	`BuildReadCommand(S7AddressData[] s7Addresses)` 生成一个读取字数据指令头的通用方法
`static OperateResultExOne<byte[]>`	`BuildWriteBitCommand(String address, boolean data)` 生成一个写入位数据的指令
`static OperateResultExOne<byte[]>`	`BuildWriteByteCommand(S7AddressData s7Address, byte[] data)` 生成一个写入字节数据的指令
`static OperateResultExOne<byte[]>`	`BuildWriteByteCommand(String address, byte[] data)` 生成一个写入字节数据的指令 -> Generate an instruction to write byte data
`static int`	`CalculateAddressStarted(String address)` 计算特殊的地址信息
`byte`	`getConnectionType()` 获取当前PLC的连接方式，PG: 0x01，OP: 0x02，S7Basic: 0x03...0x10 Get the current PLC connection mode, PG: 0x01, OP: 0x02, S7Basic: 0x03...0x10
`int`	`getDestTSAP()` 获取西门子的远程TSAP参数信息
`int`	`getLocalTSAP()` 获取西门子相关的一个参数信息
`protected INetMessage`	`GetNewNetMessage()` 获取一个新的消息对象的方法，需要在继承类里面进行重写 The method to get a new message object needs to be overridden in the inheritance class
`byte`	`getRack()` 获取PLC的机架号，针对S7-400的PLC设置的
`byte`	`getSlot()` 获取 PLC的槽号，针对S7-400的PLC设置的
`protected OperateResult`	`InitializationOnConnect(Socket socket)` 在客户端连接上服务器后，所做的一些初始化操作 -> Two handshake actions required after connecting to the server
`OperateResultExOne<byte[]>`	`Read(S7AddressData[] s7Addresses)` 读取西门子的地址数据信息，支持任意个数的数据读取 Read Siemens address data information, support any number of data reading
`OperateResultExOne<byte[]>`	`Read(String[] address, short[] length)` 一次性从PLC获取所有的数据，按照先后顺序返回一个统一的Buffer，需要按照顺序处理，两个数组长度必须一致
`OperateResultExOne<byte[]>`	`Read(String address, short length)` 从PLC读取数据，地址格式为I100，Q100，DB20.100，M100，T100，C100以字节为单位 Read the original byte data from the PLC, the address format is I100, Q100, DB20.100, M100, length parameters in bytes
`OperateResultExOne<Boolean>`	`ReadBool(String address)` 读取指定地址的bool数据
`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>`	`ReadByte(String address)` 读取指定地址的byte数据
`OperateResultExOne<Date>`	`ReadDate(String address)` 从PLC中读取日期格式的数据 Read data in date format from PLC
`OperateResultExOne<Date>`	`ReadDateTime(String address)` 从PLC中读取时间格式的数据 Read time format data from PLC
`OperateResultExOne<String>`	`ReadOrderNumber()` 从PLC读取订货号信息
`OperateResultExOne<String>`	`ReadString(String address)` 读取西门子的地址的字符串信息，这个信息是和西门子绑定在一起，长度随西门子的信息动态变化的
`OperateResultExOne<String>`	`ReadString(String address, Charset encoding)` 读取西门子的地址的字符串信息，这个信息是和西门子绑定在一起，长度随西门子的信息动态变化的
`OperateResultExOne<String>`	`ReadString(String address, short length, Charset encoding)` 使用指定的编码，读取字符串数据 Reads string data using the specified encoding
`OperateResultExOne<String>`	`ReadWString(String address)` 读取西门子的地址的字符串信息，这个信息是和西门子绑定在一起，长度随西门子的信息动态变化的 Read the Siemens address string information.
`void`	`setConnectionType(byte value)` 设置当前PLC的连接方式，PG: 0x01，OP: 0x02，S7Basic: 0x03...0x10 Set the current PLC connection mode, PG: 0x01, OP: 0x02, S7Basic: 0x03...0x10
`void`	`setDestTSAP(int value)` 设置西门子的远程TASP的参数信息
`void`	`setLocalTSAP(int value)` 设置西门子相关的一个参数信息
`void`	`setRack(byte value)` 设置PLC的机架号，针对S7-400的PLC设置的
`void`	`setSlot(byte value)` 设置PLC的槽号信息，针对S7-400的PLC设置的
`String`	`toString()` 返回表示当前对象的字符串
`OperateResult`	`Write(String address, boolean value)` 写入PLC的一个位，例如"M100.6"，"I100.7"，"Q100.0"，"DB20.100.0"，如果只写了"M100"默认为"M100.0
`OperateResult`	`Write(String address, boolean[] values)` 向PLC中写入bool数组，返回值说明，比如你写入M100,那么data[0]对应M100.0
`OperateResult`	`Write(String address, byte value)` 向PLC中写入byte数据，返回值说明
`OperateResult`	`Write(String address, byte[] value)` 将数据写入到PLC数据，地址格式为I100，Q100，DB20.100，M100，以字节为单位
`OperateResult`	`Write(String address, Date dateTime)` 向PLC中写入时间格式的数据 Writes data in time format to the PLC
`OperateResult`	`Write(String address, String value, Charset encoding)` 写入字符串信息，需要指定的编码信息 Write string information, need to specify the encoding information
`OperateResult`	`WriteDate(String address, Date dateTime)` 向PLC中写入日期格式的数据，日期格式里只有年，月，日 Write data in date format to PLC, only year, month, day in date format
`OperateResult`	`WriteWString(String address, String value)` 使用双字节编码的方式，将字符串以 Unicode 编码写入到PLC的地址里，可以使用中文。

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

从类继承的方法 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.Core.Net.IReadWriteDevice
ReadFromCoreServer

从接口继承的方法 HslCommunication.Core.Net.IReadWriteNet
ConnectClose, getConnectionId, setConnectionId

- 构造器详细资料
  - SiemensS7Net
```
public SiemensS7Net(SiemensPLCS siemens)
```
    实例化一个西门子的S7协议的通讯对象
    
    参数:
    
    siemens - 指定西门子的型号
  - SiemensS7Net
```
public SiemensS7Net(SiemensPLCS siemens,
                    String ipAddress)
```
    实例化一个西门子的S7协议的通讯对象并指定Ip地址
    
    参数:
    
    siemens - 指定西门子的型号
    
    ipAddress - Ip地址
- 方法详细资料
  - GetNewNetMessage
```
protected INetMessage GetNewNetMessage()
```
    从类复制的说明: NetworkDoubleBase
    
    获取一个新的消息对象的方法，需要在继承类里面进行重写
    The method to get a new message object needs to be overridden in the inheritance class
    
    覆盖:
    
    GetNewNetMessage 在类中 NetworkDoubleBase
    
    返回:
    
    消息类对象
  - getSlot
```
public byte getSlot()
```
    获取 PLC的槽号，针对S7-400的PLC设置的
    
    返回:
    
    槽号
  - setSlot
```
public void setSlot(byte value)
```
    设置PLC的槽号信息，针对S7-400的PLC设置的
    
    参数:
    
    value - 槽号信息
  - getRack
```
public byte getRack()
```
    获取PLC的机架号，针对S7-400的PLC设置的
    
    返回:
    
    Plc的机架号
  - setRack
```
public void setRack(byte value)
```
    设置PLC的机架号，针对S7-400的PLC设置的
    
    参数:
    
    value - 机架号
  - getConnectionType
```
public byte getConnectionType()
```
    获取当前PLC的连接方式，PG: 0x01，OP: 0x02，S7Basic: 0x03...0x10
    Get the current PLC connection mode, PG: 0x01, OP: 0x02, S7Basic: 0x03...0x10
    
    返回:
    
    连接方式
  - setConnectionType
```
public void setConnectionType(byte value)
```
    设置当前PLC的连接方式，PG: 0x01，OP: 0x02，S7Basic: 0x03...0x10
    Set the current PLC connection mode, PG: 0x01, OP: 0x02, S7Basic: 0x03...0x10
    
    参数:
    
    value - 连接方式
  - getLocalTSAP
```
public int getLocalTSAP()
```
    获取西门子相关的一个参数信息
    
    返回:
    
    本地的一个参数
  - setLocalTSAP
```
public void setLocalTSAP(int value)
```
    设置西门子相关的一个参数信息
    
    参数:
    
    value - 本地的一个参数
  - getDestTSAP
```
public int getDestTSAP()
```
    获取西门子的远程TSAP参数信息
    
    返回:
    
    参数信息
  - setDestTSAP
```
public void setDestTSAP(int value)
```
    设置西门子的远程TASP的参数信息
    
    参数:
    
    value - 参数信息
  - InitializationOnConnect
```
protected OperateResult InitializationOnConnect(Socket socket)
```
    在客户端连接上服务器后，所做的一些初始化操作 -> Two handshake actions required after connecting to the server
    
    覆盖:
    
    InitializationOnConnect 在类中 NetworkDoubleBase
    
    参数:
    
    socket - 网络套接字
    
    返回:
    
    返回连接结果
  - ReadOrderNumber
```
public OperateResultExOne<String> ReadOrderNumber()
```
    从PLC读取订货号信息
    
    返回:
    
    订货号信息
  - Read
```
public OperateResultExOne<byte[]> Read(String address,
                                       short length)
```
    从PLC读取数据，地址格式为I100，Q100，DB20.100，M100，T100，C100以字节为单位
    Read the original byte data from the PLC, the address format is I100, Q100, DB20.100, M100, length parameters in bytes
    
    指定者:
    
    Read 在接口中 IReadWriteNet
    
    覆盖:
    
    Read 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，格式为I100，M100，Q100，DB20.100
    
    length - 读取的数量，以字节为单位
    
    返回:
    
    结果对象
  - Read
```
public OperateResultExOne<byte[]> Read(String[] address,
                                       short[] length)
```
    一次性从PLC获取所有的数据，按照先后顺序返回一个统一的Buffer，需要按照顺序处理，两个数组长度必须一致
    
    参数:
    
    address - 起始地址数组
    
    length - 数据长度数组
    
    返回:
    
    结果数据对象
  - Read
```
public OperateResultExOne<byte[]> Read(S7AddressData[] s7Addresses)
```
    读取西门子的地址数据信息，支持任意个数的数据读取
    Read Siemens address data information, support any number of data reading
    
    参数:
    
    s7Addresses - 西门子的数据地址
    Siemens data address
    
    返回:
    
    返回的结果对象信息 -> Whether to read the successful result object
  - ReadBool
```
public OperateResultExOne<Boolean> ReadBool(String address)
```
    读取指定地址的bool数据
    
    指定者:
    
    ReadBool 在接口中 IReadWriteNet
    
    覆盖:
    
    ReadBool 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，格式为I100，M100，Q100，DB20.100
    
    返回:
    
    结果类对象
  - 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[]数组
  - ReadByte
```
public OperateResultExOne<Byte> ReadByte(String address)
```
    读取指定地址的byte数据
    
    参数:
    
    address - 起始地址，格式为I100，M100，Q100，DB20.100
    
    返回:
    
    结果类对象
  - Write
```
public OperateResult Write(String address,
                           byte[] value)
```
    将数据写入到PLC数据，地址格式为I100，Q100，DB20.100，M100，以字节为单位
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，格式为I100，M100，Q100，DB20.100
    
    value - 写入的数据，长度根据data的长度来指示
    
    返回:
    
    写入结果
  - Write
```
public OperateResult Write(String address,
                           boolean value)
```
    写入PLC的一个位，例如"M100.6"，"I100.7"，"Q100.0"，"DB20.100.0"，如果只写了"M100"默认为"M100.0
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址，格式为I100，M100，Q100，DB20.100
    
    value - 写入的数据，True或是False
    
    返回:
    
    写入结果
  - Write
```
public OperateResult Write(String address,
                           boolean[] values)
```
    向PLC中写入bool数组，返回值说明，比如你写入M100,那么data[0]对应M100.0
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 要写入的数据地址
    
    values - 要写入的实际数据，长度为8的倍数
    
    返回:
    
    写入结果
  - Write
```
public OperateResult Write(String address,
                           byte value)
```
    向PLC中写入byte数据，返回值说明
    
    参数:
    
    address - 要写入的数据地址
    
    value - 要写入的实际数据
    
    返回:
    
    写入结果
  - ReadString
```
public OperateResultExOne<String> ReadString(String address,
                                             short length,
                                             Charset encoding)
```
    从接口复制的说明: IReadWriteNet
    
    使用指定的编码，读取字符串数据
    Reads string data using the specified encoding
    
    指定者:
    
    ReadString 在接口中 IReadWriteNet
    
    覆盖:
    
    ReadString 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址
    
    length - 数据长度
    
    encoding - 指定的自定义的编码
    
    返回:
    
    带有成功标识的string数据
  - ReadString
```
public OperateResultExOne<String> ReadString(String address)
```
    读取西门子的地址的字符串信息，这个信息是和西门子绑定在一起，长度随西门子的信息动态变化的
    
    参数:
    
    address - 数据地址，具体的格式需要参照类的说明文档
    
    返回:
    
    带有是否成功的字符串结果类对象
  - ReadString
```
public OperateResultExOne<String> ReadString(String address,
                                             Charset encoding)
```
    读取西门子的地址的字符串信息，这个信息是和西门子绑定在一起，长度随西门子的信息动态变化的
    
    参数:
    
    address - 数据地址，具体的格式需要参照类的说明文档
    
    encoding - 数据编码信息
    
    返回:
    
    带有是否成功的字符串结果类对象
  - ReadWString
```
public OperateResultExOne<String> ReadWString(String address)
```
    读取西门子的地址的字符串信息，这个信息是和西门子绑定在一起，长度随西门子的信息动态变化的
    Read the Siemens address string information. This information is bound to Siemens and its length changes dynamically with the Siemens information
    
    参数:
    
    address - 数据地址，具体的格式需要参照类的说明文档
    
    返回:
    
    带有是否成功的字符串结果类对象
  - Write
```
public OperateResult Write(String address,
                           String value,
                           Charset encoding)
```
    从接口复制的说明: IReadWriteNet
    
    写入字符串信息，需要指定的编码信息
    Write string information, need to specify the encoding information
    
    指定者:
    
    Write 在接口中 IReadWriteNet
    
    覆盖:
    
    Write 在类中 NetworkDeviceBase
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    encoding - 指定的编码信息
    
    返回:
    
    带有成功标识的结果类对象
  - WriteWString
```
public OperateResult WriteWString(String address,
                                  String value)
```
    使用双字节编码的方式，将字符串以 Unicode 编码写入到PLC的地址里，可以使用中文。
    Use the double-byte encoding method to write the character string to the address of the PLC in Unicode encoding. Chinese can be used.
    
    参数:
    
    address - 起始地址，格式为I100，M100，Q100，DB20.100 -> Starting address, formatted as I100,mM100,Q100,DB20.100
    
    value - 字符串的值
    
    返回:
    
    是否写入成功的结果对象
  - ReadDateTime
```
public OperateResultExOne<Date> ReadDateTime(String address)
```
    从PLC中读取时间格式的数据
    Read time format data from PLC
    
    参数:
    
    address - 地址
    
    返回:
    
    时间对象
  - Write
```
public OperateResult Write(String address,
                           Date dateTime)
```
    向PLC中写入时间格式的数据
    Writes data in time format to the PLC
    
    参数:
    
    address - 地址
    
    dateTime - 时间
    
    返回:
    
    是否写入成功
  - ReadDate
```
public OperateResultExOne<Date> ReadDate(String address)
```
    从PLC中读取日期格式的数据
    Read data in date format from PLC
    
    参数:
    
    address - PLC的地址
    
    返回:
    
    日期对象
  - WriteDate
```
public OperateResult WriteDate(String address,
                               Date dateTime)
```
    向PLC中写入日期格式的数据，日期格式里只有年，月，日
    Write data in date format to PLC, only year, month, day in date format
    
    参数:
    
    address - 等待写入的PLC地址
    
    dateTime - 等待写入的日期
    
    返回:
    
    是否写入成功
  - toString
```
public String toString()
```
    返回表示当前对象的字符串
    
    覆盖:
    
    toString 在类中 NetworkDeviceBase
    
    返回:
    
    字符串信息
  - CalculateAddressStarted
```
public static int CalculateAddressStarted(String address)
```
    计算特殊的地址信息
    
    参数:
    
    address - 字符串信息
    
    返回:
    
    实际值
  - BuildReadCommand
```
public static OperateResultExOne<byte[]> BuildReadCommand(S7AddressData[] s7Addresses)
```
    生成一个读取字数据指令头的通用方法
    
    参数:
    
    s7Addresses - siemens address
    
    返回:
    
    Message containing the result object
  - BuildBitReadCommand
```
public static OperateResultExOne<byte[]> BuildBitReadCommand(String address)
```
    生成一个位读取数据指令头的通用方法
    
    参数:
    
    address - 起始地址
    
    返回:
    
    指令
  - BuildWriteByteCommand
```
public static OperateResultExOne<byte[]> BuildWriteByteCommand(String address,
                                                               byte[] data)
```
    生成一个写入字节数据的指令 -> Generate an instruction to write byte data
    
    参数:
    
    address - 起始地址，示例M100,I100,Q100,DB1.100 -> Start Address, example M100,I100,Q100,DB1.100
    
    data - 原始的字节数据 -> Raw byte data
    
    返回:
    
    包含结果对象的报文 -> Message containing the result object
  - BuildWriteByteCommand
```
public static OperateResultExOne<byte[]> BuildWriteByteCommand(S7AddressData s7Address,
                                                               byte[] data)
```
    生成一个写入字节数据的指令
    
    参数:
    
    s7Address - 西门子的地址
    
    data - 数据
    
    返回:
    
    指令
  - BuildWriteBitCommand
```
public static OperateResultExOne<byte[]> BuildWriteBitCommand(String address,
                                                              boolean data)
```
    生成一个写入位数据的指令
    
    参数:
    
    address - 起始地址
    
    data - 数据
    
    返回:
    
    指令

类 SiemensS7Net

字段概要

从类继承的字段 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.Core.Net.IReadWriteDevice

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

构造器详细资料

SiemensS7Net

SiemensS7Net

方法详细资料

GetNewNetMessage

getSlot

setSlot

getRack

setRack

getConnectionType

setConnectionType

getLocalTSAP

setLocalTSAP

getDestTSAP

setDestTSAP

InitializationOnConnect

ReadOrderNumber

Read

Read

Read

ReadBool

ReadBool

ReadByte

Write

Write

Write

Write

ReadString

ReadString

ReadString

ReadWString

Write

WriteWString

ReadDateTime

Write

ReadDate

WriteDate

toString

CalculateAddressStarted

BuildReadCommand

BuildBitReadCommand

BuildWriteByteCommand

BuildWriteByteCommand

BuildWriteBitCommand