Vous êtes sur la page 1sur 22

EIO0000001144 07/2011

Generic EtherNet/IP
Explicit Driver

EIO0000001144.00

07/2011

www.schneider-electric.com

EIO0000001144 07/2011

Table of Contents

Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Generic EtherNet/IP Explicit Driver. . . . . . . . . . . . . . . .

5
7
9

System Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported Device Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Consecutive Equipment Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . .
I/O Manager Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Equipment Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Device Address Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10
11
13
14
15
16

Chapter 2 Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

EtherNet/IP Standard Class Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

EIO0000001144 07/2011

EIO0000001144 07/2011

Safety Information

Important Information
NOTICE
Read 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

PLEASE NOTE
Electrical 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.

EIO0000001144 07/2011

About the Book

At a Glance
Document Scope
This 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 Note
The 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 Conventions
Target 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

Product Related Information

WARNING
LOSS OF CONTROL
z

z
z

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.
Separate or redundant control paths must be provided for critical control
functions.
System control paths may include communication links. Consideration must be
given to the implications of unanticipated transmission delays or failures of the
link.*
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.
* For additional information, refer to NEMA ICS 1.1 (latest edition), Safety
Guidelines for the Application, Installation, and Maintenance of Solid State Control.
User Comments
We welcome your comments about this document. You can reach us by e-mail at
techcomm@schneider-electric.com.

EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver


EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver

1
Subject of this Chapter
This chapter explains the Generic EtherNet/IP (Explicit) Driver.
What's in this Chapter?
This chapter contains the following topics:
Topic

EIO0000001144 07/2011

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 Driver

System Structure
Overview
The 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

z
z

10

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.
Use a 10BASE-T connection for XBTGT1130 target machines.
Some equipment, such as Advantys STB, may have specific time-out
mechanisms. Ensure that the Vijeo Designer ScanRate setting is compatible
with your equipment.

EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver

Supported Device Addresses


Overview

WARNING
UNINTENDED EQUIPMENT OPERATION
Incorrect 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.
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 Variables
The following shows how to map class instance attributes to Vijeo Designer
variables.
Data Type

Class
Description

Data Type

Vijeo-Designer
Details

USINT

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

STRING
W ORD

ASCII character string


16-bit integer

String
Integer

Structure can include multiple


data types

Depends on STRUCT data types

*2

STRUCT

Signed = 2's Complement *1 ,


Data Length = 32 bits
NumOfBytes = string length
Signed = 2's Complement or MSB,
Data Length = 16 bits
*2

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

EIO0000001144 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 Object
The following shows how you can map attributes in the Identity object to Vijeo
Designer variables.
Class
Attribute

Name

Vijeo-Designer

Data
Type

Size

Access
Rule
Data Type

Details

Vendor ID

UINT

16 bits

Get

Integer

Signed = Unsigned,
Data Length = 16 bits

Device Type

UINT

16 bits

Get

Integer

Product Code

UINT

16 bits

Get

Integer

Signed = Unsigned,
Data Length = 16 bits
Signed = Unsigned,
Data Length = 16 bits

Revision
Major
Revision

STRUCT:
USINT
USINT

16 bits
8 bits

Get
Get

Integer

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

8 bits

Get

Integer

16 bits

Get

Integer

Signed = Unsigned,
Data Length = Bit Field,
Bit Offset = 8, Bit Width = 8
Signed = Unsigned,
Data Length = 16 bits

32 bits

Get

Integer

Get
Get
Get

String

8 bits
[0-32] x 8 bits

Minor
Revision
5

Status

WORD

Serial Number

UDINT

Product Name
Size
Name

STRUCT:
USINT
USINT

*1

--

*1

Signed = 2's Complement ,


Data Length = 32 bits
Num Of Bytes = 32,
String Prefix = 1

*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.

12

EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver

Consecutive 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 Driver

I/O Manager Configuration


Overview
In the I/O Manager, add the driver and equipment as shown.
Note:
z

