EIO0000001144 07/2011www.schneider-electric.comEIO

0000

0011

44.0

0

Generic EtherNet/IP Explicit Driver

07/2011

2 EIO0000001144 07/2011

Table of Contents

Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 1 Generic EtherNet/IP Explicit Driver. . . . . . . . . . . . . . . . 9System Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Supported Device Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Consecutive Equipment Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . 13I/O Manager Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Equipment Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Device Address Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 2 Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21EtherNet/IP Standard Class Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . 22EIO0000001144 07/2011 3

4 EIO0000001144 07/2011

Safety Information

Important Information

NOTICERead these instructions carefully, and look at the equipment to become familiar with the device before trying to install, operate, or maintain it. The following special messages may appear throughout this documentation or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure.EIO0000001144 07/2011 5

PLEASE NOTEElectrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this material.

A qualified person is one who has skills and knowledge related to the construction and operation of electrical equipment and its installation, and has received safety training to recognize and avoid the hazards involved.6 EIO0000001144 07/2011

About the Book

At a Glance

Document ScopeThis manual describes the device driver communication settings in the Vijeo Designer screen editing software. Vijeo Designer enables you to design Magelis target machines that communicate with PLCs, drives, field devices, and other equipment.

For more information about Vijeo Designer and Magelis target machines, please refer to Vijeo Designer user documentation.

Validity NoteThe data and illustrations found in this book are not binding. We reserve the right to modify our products in line with our policy of continuous product development. The information in this document is subject to change without notice and should not be construed as a commitment by Schneider Electric.

Documentation ConventionsTarget Machine: Human-Machine Interface (HMI) that runs user applications designed in Vijeo Designer screen editing software. A target machine is also known as a terminal.EIO0000001144 07/2011 7

Product Related Information

* For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the Application, Installation, and Maintenance of Solid State Control.

User CommentsWe welcome your comments about this document. You can reach us by e-mail at techcomm@schneider-electric.com.

WARNINGLOSS OF CONTROLz The designer of any control scheme must consider the potential failure modes

of control paths and, for certain critical control functions, provide a means to achieve a safe state during and after a path failure. Examples of critical control functions are emergency stop and overtravel stop.

z Separate or redundant control paths must be provided for critical control functions.

z System control paths may include communication links. Consideration must be given to the implications of unanticipated transmission delays or failures of the link.*

z Each implementation of a Magelis XBTGT, HMISTO, HMISTU, XBTGH, XBTGK, XBTGC, iPC, and XBTGTW must be individually and thoroughly tested for proper operation before being placed into service.

Failure to follow these instructions can result in death, serious injury, or equipment damage.8 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverEIO0000001144 07/2011EIO0000001144 07/2011 91Generic EtherNet/IP Explicit Driver

Subject of this ChapterThis chapter explains the Generic EtherNet/IP (Explicit) Driver.

What's in this Chapter?This chapter contains the following topics:

Topic Page

System Structure 10

Supported Device Addresses 11

Consecutive Equipment Addresses 13

I/O Manager Configuration 14

Equipment Configuration 15

Device Address Configuration 16

Generic EtherNet/IP Explicit DriverSystem Structure

OverviewThe following table describes the basic system setup for connecting the target machine to EtherNet/IP Explicit Messaging enabled remote equipment and PLCs.

Connection

Note:z Use a 100BASE-TX connection for iPC Series, XBTGTW Series, XBTGK

Series, XBTGT2000 Series or higher, XBTGH2000 Series, XBTGC2000 Series or higher, XBTGT1005 Series, HMISTO Series, and HMISTU Series target machines.

z Use a 10BASE-T connection for XBTGT1130 target machines.z Some equipment, such as Advantys STB, may have specific time-out

mechanisms. Ensure that the Vijeo Designer ScanRate setting is compatible with your equipment.10 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverSupported Device Addresses

Overview

The EtherNet/IP explicit messaging protocol uses object-oriented concepts to deliver information between the target machine and connected equipment.

The following EtherNet/IP terms are used by class instances to identify the information you want to work with: Class, Instance, and Attribute.

The following Vijeo Designer terms are used by class instances to identify information: Data Size, Access Mode, Bit Number, and String Prefix. For descriptions of each of these terms, see Device Address Configuration.

Mapping Classes to Vijeo Designer VariablesThe following shows how to map class instance attributes to Vijeo Designer variables.

*1 Vijeo Designer does not support unsigned 32-bit integers. Vijeo Designer variables will accurately display values up to 2147483647.

WARNINGUNINTENDED EQUIPMENT OPERATIONIncorrect values will result if conflicting writes to the same register are requested simultaneously by the target and PLC program.

