Ethernet_IP Object

Operator Menu Location: Generic Hardware Operators -> Networking -> Ethernet/IP

Operator Bitmap:

Functional Description:

The Ethernet/IP Object allows for connecting to an instance of a class. A class contains attributes which are accessed through the data pins on the Ethernet/IP object operator. An object operator can be connected to connected to the local modules classes (server mode) or a remote class (client mode).

When the operator hardware link infers Client functionality there are two additional Boolean pins displayed. One of these initiates the explicit get/set requests from/to the remote server object. This pin is configurable as to how it causes the specified service request to be sent to the server – active high (with rate), active low (with rate), rising edge, falling edge. The other pin indicates whether the connection to the remote object is valid.

Right click on the operator and choose 'Input/Output Setup' (or similar) which when selected displays a window were you can pick and choose which members of the structure are Input and Output signals. In this window you should be able to select which of the structure members are inputs and which are outputs. Only signals that are selected as inputs will be able to be set by the input pin(s). Only the signals that are selected as outputs will be shown as output pins. Note that all output pins are updated each compute cycle. Only those selected input pins are updated each compute cycle. Under the covers this will dictate which attributes are sent with a set command and which are retrieved with the get command.

The operator has following properties that are always visible:
Name: Unique Name

Service Pin Enable On: Active High, Active Low, Rising Edge, Falling Edge.

Min Delay for Next Service Request: (time in milliseconds) – this is only used when active high/low Service Pin Enable on is selected.

The operator has the following properties which are only visible when a hardware link is made that infers Client functionality:
Get Enable On: Active High, Active Low, Rising Edge, Falling Edge.

Min Delay for Next Get Request: (time in milliseconds) – this is only used when Get Enable On is set to active high/low.

Set Enable On: Active High, Active Low, Rising Edge, Falling Edge.

Min Delay for Next Set Request: (time in milliseconds) – this is only used when Set Enable On is set to active high/low.

Comments: None.

See Also:

{-- text below is from email I sent to Stephen on 6/27, it needs editing.- }

Functional Description: The Ethernet/IP Object connects to a class object defined on the local server, or an object on a remote server. The local module must be in client server mode to allow connections to remote objects.

The objects are defined on the “Module Options” dialog under “Networking->Ethernet->ETHERNET IP->Objects”. Objects are defined in the xml structure library associated with the logical ETHERNET/IP network defined on the Network View tab.

Server Mode(local object)

An object operator connected to a local object allows the schema to read data written to the local object from a remote client and write data to remote clients. Non attribute pins are hidden, as the client controls explicit connect messages used to read/write the object data.

Client Mode(remote object)

An object operator connected to a remote object allows the schema to read and write data to and from remote server objects. The object attribute pins are created based on the permissions field of the object definition in the xml structure library. Each attribute will generate a Get_Attribute_Single - Service Code(0x0E) or a Set_Attribute_Single - Service Code(0x10) explicit message to read or write the data to or from the instance of the object on the remote server. The instance ID is defined on the module properties page of the remote server in Design Pad.

There are two additional Boolean pins in this mode which must be shown that initiate the explicit get/set requests from/to the server object. These pins will be configurable as to how they cause the specified service request to be sent to the server – active high (with rate), active low (with rate), rising edge, falling edge.

Class Attributes

Each defined attribute in the xml structure library class definition will provide a pin on the object operator and the RW attributes for the clients.

Unknown macro: { *There is no input output setup, the input/output settings are all done in the class definition in the xml* So all of the following italicized text should be removed * * _Right click on the operator and choose 'Input/Output Setup' (or similar) which when selected displays a window were you can pick and choose which members of the structure are Input and Output signals. In this window you should be able to select which of the structure members are inputs and which are outputs. Only signals that are selected as inputs will be able to be set by the input pin(s). Only the signals that are selected as outputs will be shown as output pins._\ This section is incorrect, the getting and setting of the object data is asynchronous from the compute loop, and the data is updated when available. _Note that all output pins are updated each compute cycle. Only those selected input pins are updated each compute cycle. Under the covers this will dictate which attributes are sent with a set command and which are retrieved with the get command._ }

The operator has following properties that are always visible: (these are not currently visible on server mode operators)
Name: Unique Name
Service Pin Enable On: Active High, Active Low, Rising Edge, Falling Edge.
Min Delay for Next Service Request: (time in milliseconds) – this is only used when active high/low Service Pin Enable on is selected.

The operator has the following properties which are only visible when a hardware link is made that infers Client functionality:
Get Enable On: Active High, Active Low, Rising Edge, Falling Edge.
Min Delay for Next Get Request: (time in milliseconds) – this is only used when Get Enable On is set to active high/low.
Set Enable On: Active High, Active Low, Rising Edge, Falling Edge.
Min Delay for Next Set Request: (time in milliseconds) – this is only used when Set Enable On is set to active high/low.

Comments: None.