For information on how to display the [New Driver] dialog box, see the Vijeo
Designer Help.

Screen example of I/O Manager Configuration

14

EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver

Equipment Configuration
Overview

WARNING
UNINTENDED EQUIPMENT OPERATION
Read 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.
Sets up details to identify the equipment you are connecting to on the network.
Note:
z

For information on how to display the [Driver Configuration] dialog box, see the
Vijeo Designer Help.

Screen example of Driver Configuration

Screen Description

Area

Description

IP Address

Enter the IP address of the remote equipment.

Note:
z

EIO0000001144 07/2011

Consult your network administrator when setting up the IP address.

15

Generic EtherNet/IP Explicit Driver

Device Address Configuration


Overview

WARNING
UNINTENDED EQUIPMENT OPERATION
Read 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.
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.
Note:
z

For information on how to display the Device Address Configuration dialog box,
see the Vijeo Designer Help.

Screen example of Device Address Configuration

16

EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver

Screen Description

EIO0000001144 07/2011

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.

17

Generic EtherNet/IP Explicit Driver

Area

Description

Bit 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
z

18

Refer to Appendix EtherNet/IP Standard Class Codes for a list of the standard
class codes.
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.

EIO0000001144 07/2011

Generic EtherNet/IP Explicit Driver

Note:
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.
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.
TCP/IP Interface Object
Attribute

Name

Data
Type
DWORD

Status

DWORD
Configuration
Capability
DWORD
Configuration
Control
Physical Link Object STRUCT:

3
4

Path Size
Path
5

Interface
Configuration
IP Address
Network Mask
Gateway Adress
Name Server
Name Server 2
Domain Name
Domain Name
Size

- UINT
- Array
of
WORD
STRUCT:
UDINT

Vijeo-Designer
Size

Access
Rule

16 bits

Get

--

32 bits

Get

--

32 bits

Get

--

Get

--

Get

--

16 bits

Data
Type

--

Get
--

Get

Details

Block
Integer

Block Elements = 4,
Data Length = 32 bits,
Start Address = (F5,1,5):0:4

UDINT
UDINT
UDINT
UDINT
UINT
STRING

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.

EIO0000001144 07/2011

19

Generic EtherNet/IP Explicit Driver

20

EIO0000001144 07/2011

Appendix
EIO0000001144 07/2011

Appendix

2
What's in this Chapter?
This chapter contains the following topics:
Topic
EtherNet/IP Standard Class Codes

EIO0000001144 07/2011

Page
22

21

Appendix

EtherNet/IP Standard Class Codes


Overview
Code
01hex
02hex
03hex
04hex
05hex
06hex
07hex
08hex
09hex
0Ahex
0Bhex
0Ehex
0Fhex
10hex
12hex
1Dhex
1Ehex
1Fhex
20hex
21hex
22hex
23hex
24hex
25hex
26hex
27hex
28hex
29hex
2Ahex
2Bhex
2Chex
2Dhex
2Ehex
30hex
31hex
32hex
33hex
34hex
35hex
37hex
38hex
F3hex
F4hex
F5hex
F6hex
22

Class Name
Identity
Message Router
DeviceNet
Assembly
Connection
Connection Manager
Register
Discrete Input Point
Discrete Output Point
Analog Input Point
Analog Output Point
Presence Sensing
Parameter
Parameter Group
Group
Discrete Input Group
Discrete Output Group
Discrete Group
Analog Input Group
Analog Output Group
Analog Group
Position Sensor
Position Controller Supervisor
Position Controller
Block Sequencer
Command Block
Motor Data
Control Supervisor
AC/DC Drive
Acknowledge Handler
Overload
Softstart
Selection
S-Device Supervisor
S-Analog Sensor
S-Analog Actuator
S-Single Stage Controller
S-Gas Calibration
Trip Point
File
S-Partial Pressure
Connection Configuration
Port
TCP/IP Interface
EtherNet Link
EIO0000001144 07/2011