EEIP Class Documentation – Java Methods

Methods

public List<de.re.eeip.encapsulation.datatypes.CipIdentityItem> ListIdentity()
List and identify potential targets. This command shall be sent as braodcast message using UDP.

public int RegisterSession(int address, int port) throws IOException
Sends a RegisterSession command to a target to initiate session
Returns the Session Handle
Input Parameters:
address: IP-Address of the target device
port: Port of the target device (default should be 0xAF12)

public int RegisterSession(String address, int port) throws IOException
Sends a RegisterSession command to a target to initiate session
Returns the Session Handle
Input Parameters:
address: IP-Address of the target device
port: Port of the target device (default should be 0xAF12)

public int RegisterSession(String address) throws IOException
a RegisterSession command to a target to initiate session using the predefines port (default 0xAF12)
Returns the Session Handle
Input Parameters:
address: IP-Address of the target device
public UInt32 RegisterSession()
Sends a RegisterSession command to a target to initiate session with the Standard or predefined Port and Predefined IPAddress (Standard-Port: 0xAF12)
Returns the Session Handle

public int RegisterSession() throws IOException
a RegisterSession command to a target to initiate session using the predefines port (default 0xAF12) and a specified IP-Address

public void UnRegisterSession() throws IOException
Sends a UnRegisterSession command to a target to terminate session

public void ForwardOpen()   throws CIPException, IOException
Initiates an Implicit Messaging

public void ForwardClose() throws CIPException, IOException
Teminates Implicit Messaging

public byte[] GetAttributeSingle(int classID, int instanceID, int attributeID) throws CIPException, IOException
Reads an attribute from the target device.
Returns the data of the attribute
Input Parameters:
classdID, instanceID and attributeID: Access Path of the attribute

public byte[] GetAttributeAll(int classID, int instanceID)  throws CIPException, IOException
Implementation of Common Service „Get_Attribute_All“ – Service Code: 0x01
Returns the data of the attribute
classID: Class id of requested Attributes
instanceID: Instance of Requested Attributes (0 for class Attributes)

public byte[] SetAttributeSingle(int classID, int instanceID, int attributeID, byte[] value) throws CIPException, IOException
Sets the value of an Attribute
returns the data of the attribute
classID: Class id of requested Attribute
instanceID: Instance of Requested Attribute
attributeID: Attribute to write

public byte[] GetAttributeAll(int classID) throws IOException, CIPException
Implementation of Common Service „Get_Attribute_All“ Reads the Class Attributes – Service Code: 0x01
Returns the data of the attribute
classID: Class id of requested Attributes