S7RClientSSj

This is the Java class that allows the program to implement the Substation ES TCP protocol at the application level.

Purpose

It returns an object that you can use to implement Substation ES TCP protocol and data manipulation. The number of connections that an S7RClientSSj can create is dependent on the Substation ES TCP interfaces it connects to. Each connection has its own URL , so one S7RClientSSj object can connect to different Substation ES TCP interfaces in the same or different address spaces. There are no parameters so the code can be used with BusinessWorks global instance. The method sets up the S7RClientSSj environment example.

Declaration

S7RClientSSj conn = new S7RClientSSj();

Variables

  1. S7RClientSSjToken: This is an instance token which is obtained at time of connection. This object is used in all subsequent methods indicating the connection being used.
Method Description
Environment Life Cycle and Properties
Connect Attempts to create a connection to Substation ES.
disConnect Terminates a connection to Substation ES.
Dump Prints information about the TCP input data in a Hex Dump format.
isConnected Tests whether the connection is valid.
receiveWait Waits until data is present or connection is terminated.
Fields
getCallType Gets CallType value in current buffer.
getCorrelationId Gets CorrelationId value in current buffer.
getDataContent Gets data in byteArray format.
getDataContentLength Gets data length of the byte data value in current buffer.
getDataContentToString Gets data in string format.
getHostId Gets HostId value in current buffer.
getId Gets Substation ES error message Ids.
getReasonCode Gets ReasonCode value in current buffer.
getReturnCode Gets ReturnCode value in current buffer.
getToken Gets the corresponding S7RClientSSjToken using an index number as the key.
Configuration
setAutoAck Set autoAck feature to true (on) or false (off)
setTimeout Set timeout value for all get methods.
Events
sendACK Sends an "ack" event back to Substation ES.
sendData Sends Recipe data to the Substation ES and then receives the response.
sendNACK Sends a "nack" event back to Substation ES.
sendRegistration Sends registration data to the Substation ES to indicate what service the client will support as a Recipe or Trigger.
sendUnRegistration Sends Substation ES a request to stop transmitting Trigger data to this client.