Professional Documents
Culture Documents
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the
use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and
requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or
liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or
software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation,
Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
IMPORTANT Identifies information that is critical for successful application and understanding of the product.
Allen-Bradley, Rockwell Software, Rockwell Automation, RSLogix 5000, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of Contents
Chapter 1
Introduction About this publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Definitions, Acronyms, and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . 4
General EDS file information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
EDS file authoring tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
EDS file installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Icon files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chapter 2
Creating an EDS file Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Input and Output data structures and parameters . . . . . . . . . . . . . . . . . . . . . 9
Input tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Output tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Defining I/O parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Configuration data structures and parameters . . . . . . . . . . . . . . . . . . . . . . 11
Configuration tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Defining configuration parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Using multiple languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 3
Module Configuration Dialog Boxes General tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About Module Profile dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Module Definition dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Connection tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Module Info tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Internet Protocol tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Port Configuration tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Port Diagnostics dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Network tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Advanced Network Configuration dialog box. . . . . . . . . . . . . . . . . . . 26
Time Sync tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Chapter 4
EDS File Sections [File] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Revision, CreateDate, CreateTime, ModDate and ModTime
keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
[Device] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Catalog and ProdName keywords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Catalog keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ProdName keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
VendName keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
ProdTypeStr keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
MajRev keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
MinRev keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
[Device Classification] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
ClassN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
[Connection Manager] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
ConnectionN keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
[ParamClass] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CfgAssembly keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CfgAssemblyExa keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Descriptor keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
[Assembly] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
AssemN/AssemExaN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
VariantN/VariantExaN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
[Params] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
ParamN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
[Groups] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
[Internationalization] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
ProdName keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
ParamN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
EnumN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
GroupN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
AssemN/AssemExaN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
ConnectionN keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
[Modular] Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
[Ethernet Link Class] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
[TCP/IP Interface Class] Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
[DLR Class] Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
[Time Sync Class] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Chapter 5
Description of Data Types and Tags Module-Defined Data Type Naming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Tag Naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Module-Defined Data Type Member Naming . . . . . . . . . . . . . . . . . . . . . . 61
Chapter 6
Example EDS Files Minimum EDS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Enhanced EDS, Single Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Enhanced EDS, Single Connection, Configuration Data. . . . . . . . . . . . . 65
Enhanced EDS, Multiple Choice of Connections and Multiple
Simultaneous Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Introduction
Topic Page
About this publication 3
General EDS file information 5
About this publication The document provides an overview of the Logix Designer EDS Add-On Profile
(AOP) feature, how Electronic Data Sheet (EDS) content is used by the feature,
and guidelines for creating EDS content that will integrate well within the Logix
Designer development environment. The EDS file format for the Common
Industrial Protocol (CIP) networks is defined by ODVA.
Creating an EDS can be an efficient way to enable a module to operate within the
Rockwell integrated architecture, and gives the module developer a better
alternative to using the Generic Device AOP.
This document describes the specific parts of the EDS file that affect module
configuration, I/O, and the user interface in Logix Designer. This document is
intended to be used by module developers who intend to have their module
configured by the EDS AOP using EDS content.
• Be very familiar with the CIP EDS definition; see chapter 7 in THE CIP
NETWORKS LIBRARY Volume 1, Common Industrial Protocol (CIP™),
Edition 3.11 and THE CIP NETWORKS LIBRARY Volume 2, EtherNet/
IP Adaptation of CIP, Edition 1.12.
• Be familiar with the Logix Designer dialog boxes. These are described in
Module Configuration Dialog Boxes on page 17.
The Logix Designer EDS AOP feature is limited to devices with a single CIP
port that attach to the Ethernet bus.
References
The following definitions, acronyms, and abbreviations are used throughout this
document.
General EDS file information This section provides general information about EDS tools, EDS installation,
and EDS icon files. You can find example EDS files described in Example EDS
Files on page 63.
EDS files can be created using any ASCII text editor that is capable of handling
the character set specified in Section 7-3.5.1 of THE CIP NETWORKS
LIBRARY Volume 1, Common Industrial Protocol (CIP™), Edition 3.11.
TIP The use of a specialized EDS editing tool, such as the ODVA freeware tool EZ-
EDS, is recommended.
Developers who need to create large families of EDS files of nearly identical
modules may choose to use or develop tools that automatically create the EDS
files for a set of modules within the product family. If EZ-EDS is not used to
construct the file(s), it should be used to verify the EDS file(s) syntax (ODVA
uses the latest version during conformance testing).
EDS files are provided by the module vendor, and are deployed in one or more
ways:
EDS files are registered using the EDS Hardware Installation Tool in Logix
Designer version 20 or later. There is no need to shut down Logix Designer to
register a new EDS, and the EDS is immediately available. Logix Designer does
not allow you to register an older version EDS file over a newer version EDS file.
The EDS Hardware Installation Tool issues warnings when it detects problems in
the EDS (for example, about discarded entries).
IMPORTANT These warnings should be taken into consideration when registering an EDS.
For example, a connection may be discarded because an assembly referenced
in the connection is missing from the EDS file.
If an EDS file is not available for a module that exists in the Logix Designer I/O
tree, Logix Designer displays a message that the module is not registered. This
can happen when Logix Designer detects a new module, or if you copy a Logix
Designer project ACD file to a different computer that does not have the correct
EDS files registered. Logix Designer also displays a message if the device
configuration was created using a newer version of the EDS than the one
registered on the computer. In both cases, Logix Designer cannot display the
Module Properties dialog box for the module until you install the correct EDS
file. Logix Designer can still download the project to the controller.
Icon files
TIP Module icon files are highly recommended.
If there is no module icon file, Logix Designer assigns a default icon. The icon
allows a graphical representation of the module in the RSLinx and Logix
Designer environment. Icons can be embedded in modules using the method
described in Section 5-42 (File Object) of THE CIP NETWORKS LIBRARY
Volume 1, Common Industrial Protocol (CIP™), Edition 3.11.
The EZ-EDS tool version 3.9 or later supports embedding icons inside the EDS
file. If icons are embedded inside the EDS using the method described in Section
7-3.6.3 of THE CIP NETWORKS LIBRARY Volume 1, Common Industrial
Protocol (CIP™), Edition 3.11, they will be extracted automatically from the EDS.
Logix Designer can automatically assign icons provided as separate files if their
file names match the ones specified by the Icon keyword in the Device
Description section ([Device] Section on page 30) of the EDS. The icon files
must reside in the same directory as the EDS. If these conditions are not met, the
EDS Hardware Installation Tool allows you to manually assign an icon file when
registering the EDS.
• You should center your icon in both the horizontal and vertical directions.
• You should use transparent pixels for the pixels that are not part of your
product. Do not use solid colors for backgrounds.
The red dots in the graphic below indicate the points at which your icon should
be centered horizontally. This will insure that your icon appears correctly.
In addition, make sure the Logix Designer overlays (for example, inhibited
device, error indication) are visible and evident in the Logix Designer I/O tree.
Notes:
Topic Page
Connections 9
Input and Output data structures and parameters 9
Configuration data structures and parameters 11
Using multiple languages 14
This section gives an overview of the process of creating an EDS file for a module.
Connections A connection identifies a CIP connection supported by the module and allows
for setting some connection parameters that define controller-to-module
behavior. There may be different connections for different purposes. For
example, one connection could be optimized for speed, and another connection
for carrying more data. The connection also defines its Input, Output, and
Configuration assemblies (described in Input and Output data structures and
parameters on page 9 through Configuration data structures and parameters on
page 11).
Connections are defined in the [Connection Manager] section of the EDS file
(page 35). The connection information appears in the Module Definition dialog
box (page 19) and the Connection tab (page 21).
Input and Output data This section covers defining your module Input and Output data structures and
parameters, and how they are displayed in Logix Designer. In the EDS file, the
structures and parameters [Assembly] section defines the data structures. The EDS file details are described
later in this document, beginning with EDS File Sections on page 29.
The Input and Output data structures define the parameters whose values are
produced by the target module and consumed by the target module.
• The Input and Output tags are contained in a single non-descriptive array
of type SINT, INT, DINT or REAL.
• Both detailed and non-detailed assemblies only define the size of the
assembly, and result in a non-detailed data type ([Assembly] Section on
page 45).
Input tags
The values for Input tags are sent from the target module to the controller.
Output tags
The values for Output tags are sent from the controller to the target module.
You define I/O parameters in the [Params] section of the EDS file (page 47). The
following example shows two circled Output parameters (the first bit-
enumerated). Param2 corresponds to Data[0] and Data[1], Param3 corresponds
to Data[2] and Data[3] in Figure 5.
Configuration data This section covers defining your module configuration data structures and
parameters, and how they are displayed in Logix Designer. In the EDS file, the
structures and parameters
[Assembly] section defines the data structures. The EDS file details are described
later in this document, beginning with EDS File Sections on page 29.
Configuration tags
Configuration tags are parameters that are sent from a controller to a target
module when an I/O connection is established. They configure and verify how a
target module is configured.
You define configuration parameters in the [Params] section of the EDS file. The
following example shows two circled configuration items, the first corresponds to
Param7 from the EDS snippet below and the second corresponds to Param11
from the EDS snippet below (Param11 is bit enumerated).
Using multiple languages It is strongly recommended that you include support for multiple languages in
your EDS file. Logix Designer has been translated into English, French, German,
Spanish, Portuguese, Italian, Korean, Japanese, and Chinese. Names you can
translate include connections, configuration parameters, and assemblies. Tag
member names in data structures always use the default string from the original
definition in the EDS file.
When Logix Designer displays the Module Properties dialog box for a device
with an EDS file, these rules control which text is displayed:
{"deu",0xD0,4,"ms"}
},
{
2,
{"eng",0xD0,4,"The value for the start ramp"},
{"deu",0xD0,4,"Der Wert für die Start-Rampe"}
};
The first group of EDS keywords support internationalization and should always
be translated:
• ProdName
• ConnectionN
The second group of EDS keywords support internationalization and need only
to be translated if they represent items that appear in the Module Definition
dialog box (Figure 11 on page 20)
• ParamN
• EnumN
• GroupN
• AssemN, AssemExaN
Notes:
Topic Page
General tab 17
Connection tab 21
Module Info tab 22
Internet Protocol tab 23
Port Configuration tab 24
Network tab 25
Time Sync tab 26
Logix Designer uses tabbed dialog boxes with a common look and feel to display
the information from an EDS file and from the corresponding module when
online. This simplifies device configuration in the integrated architecture. This
section lists the dialog boxes, describes their functions, and references the EDS
file sections that affect the dialog boxes in Logix Designer. This shows you how
the information from the EDS is displayed by the EDS AOP in the Logix
Designer user interface.
General tab The General tab displays a module’s properties, and allows you to enter some
information about the module. This tab is used to configure and display:
• Module type and vender name (see ProdTypeStr keyword on page 33. and
VendName keyword on page 33).
Click the module in the Logix Designer I/O tree and press Enter, or right-click
the module and select Properties to display this dialog box.
The About Module Profile dialog box displays version and file information about
Logix Designer and the EDS file. In addition, you can view the EDS file in a text
editor. This dialog box displays:
• EDS file version, creation date and time, and modification date and time
(see Revision, CreateDate, CreateTime, ModDate and ModTime
keywords on page 29).
Click the icon in the upper-left corner of the Module Properties dialog box to
display the context menu, and then select About Module Profile to display this
dialog box (see Figure 10).
• Select the module revision (major and minor, see MajRev keyword on
page 34 and MinRev keyword on page 34). Note that the module revision
number is not the same as the EDS file version number.
• Select a single connection that the controller will open (see ConnectionN
keyword on page 35).
Optionally, for those modules that support one or more additional module
definition properties (as defined by the module developer), you can also perform
the following:
Click the Change button in the Module Properties dialog box to display this
dialog box (see Figure 12).
The Custom Data Type dialog box allows you to configure indirect Input/
Output parameters. The dialog box displays:
• The dynamic I/O module-defined data type information, see T→O and
O→T Format fields on page 39 and Indirect Parameter reference under
Descriptor field on page 46.
Click the Change button in the Module Definition dialog box to display this
dialog box. The Change button only appears if indirect parameters exist in Input
or Output assemblies associated with the connection (see Figure 14).
Connection tab The Connection tab displays the set of configured connections (see
ConnectionN keyword on page 35) and allows for setting some connection
parameters that define controller-to-module behavior. This tab also shows the
status of the connection(s) between the controller and the target module. The
data on this tab comes directly from the controller. On this tab, you can perform
the following:
• Select a requested packet interval.
• Specify an Input type.
• Select an Input trigger.
• Choose to inhibit the module.
• Configure fault handling and view module faults.
Module Info tab The Module Info tab displays module and status information. It also lets you
reset a module to its power-up state. The information on this tab comes directly
from the module, and is not displayed if Logix Designer is offline, or if you are
currently creating a module. In addition, it indicates if there is a mismatch
between the configured module in Logix Designer and the online module. Use
this tab to:
• Display the module identity, see [Device] Section on page 30.
• Display the module status.
• Reset the module.
Internet Protocol tab The Internet Protocol tab displays the TCP/IP object attribute values that exist
in the online module and allows the user to make changes to the online module.
See [TCP/IP Interface Class] Section on page 55.
Port Configuration tab The Port Configuration tab displays the Ethernet Link object attribute values in
the online module and allows the user to make changes to the online module. See
[Ethernet Link Class] Section on page 54.
Click the […] button on the Port Configuration tab to display the Port
Diagnostics dialog box (see Figure 19).
The Port Diagnostics dialog box displays diagnostic information for the selected
port (see Port Configuration tab on page 24). You can also reset the diagnostic
counters.
Click the […] button on the Port Configuration tab (see Figure 18) to display the
Port Diagnostics dialog box.
Network tab The Network tab displays the Device Level Ring object attribute values in the
online module and allows you to make changes to the online module. The
Network tab is displayed only for EtherNet/IP modules that support the Device
Level Ring object (see [DLR Class] Section on page 56). The tab includes a
control to enable Supervisor Mode only if the module supports the Supervisor
Mode function.
Click the Advanced button on the Network tab to display the Advanced
Network Configuration dialog box (see Figure 21).
Click the Advanced button on the Network tab to display the Advanced
Network Configuration dialog box (see Figure 20).
Time Sync tab The Time Sync tab displays the Time Sync object attribute values in the online
module and allows the user to make changes to the online module. The Time
Synch tab is only displayed for modules that support the Time Sync object (see
[Time Sync Class] Section on page 57).
Notes:
Topic Page
[File] Section 29
[Device] Section 30
[Device Classification] Section 35
[Connection Manager] Section 35
[ParamClass] Section 45
[Assembly] Section 45
[Params] Section 47
[Internationalization] Section 52
[Ethernet Link Class] Section 54
[TCP/IP Interface Class] Section 55
[DLR Class] Section 56
[Time Sync Class] Section 57
This section describes the EDS sections and entry keywords used by the Logix
Designer EDS AOP feature. It covers how the keyword affects a CIP service (for
example, the Forward_Open service) or affects a Module Properties dialog box.
There are several example EDS files described in Example EDS Files on page 63.
EDS sections and keywords that are not mentioned in this document are not
supported in the Logix Designer EDS AOP and are ignored.
[File]
[File] Section DescText = "Test EDS Description";
CreateDate = 01-14-2011;
CreateTime = 14:26:47;
ModDate = 12-23-2011;
ModTime = 11:55:27;
Revision = 1.0;
The revision, creation, and modification information are displayed on the About
dialog box.
[Device]
[Device] Section VendCode = 2011;
VendName = "Test Vendor 2011";
ProdType = 0xFFFF;
ProdTypeStr = "Generic Device";
ProdCode = 9;
MajRev = 1;
MinRev = 1;
ProdName = "3 Assemblies with Structure";
Catalog = "TestDevice#9";
TIP The combination of the strings for Catalog and ProdName should be unique for
all modules from a vendor so that they can be distinguished from each other.
Catalog keyword
The Catalog keyword value is displayed in the Catalog Number column of the
Catalog and Favorites tabs of the Select Module Type dialog box. If the optional
Catalog keyword is omitted, a string of the form xxxx_yyyy_zzzz (xxxx is hex
VendCode, yyyy is hex ProdType, zzzz is hex ProdCode) is displayed instead.
The Catalog keyword value is displayed in the I/O Configuration tree module
entry in Controller Organizer.
ProdName keyword
Figure 26 - ProdName string on Catalog tab of Select Module Type dialog box
Figure 27 - ProdName string on Module Discovery tab of Select Module Type dialog box
VendName keyword
The VendName keyword value is displayed on the General Tab in the Vendor
field.
The VendName keyword value is displayed in the Vendor column on the Catalog
and Favorites tabs of the Select Module Type dialog box.
ProdTypeStr keyword
The ProdTypeStr keyword value is displayed in the Category column of the
Catalog and Favorites tab of the Select Module Type dialog box.
For vendor-specific ProdType values, the ProdTypeStr from the first EDS
registered for the VendCode/ProdType is used.
MajRev keyword
The MajRev keyword value is available for selection on the Major Revision
control of the Module Definition dialog box (Figure 11 on page 20).
MinRev keyword
The MinRev value is used as the default value of Minor Revision control on the
Module Definition dialog box (Figure 11 on page 20).
[Device Classification]
[Device Classification] Class1 = EtherNetIP;
Section
ClassN keyword
If the module is an EtherNet/IP module, a ClassN keyword must exist in the
[Device Classification] section. An example of the keyword will look as follows:
Class1 = EtherNetIP;
[Connection Manager]
[Connection Manager] Connection1 =
Section 0x04030002,
0x44640405,
Param1,,Assem101, $ O−>T RPI, size, format
Param1,,Assem102, $ T−>O RPI, size, format
,, $ proxy config size, format
,Assem100, $ target config size, format
"I/O Connection", $ Connection Name
"", $ help string
"20 04 24 64 2C 65 2C 66"; $ Path
ConnectionN keyword
Connections are added by default if no variables exist in the Path field and the
connection does not conflict with an existing connection (see Path field on
page 44, for rules describing connections that can exist together). All Exclusive-
Owner connections are added, and then Input-Only connections are added, and
then Listen-Only connections are added.
ConnectionN entries that do not meet the criteria listed below in this section are
ignored.
TIP A “Ping” ConnectionN entry is also supported; see Section 7-3.6.10.1.13 in THE
CIP NETWORKS LIBRARY Volume 1, Common Industrial Protocol (CIP™), Edition
3.11. A Ping Connection allows a Module to be added with no connections
configured. The controller will periodically send a Null Forward_Open service
as described in Section 3-5.5.2.2.2 in THE CIP NETWORKS LIBRARY Volume 1,
Common Industrial Protocol (CIP™), Edition 3.11 to verify the correct module is
present.
ConnectionN fields
• Transport class
The Transport Class field value of the Transport Class and Trigger
parameter sent in the Forward_Open request is always set to 1.
• Trigger
• Application type
• Direction
The T→O and O→T fixed/variable size supported value must indicate
fixed size.
The T→O Connection type is displayed in the Input Type column of the
Connection tab. The T→O Connection type (Unicast or Multicast) is
selected by a drop-down control.
The T→O and O→T Priority must indicate either both T→O and O→T
HIGH priority or both T→O and O→T SCHEDULED priority. Both
HIGH and SCHEDULED can be indicated.
The RPI is displayed in the RPI column on the Connection tab (page 21).
The user selected RPI value is the Forward_Open T→O and O→T RPI
parameter values.
TIP If the O→T production is heartbeat, then a longer O→T RPI value is calculated
and used to reduce unneeded traffic.
If the size field is empty, the size of the item specified in the corresponding format
field size plus sequence count size (2) and optional 32 bit run/idle header size (4)
is the Forward_Open T→O and O→T Network Connection parameter,
Connection Size values.
If the size field is a UINT, then the size field value plus sequence count size(2)
and optional 32 bit run/idle header size (4) is the Forward_Open T→O and
O→T Network Connection parameter, Connection Size values.
The T→O and O→T Size is displayed on Module Definition dialog box, Size
column.
If the size field is a ParamN, then the user selected size plus sequence count
size(2) and optional 32 bit run/idle header size (4) are the Forward_Open T→O
and O→T Network Connection parameter, Connection Size values. If the size
field is a parameter, either range or enumeration can be supported, but not both.
If the format field is empty, no Input or Output Module-Defined data type or tag
is created.
IMPORTANT If you want Input/Output Module-Defined data types and tags to be created,
you must specify the format field even when the format of the data is dynamic.
In this case, an AssemN must be specified as the format with the Allow Value
Edit bit of the Descriptor of this AssemN set and the size of the AssemN must be
specified by the AssemN Size field or a single Member Size/Member Reference
pair with an empty Member Reference field.
If the format specifies one or more ParamN entries., a Module-Defined data type
and tag is created if the format results in one or more ParamNs.
IMPORTANT The Input Module-Defined data types created for T→O will include a BOOL
member named ConnectionFaulted in the first 32 bits.
The Input Module-Defined data type created for T→O will include a BOOL
member named RunMode in the first 32 bits if the T→O Real Time transfer
format is 32-bit run/idle header.
The Module-Defined data types created have a data member of type SINT, INT,
DINT or REAL array as chosen by the user in the Module Definition dialog box,
Size column.
The type choice of INT will only be allowed when the I/O sizes (in bytes) is
divisible by 2. The type choices of DINT and REAL are allowed when the I/O
sizes (in bytes) are divisible by 4. If the size fields are ParamNs, then the
maximum values of the ParamN are used to determine if INT, DINT and REAL
choices are available. If the maximum values are divisible by 2, the choice of
SINT and INT are available. If the maximum values are divisible by 4 then the
choices of SINT, INT, DINT and REAL are available.
If the size field is empty, the size of the item specified in the corresponding format
field size is the Forward_Open Connection_Path parameter data segment size
value (converted from bytes to words and rounded up).
If the size field is a UINT, then the size field will be the Forward_Open
Connection_Path parameter data segment size value (converted from bytes to
words and rounded up).
If the size field is a ParamN, the default value of the ParamN will be the
Forward_Open Connection_Path parameter data segment size value (converted
from bytes to words and rounded up).
If the format field is empty and the Target Config Size field contains a non-null
size, the Forward_Open Connection_Path parameter data segment will be filled
with zeros.
If the format field is a ParamN or AssemN, the value of the ParamN or AssemN
will be the Forward_Open Connection_Path parameter data segment data
values.
If the format specifies one or more ParamN entries, a Module-Defined data type
and tag is created if the format results in one or more ParamNs.
Ignored.
Path field
If multiple connections exist with the same connection path, only the
ConnectionN entry with the lowest N will be available in the EDS AOP. All
other connections with identical paths are discarded during the EDS install
process. This is indicated as a warning when using the EDS Hardware Installation
Tool to register the EDS file (EDS file installation on page 5).
If two connections are to be available that are identical except for their
configuration (one with configuration, one without), they must have different
paths; it is recommended that the connection without configuration does not
include a configuration path.
The Path field contains up to 3 application paths. These 3 application paths are
used to limit the set of connections that can be configured simultaneously.
IMPORTANT If the module has additional rules that limit the set of connections that can be
opened simultaneously, the module developer must document these rules for
the user.
The ConnectionN Path field can contain variables ([ParamN] entries) in the
O→T and T→O application path. When the connection is configured in the
Logix Designer Module Definition dialog box, the user can set the ParamN value
in the Remote Data column.
Ignored
CfgAssemblyExa keyword
Ignored
Descriptor keyword
Ignored.
Supported uses
Nested assemblies
Assemblies can be nested. The result of nested assemblies will always be flat; no
nested structures will be displayed.
AssemN/AssemExaN fields
Name field
Path field
Ignored
Size field
The Size field can be empty if the Member Size/Member Reference is provided
for all members.
Descriptor field
• Allow Value Edit bit field
Not supported.
Not supported.
and the ConnectionN specifies a NULL Connection Type for both O→T
and T→O, then:
• A NULL forward open will be sent to the module when a MSG
instruction that specifies the Reconfigure option, with this module as
the target.
VariantN/VariantExaN keyword
The Variant/VariantExaN keywords are supported as defined in the CIP
Common specification, see THE CIP NETWORKS LIBRARY Volume 1,
Common Industrial Protocol (CIP™), Edition 3.11.
ParamN fields
Ignored.
Descriptor field
• Supports settable path
Ignored.
• Get_Enumerated_String Supported
Ignored.
TIP Enumerations are supported as described in other parts of this
document without this bit being set.
• Supports Scaling
Ignored.
• Supports Scaling Links
Ignored.
• Read Only Parameter
If the parameter described by the ParamN entry is included in the module
configuration, it will be hidden in the Configuration module-defined data
type.
• Monitor Parameter
Ignored.
• Supports Extended Precision
Ignored.
• Supports non-consecutive enumerated strings
Ignored.
• Allows both enumeration and min/max range values
Ignored.
• Non-displayed parameter
If set, ParamN is not displayed.
• Indirect Parameter reference
If set and the ParamN is in a Configuration assembly, it is presented on the
Module Definition, Custom Data type dialog box. If the ParamN is in an
Input or Output assembly, the selected ParamN (from the Module
Definition, Custom Data type dialog box) is used as the Module-Defined
data type member.
• Not Addressable
Ignored.
• Save Supported
Ignored.
• Apply Supported
Ignored.
• Write Only Parameter
Ignored.
(1) If the maximum value of the unsigned 8-bit integer is 128 or larger, the entire Module-Defined data type will be a SINT array.
(2) If the maximum value of the unsigned 16-bit integer is 32768 or larger, the entire Module-Defined data type will be a SINT array.
(3) If the maximum value of the unsigned 32-bit integer is 2147483648 or larger, the entire Module-Defined data type will be a SINT
array.
(4) If the maximum unsigned ULINT value would result in a negative LINT value, the entire Module-Defined data type becomes a SINT
array.
Follows the CIP specification. See THE CIP NETWORKS LIBRARY Volume 1,
Common Industrial Protocol (CIP™), Edition 3.11.
These guidelines should be followed for Parameter Names that are included in
Configuration assemblies:
• The first letter in each word making up the name should be capitalized.
This allows the words to stand out when the data type name is compressed
(after spaces are removed.)
• Channel data is prefixed (not post fixed) with Ch followed by the channel
number. It is not spelled out, since it has become a common convention.
Ignored
Ignored
Used as defined in the CIP specification. See THE CIP NETWORKS LIBRARY
Volume 1, Common Industrial Protocol (CIP™), Edition 3.11.
Ignored
Ignored
Ignored
Ignored
Ignored
Ignored
If the EnumN is for a bit string (BYTE, WORD, DWORD, LWORD) ParamN
that is a member of a configuration assembly, then the bit name is used as the
Module-Defined data type member name. The bit name is converted to conform
to the IEC 61131 name standard. All unsupported characters, including spaces,
are replaced with an underscore (_) character during the conversion, consecutive
underscore (_) characters and trailing underscore (_) characters are removed and
leading numbers are prefixed with an underscore (_) character.
These guidelines should be followed for bit names that are included in
Configuration assemblies:
• The first letter in each word making up the name should be capitalized.
This allows the words to stand out when the data type name is compressed
(after spaces are removed).
• Names should not reflect the data type. For example, On, not OnBit.
• Naming of bits should be for the positive sense of the member. FuseBlown
is 1 when the fuse is blown, 0 when it is not. It is generally preferable to
name a bit member in a manner that reflects the interesting state rather
than the steady state value. In most cases, this is the on, enabled, or
energized state versus the off state. For example, FuseBlown is preferable to
FuseOK or FuseNotBlown. Note that this requires the proper design of
the device. Note also that the on state is not necessarily the most
interesting state.
[Internationalization] The language Logix Designer is displaying determines which string from the
EDS file is used for the items below. If a string for the Logix Designer language is
Section not specified, then the string from the non-Internationalization section version of
the keyword is used.
TIP The keywords listed below should have English, French, German, Spanish,
Portuguese, Italian, Korean, Japanese, and Chinese strings because Logix
Designer is translated to each of these languages.
ProdName keyword
ParamN keyword
Ignored
Ignored
Ignored
Ignored
EnumN keyword
Ignored
GroupN keyword
Ignored
AssemN/AssemExaN keyword
ConnectionN keyword
[Ethernet Link Class] Section If the module supports the Ethernet Link object this section should exist.
IMPORTANT If the module has more than one Ethernet port, this shall be reflected in the
EDS as specified in the ODVA specifications.
The optional or conditional Ethernet Link object Interface Counters and Media
Counters attributes should be implemented.
[TCP/IP Interface Class] If the module supports the TCP/IP Interface object, this section should exist.
Section The following entry keywords should be defined:
TIP If no capability ParamN entry exists, the value of 0 is used for the TCP/
IP capabilities attribute.
• The AssemN entry should include the Member References for each
member of the Ring Supervisor Config attribute. The ParamN that
represents the Beacon Interval member should specify the minimum
and maximum values supported for this module’s Beacon Interval.
• If no Ring Supervisor Config AssemN entry exists, 400 microseconds is
used as the minimum Beacon Interval and 100,000 microseconds is
used as the maximum Beacon Interval.
• Ring_Supervisor_Capable
[Time Sync Class] Section If the module supports the Time Sync object, this section should exist.
Notes:
Topic Page
Module-Defined Data Type Naming 59
Tag Naming 60
Module-Defined Data Type Member Naming 61
This section describes the rules the EDS AOP follows for creating Module-
Defined Configuration, Input, and Output data type names, tag names, and
Module-Defined data type member names.
Module-Defined Data Type Module-defined data types define the structure of the data used by the module
for its Input, Output, and/or Configuration Data. These tags allow you to access
Naming this data via the controller’s program. This section describes the rules Logix
Designer uses for naming module-defined data types. The names are displayed
under Data Types in the Controller Organizer.
• The ordinal comes from the Module Definition dialog box, Tag Suffix
column. Ordinal only exists when more than one connection can be
configured.
Notes:
The following sections describe examples of EDS files and how these EDS files
translate into details in Logix Designer.
TIP The example EDS files are attached to this PDF file. In Adobe Acrobat. or Adobe
Reader, you display the Attachments panel by:
• Clicking the small paperclip icon in the bottom left corner of the Acrobat or
Reader window.
• Selecting the View > Navigation Panels > Attachments command to
display the Attachments panel.
Minimum EDS This section describes the bare bones minimum that is required to make an EDS
usable in an Logix Designer environment, plus a number of extensions that
improve its usability.
The Minimal EDS described in this section makes use of the Allow Value Edit bit
while the more complex EDS files described later use parameters to structure the
assemblies. It is strongly suggested that you add more details to an EDS as
outlined in the more detailed EDS files below. The Minimal EDS is shown here
mainly for reference and to break the evolution of an EDS into several steps.
With the Minimal EDS, the Logix Designer EDS AOP offers only the following
choices and structures.
• Choice of IP address.
• Choice of SINT, INT, DINT, or REAL data structure for the I/O tags.
This EDS creates nothing but an Input data tag and an Output data tag of the
defined sizes. In particular, no structure or meaning of the I/O data is visible.
Logix Designer adds a status bit to the Input tag that reports when the
connection has failed.
This is what the resulting tags look like with data type SINT:
Enhanced EDS, Single To provide a better user experience, at least the following enhancements are
recommended:
Connection
• Range limitation for RPI
• Param1 limits the RPI range to values between 4.0 and 100.0ms with a
default value of 10.0ms
Enhanced EDS, Single This EDS includes a configuration assembly structured into individual
parameters in addition to the features of the previous EDS. See the attached One
Connection, Configuration Connection, 3 Assemblies with Structures EDS.eds file for details.
Data
There are now a total of 11 parameters and the additional parameters 7 through
11 describe the structure of the Configuration Assembly.
This is what this module looks like in the Logix Designer tag structure:
Enhanced EDS, Multiple An EDS file may define multiple ConnectionN entries for a module. There are
typically a set of up to three ConnectionN entries describing one or more
Choice of Connections and connections:
Multiple Simultaneous • An Exclusive-Owner Connection (if the module has Output data).
Connections • An Input-Only Connection.
• A Listen-Only Connection.
Such a set of ConnectionN entries specify the same Input Connection Point and
(if included) the same configuration data. Multiple sets like this may exist that
describe connections using different I/O Assemblies.
With an EDS like this, the Module Definition dialog box allows the user to pick
one of the connections. The first Exclusive-Owner Connection in the EDS is
presented as default connection.
If Logix Designer determines that there are multiple sets of ConnectionN entries,
a group of connections is created.
The tags created by multiple connections have numbers appended to make them
unambiguous.
D
data structures
Configuration 12
Input 9
A Output 9
abbreviations 4 definitions
About Module Profile dialog box 18 AOP 5
EDS 5
about this publication 3 EDS AOP 5
acronyms 4 profile 5
Advanced Network Configuration dialog box deploying EDS files 5
26 Descriptor field 46
AOP Descriptor keyword 45
definition 5 [Device] section 30
Generic Device 3 [Device Classification] section 35
[Assembly] section 45 devices
Configuration parameters 13 not supported 4
Input and Output parameters 11 supported 4
AssemN/AssemExaN keyword 45, 53 [DLR Class] section 56
Descriptor field 46
Name field 46
Path field 46 E
Size field 46
editing EDS files 5
EDS AOP
B definition 5
bit-enumerated parameters 10, 14 feature limitations 4
buses, supported 4 EDS file sections
[Assembly] 45
[Connection Manager] 35
C [Device Classification] 35
[Device] 30
Catalog keyword 30 [DLR Class] 56
CfgAssembly keyword 45 [Ethernet Link Class] 54
CfgAssemblyExa keyword 45 [File] 29
CIP connections 9 [Groups] 52
[Internationalization] 52
ClassN keyword 35 [Modular] 54
Configuration [ParamClass] 45
data structure 12 [Params] 47
parameters 12, 13 [TCP/IP Interface Class] 55
tags 12 [Time Sync Class] 57
conformance testing 5 EDS files
[Connection Manager] section 35 and Logix Designer 4
Connection Name String field 42 creating 3
Connection Parameters field 36 deploying 5
editing 5
Connection tab 21 Enhanced EDS, multiple connections 66
ConnectionN keyword 35, 53 Enhanced EDS, single connection 64
Connection Name String field 42 Enhanced EDS, single connection, config data
Connection Parameters field 36 65
Help String field 44 examples 63
Path field 44 general information 5
Proxy Config Size and Format fields 40 icon files 6
T−>O and O−>T Format fields 39 internationalization 14
T−>O and O−>T RPI fields 38 Minimum EDS 63
T−>O and O−>T Size fields 39 not available 6
Target Config Format field 40 registering 5
Target Config Size field 40 requirements for module developers 4
Trigger and Transport fields 36 EDS Hardware Installation Tool
CreateDate keyword 29 registering EDS files 5
CreateTime keyword 29 warnings 6
creating EDS files 3 EDS, definition 5
Enhanced EDS, multiple connections file icon files for EDS files 6
example 66 Input
Enhanced EDS, single connection file example data structures 9
64 parameters 10
Enhanced EDS, single connection, config data tags 10
installing EDS files
file example 65
See registering EDS files
enumeration [Internationalization] section 52
EnumN 52 internationalization
parameter 10
parameters 13 EDS files 14
ParamN 52 keywords 15
EnumN enumeration 52 Internet Protocol tab 23
EnumN keyword 53
[Ethernet Link Class] section 54 K
example EDS files 63
keywords
Enhanced EDS, single connection 64, 66
Enhanced EDS, single connection, config data AssemN/AssemExaN 45, 53
65 Catalog 30
Minimum EDS 63 CfgAssembly 45
EZ-EDS authoring tool 5 CfgAssemblyExa 45
ClassN 35
ConnectionN 35, 53
CreateDate 29
F CreateTime 29
fields Descriptor 45
Data Size 50 EnumN 53
Data Type 49 GroupN 53
Decimal Precision 51 MajRev 34
Default Value 51 MinRev 34
Descriptor 48 ModDate 29
Help String 51 ModTime 29
International Engineering Units 51, 53 ParamN 47, 53
International Help String 51, 53 ProdName 30, 32, 53
International Parameter Name 51, 53 ProdTypeStr 33
Link (Multiplier, Divider, Base and Offset) 51 Revision 29
Link Path 48 VariantN/VariantExaN 47
Maximum Value 51 VendName 33
Minimum Value 51
Parameter Name 50
Scaling (Multiplier, Divider, Base and Offset) L
51 limitations of EDS AOP feature 4
Units String 51 literature, related 4
[File] section 29
Logix Designer
About Module Profile dialog box 18
G Advanced Network Configuration dialog box
26
general information, EDS files 5 and EDS files 4
General tab 17 Connection tab 21
Generic Device AOP 3 Custom Data Type dialog box 20
GroupN keyword 53 EDS Hardware Installation Tool 5
EDS icon files 7
[Groups] section 52 General tab 17
Internet Protocol tab 23
Module Definition dialog box 19
H Module Info tab 22
Help String field 44 Network tab 25
Port Configuration tab 24
Port Diagnostics dialog box 24
I Time Sync tab 26
icon files
guidelines 6 M
Logix Designer 7 MajRev keyword 34
For an additional level of technical phone support for installation, configuration, and troubleshooting, we offer
TechConnectSM support programs. For more information, contact your local distributor or Rockwell Automation
representative, or visit http://www.rockwellautomation.com/support/.
Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this
manual. You can contact Customer Support for initial help in getting your product up and running.
United States or Canada 1.440.646.3434
Outside United States or Canada Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html, or contact your local Rockwell
Automation representative.
Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the
manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.
United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your
distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.