Design your system to avoid conflicting write processes between the target machine and PLC program.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Data Type Description Data Type DetailsUSINT Unsigned short integer (8-bits) Integer Signed = Unsigned,

Data Length = Bit Field,Bit Offset = 0, Bit Width = 8

UINT Unsigned integer (16-bits) Integer Signed = Unsigned,Data Length = 16 bits

UDINT Unsigned double integer (32-bits) Integer Signed = 2's Complement*1,Data Length = 32 bits

STRING ASCII character string String NumOfBytes = string lengthWORD 16-bit integer Integer Signed = 2's Complement or MSB,

Data Length = 16 bits

STRUCT*2 Structure can include multiple data types

Class Vijeo-Designer

Depends on STRUCT data types*2EIO0000001144 07/2011 11

Generic EtherNet/IP Explicit Driver*2 STRUCT data type attributes can include multiple data types. As a result, there is no one way to map a STRUCT to Vijeo Designer variables.When using a STRUCT in Vijeo Designer, note that the driver supports a maximum structure size of 400 bytes.

Example Using the Identity ObjectThe following shows how you can map attributes in the Identity object to Vijeo Designer variables.

*1 Major Revision and Minor Revision, each requires a separate variable in this example.

*2 Vijeo Designer does not support unsigned 32-bit integers. Vijeo Designer variables will accurately display values up to 2147483647.

Attribute NameData Type Size

Access Rule Data Type Details

1 Vendor ID UINT 16 bits Get Integer Signed = Unsigned,Data Length = 16 bits

2 Device Type UINT 16 bits Get Integer Signed = Unsigned,Data Length = 16 bits

3 Product Code UINT 16 bits Get Integer Signed = Unsigned,Data Length = 16 bits

Revision 16 bits GetMajor Revision

8 bits Get Integer Signed = Unsigned,Data Length = Bit Field,

Bit Offset = 0, Bit Width = 8Minor Revision

8 bits Get Integer Signed = Unsigned,Data Length = Bit Field,

Bit Offset = 8, Bit Width = 85 Status WORD 16 bits Get Integer Signed = Unsigned,

Data Length = 16 bits6 Serial Number UDINT*1 32 bits Get Integer Signed = 2's Complement*1,

Data Length = 32 bitsProduct Name Get

Size 8 bits GetName [0-32] x 8 bits Get

Class

4 STRUCT: USINT USINT

STRUCT: USINT USINT

7

--

Num Of Bytes = 32,String Prefix = 1

String

Vijeo-Designer12 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverConsecutive Equipment Addresses

Overview The protocol reads a single attribute at a time, whether its an integer, word, string, or structure. There is no optimization available, so you cannot read multiple attributes in the same request.EIO0000001144 07/2011 13

Generic EtherNet/IP Explicit DriverI/O Manager Configuration

Overview

In the I/O Manager, add the driver and equipment as shown.

Screen example of I/O Manager Configuration

Note:z For information on how to display the [New Driver] dialog box, see the Vijeo

Designer Help.14 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverEquipment Configuration

Overview

Sets up details to identify the equipment you are connecting to on the network.

Screen example of Driver Configuration

Screen Description

WARNINGUNINTENDED EQUIPMENT OPERATIONRead and understand the instructions in this section to ensure data is properly transferred. If you do not follow these instructions, incorrect data could be written to the PLC and the target machine.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Note:z For information on how to display the [Driver Configuration] dialog box, see the

Vijeo Designer Help.

Area Description

IP Address Enter the IP address of the remote equipment.

Note:z Consult your network administrator when setting up the IP address.EIO0000001144 07/2011 15

Generic EtherNet/IP Explicit DriverDevice Address Configuration

Overview

Data in this protocol is defined by several numbers to describe the objects Class, Instance, Attribute, Data Size, and Access Mode. Use the device address configuration dialog box to identify the attribute of the class instance you want to associate with the Vijeo Designer variable. Make sure the data type of the variable is compatible with the class attributes data type.

See Supported Device Addresses.

Screen example of Device Address Configuration

WARNINGUNINTENDED EQUIPMENT OPERATIONRead and understand the instructions in this section to ensure data is properly transferred. If you do not follow these instructions, incorrect data could be written to the PLC and the target machine.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Note:z For information on how to display the Device Address Configuration dialog box,

see the Vijeo Designer Help.16 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverScreen Description

Area Description

Class In this list box, you can select any class identified by the ODVAs EtherNet/IP specification. To select a vendor-defined class, select Vendor Defined then enter the corresponding hexadecimal class code.

Instance 0 describes the equipment itself. Some classes use other values (1, 2, 3, and so on) to represent objects (instances of the class). For more information, refer to the EtherNet/IP specification or manufacturers data sheet.

Attribute Each class instance has a defined set of attributes that you can Get, Set, or Get and Set. Refer to the EtherNet/IP specification or manufacturers data sheet for more information.

Data Size Each class instance has a defined data size. Refer to the EtherNet/IP specification or manufacturers data sheet for more information.

Access Mode Each class instance has a defined data size. Refer to the EtherNet/IP specification or manufacturers data sheet for more information.EIO0000001144 07/2011 17

Generic EtherNet/IP Explicit DriverBit Number When working with discrete variables, you can select individual bits within a word to read or write to. When you write to a single bit in a Get and Set attribute, the target machine reads the entire word address, writes the defined bit, then returns the new word address to the PLC. If the ladder program writes data to this word address during the bit read/write process, the resulting data may be incorrect.

String Prefix When working with string variables, you can select a string prefex with the length of 0, 1, 2, or 4 bytes.

The string prefix defines how many bytes are used to evaluate the length of the string. When displaying the string, the string prefix is not displayed.

Note:z Refer to Appendix EtherNet/IP Standard Class Codes for a list of the standard

class codes.z If you are using vendor-defined class codes, the manufacturer should have

provided you with a list of the class codes supported by the driver. All EtherNet/IP equipment must support the standard class codes.

Area Description18 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverNote:z You can use Vijeo Designers Block Integer variable to Get and Set data from

structures that contain many types of data packed together. To read the contents of the Block Integer in Vijeo Designer, you can write a script that parses the data and distributes it to other Vijeo Designer variables.

z For example, when finding the IP address of the Name Server in a TCP/IP Interface Object, create the Block Integer variable defined in the following table for Attribute 5.

The Name Server is the fourth element in the Block Integer variable. Use Vijeo Designer scripts to parse the Block Integer variable and access bytes 12 to 15 (assuming we begin with byte 0) to get the Name Server IP address.

Attribute NameData Type Size

Access Rule

Data Type Details

1 Status DWORD 16 bits Get2 Configuration

CapabilityDWORD 32 bits Get

3 Configuration Control

DWORD 32 bits Get

Physical Link Object Get

Path Size 16 bits GetPath Get

Interface Configuration

STRUCT:

IP Address UDINTNetwork Mask UDINTGateway Adress UDINTName Server UDINTName Server 2 UDINTDomain Name UINTDomain Name Size

STRING

--

Block Integer

Block Elements = 4,Data Length = 32 bits,

Start Address = (F5,1,5):0:4

--

Vijeo-Designer

--

----

--

TCP/IP Interface Object

4 STRUCT: - UINT - Array of WORD

Get--5EIO0000001144 07/2011 19

Generic EtherNet/IP Explicit Driver20 EIO0000001144 07/2011

AppendixEIO0000001144 07/2011EIO0000001144 07/2011 212Appendix

What's in this Chapter?This chapter contains the following topics:

Topic Page

EtherNet/IP Standard Class Codes 22

AppendixEtherNet/IP Standard Class Codes

OverviewCode Class Name01hex Identity 02hex Message Router 03hex DeviceNet 04hex Assembly 05hex Connection 06hex Connection Manager 07hex Register 08hex Discrete Input Point 09hex Discrete Output Point 0Ahex Analog Input Point 0Bhex Analog Output Point 0Ehex Presence Sensing 0Fhex Parameter 10hex Parameter Group 12hex Group 1Dhex Discrete Input Group 1Ehex Discrete Output Group 1Fhex Discrete Group 20hex Analog Input Group 21hex Analog Output Group 22hex Analog Group 23hex Position Sensor 24hex Position Controller Supervisor 25hex Position Controller 26hex Block Sequencer 27hex Command Block 28hex Motor Data 29hex Control Supervisor 2Ahex AC/DC Drive 2Bhex Acknowledge Handler 2Chex Overload2Dhex Softstart 2Ehex Selection30hex S-Device Supervisor 31hex S-Analog Sensor 32hex S-Analog Actuator 33hex S-Single Stage Controller 34hex S-Gas Calibration 35hex Trip Point 37hex File 38hex S-Partial Pressure F3hex Connection Configuration F4hex Port F5hex TCP/IP InterfaceF6hex EtherNet Link 22 EIO0000001144 07/2011

Generic EtherNet/IP Explicit DriverTable of ContentsSafety InformationImportant Information

About the BookAt a Glance

Generic EtherNet/IP Explicit DriverSystem StructureSupported Device AddressesConsecutive Equipment AddressesI/O Manager ConfigurationEquipment ConfigurationDevice Address Configuration

AppendixEtherNet/IP Standard Class Codes