Application Techniques
EDS AOP Guidelines for Logix Designer
Important User Information
Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety
Guidelines for the Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available from
your local Rockwell Automation® sales office or online at http://www.rockwellautomation.com/literature/) describes some
important differences between solid-state equipment and hard-wired electromechanical devices. Because of this difference,
and also because of the wide variety of uses for solid-state equipment, all persons responsible for applying this equipment
must satisfy themselves that each intended application of this equipment is acceptable.
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
Important User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About Module Profile dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module Definition dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module Info tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Internet Protocol tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Port Configuration tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Port Diagnostics dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced Network Configuration dialog box. . . . . . . . . . . . . . . . . . .
Time Sync tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
18
19
21
22
23
24
24
25
26
26
Chapter 4
EDS File Sections
[File] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Revision, CreateDate, CreateTime, ModDate and ModTime
keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Device] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Catalog and ProdName keywords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Catalog keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
29
29
30
30
30
1
Table of Contents
ProdName keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VendName keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ProdTypeStr keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MajRev keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MinRev keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Device Classification] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Connection Manager] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ConnectionN keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[ParamClass] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CfgAssembly keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CfgAssemblyExa keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Descriptor keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Assembly] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AssemN/AssemExaN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VariantN/VariantExaN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Params] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ParamN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Groups] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Internationalization] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ProdName keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ParamN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GroupN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AssemN/AssemExaN keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ConnectionN keyword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Modular] Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Ethernet Link Class] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[TCP/IP Interface Class] Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[DLR Class] Section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
[Time Sync Class] Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
33
33
34
34
35
35
35
35
45
45
45
45
45
45
47
47
47
52
52
53
53
53
53
53
53
54
54
55
56
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
Index
2
Minimum EDS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enhanced EDS, Single Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enhanced EDS, Single Connection, Configuration Data. . . . . . . . . . . . .
Enhanced EDS, Multiple Choice of Connections and Multiple
Simultaneous Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
63
64
65
66
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Chapter
1
Introduction
About this publication
Topic
Page
About this publication
3
General EDS file information
5
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.
Figure 1 - EDS device in Logix Designer
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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
3
Chapter 1
Introduction
• The Generic Device AOP requires minimal development time because it
uses the generic device user interface, but only specifies the basic
connection parameters (assembly instance and the size of the
Configuration, Input, and Output arrays). The module developer must
still create documentation describing the instance values and tag details. It
requires the user to manually enter often cryptic configuration parameters.
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.
Module developers should:
• 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.
• Be familiar with Module-Defined data types generated by AOPs.
The Logix Designer EDS AOP feature is limited to devices with a single CIP
port that attach to the Ethernet bus.
The following devices are not supported:
• Devices with one or more CIP ports and a non-CIP backplane
• Devices with more than one CIP port
• Safety devices
References
The following documents are referenced in or related to this document.
[1] THE CIP NETWORKS LIBRARY Volume 1, Common Industrial
Protocol (CIP™), Edition 3.11
[2] THE CIP NETWORKS LIBRARY Volume 2, EtherNet/IP Adaptation
of CIP, Edition 1.12
Definitions, Acronyms, and Abbreviations
The following definitions, acronyms, and abbreviations are used throughout this
document.
4
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Introduction
Chapter 1
Table 1 - Definitions, Acronyms, and Abbreviations
General EDS file information
Terms
Definition
EDS
Electronic Data Sheet. A text file that contains configuration data for specific device types. The EDS for a
device is provided by the device vendor and is required for compliance with ODVA standards.
AOP
Add-On Profile. Logix Designer component that can be separately installed and used for configuring one
or more modules.
EDS AOP
EDS Add-On Profile. The Add-On Profile that uses EDS content to construct the profile to support various
module types.
Profile
A subsystem of Logix Designer. Each supported module type has an associated profile. The profile
provides information needed to establish topology and module-defined data types, as well as graphical
user interface for configuration (in some cases).
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 file authoring tools
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 EZEDS, 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 file installation
EDS files are provided by the module vendor, and are deployed in one or more
ways:
• Embedded in the module as described in Section 5-42 (File Object) of
THE CIP NETWORKS LIBRARY Volume 1, Common Industrial
Protocol (CIP™), Edition 3.11.
• Provided on separate media, such as a CD-ROM.
• Downloaded from the module vendor website.
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
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
5
Chapter 1
Introduction
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.
To create icon files, follow the guidelines below:
• At a minimum you should create a 32x32 pixel, 16-color icon in the
Microsoft format.
6
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Introduction
Chapter 1
• For best results, you should define a:
• 16x16 16 color icon
• 32x32 16 color icon
• 48x48 256 color icon
All three icons must be stored in one icon file.
• 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.
Figure 2 - Icon horizontal placement
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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
7
Chapter 1
Introduction
Notes:
8
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Chapter
2
Creating an EDS file
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
structures and parameters
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
[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.
• In the EDS file, you can define a detailed assembly or a non-detailed
assembly.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
9
Chapter 2
Creating an EDS file
• 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.
Figure 3 - Input data structures in Logix Designer
Output tags
The values for Output tags are sent from the controller to the target module.
Figure 4 - Output data structures in Logix Designer
Defining I/O parameters
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 bitenumerated). Param2 corresponds to Data[0] and Data[1], Param3 corresponds
to Data[2] and Data[3] in Figure 5.
10
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Creating an EDS file
Chapter 2
Figure 5 - Output parameters in Logix Designer tags
The parameters are included in an assembly in the [Assembly] section:
Assem101 =
"Output Data",
,
,
0x0000,
,,
,Param2,
$ Output Commands parameter
,Param3;
$ Speed Reference parameter
… and the parameters are defined in the [Params] section:
Param2 =
0,
$ reserved, shall equal 0
,,
$ Link Path Size, Link Path
0x0000,
$ Descriptor
0xD2,
$ Data Type
2,
$ Data Size in bytes
"Output Commands", $ name
"",
$ units
"",
$ help string
,,0,
$ min, max, default data values
,,,,
$ mult, div, base, offset scaling
,,,,
$ mult, div, base, offset links
;
$ decimal places
Enum2 =
0,"Stop",
1,"Run",
2,"Reverse";
Param3 =
0,
$ reserved, shall equal 0
,,
$ Link Path Size, Link Path
0x0000,
$ Descriptor
0xC7,
$ Data Type
2,
$ Data Size in bytes
"Speed Reference", $ name
"rpm",
$ units
"",
$ help string
0,32767,0,
$ min, max, default data values
,,,,
$ mult, div, base, offset scaling
,,,,
$ mult, div, base, offset links
;
$ decimal places
Configuration data
structures and parameters
This section covers defining your module configuration data structures and
parameters, and how they are displayed in Logix Designer. In the EDS file, the
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
11
Chapter 2
Creating an EDS file
[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.
The configuration data structure defines the configurable parameters for a
module.
• The configuration tags may include descriptive tag names, as well as
individual tag data types that define individual configuration parameters.
• In the EDS file, you can define a detailed assembly or a non-detailed
assembly.
• The detailed assembly results in a detailed data type (this is highly
recommended).
• The non-detailed assembly only defines the size of the assembly, and
results in a non-detailed data type (see [Assembly] in [Assembly]
Section on page 45 and [Params] in [Params] Section on page 47).
• Type of configuration:
– The configuration is delivered using the Forward_Open service in the
Data Segment. The configuration data is described by the
ConnectionN entry.
Figure 6 - Configuration data structures in Logix Designer
12
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Creating an EDS file
Chapter 2
Defining configuration parameters
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).
Figure 7 - Configuration parameters in Logix Designer tags
The parameters are included in an assembly in the [Assembly] section:
Assem100 =
"Configuration Assembly",
,
,
0x0000,
,,
16,Param7,
$ Start Ramp parameter
16,Param8,
2,Param9,
$ Selection1 parameter
1,Param10,
5,,
8,Param11;
… and the parameters are defined in the [Params] section:
Param7 =
0,
$
,,
$
0x0000,
$
0xC7,
$
2,
$
"Start Ramp",
$
"ms",
$
"This is the value
1,10000,1000
$
,,,,
$
,,,,
$
;
$
reserved, shall equal 0
Link Path Size, Link Path
Descriptor
Data Type
Data Size in bytes
name
units
for the start ramp", $ help string
min, max, default data values
mult, div, base, offset scaling
mult, div, base, offset links
decimal places
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
13
Chapter 2
Creating an EDS file
Parameters can include bit-enumeration:
Param11 =
0,
$ reserved, shall equal 0
,,
$ Link Path Size, Link Path
0x0000,
$ Descriptor
0xD1,
$ Data Type
1,
$ Data Size in bytes
"Bitwise Selection", $ name
"",
$ units
"New Help String",
$ help string
,,0,
$ min, max, default data values
,,,,
$ mult, div, base, offset scaling
,,,,
$ mult, div, base, offset links
;
$ decimal places
Enum11 =
0,"Start",
1,"Stop",
2,"Reserved",
3,"Reserved",
4,"Not to be used",
5,"Not to be used",
6,"Not to be used",
7,"Not to be used";
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:
1. For non-English languages, Logix Designer automatically uses the
translated strings from the [Internationalization] section of the EDS file to
match the current language setting.
2. For English, or if there is no matching translated string, then Logix
Designer uses the English (“eng”) string from the [Internationalization]
section.
3. If there is no English string in the [Internationalization] section, Logix
Designer uses the default string from the original definition in the EDS
file.
[Internationalization]
Param7 =
{
2,
{"eng",0xD0,4,"Start Ramp"},
{"deu",0xD0,4,"Start-Rampe"}
},
{
2,
{"eng",0xD0,4,"ms"},
14
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Creating an EDS file
Chapter 2
{"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
See [Internationalization] Section on page 52 for more information.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
15
Chapter 2
Creating an EDS file
Notes:
16
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Chapter
3
Module Configuration Dialog Boxes
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).
• Name of parent module in the Logix Designer I/O tree.
• Name and description of device as it appears in Logix Designer (userconfigurable).
• Network addressing (see [Device Classification] Section on page 35 and
[Modular] Section on page 54.
• Revision, electronic keying information, and connection type (see Module
Definition dialog box on page 19).
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
17
Chapter 3
Module Configuration Dialog Boxes
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.
Figure 8 - General tab
About Module Profile 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:
• Logix Designer Module Profile Core version
• Module vendor (see VendName keyword on page 33)
• 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).
18
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Module Configuration Dialog Boxes
Chapter 3
Figure 9 - About Module Profile dialog box
Figure 10 - How to display the About Module Profile dialog box
Module Definition dialog box
The Module Definition dialog box allows you to configure the module details
and the Input/Output data to be transferred. Typically, when defining the
properties for a standard module, you can perform the following:
• 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 the electronic keying option.
• 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:
• Configure one or more additional connection settings (for example,
remote data, selectable assemblies, configurable sizes, or custom data
types).
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
19
Chapter 3
Module Configuration Dialog Boxes
• Select multiple, simultaneous connections (for those modules that support
them).
Click the Change button in the Module Properties dialog box to display this
dialog box (see Figure 12).
Figure 11 - Module Definition dialog box
Figure 12 - How to display the Module Definition dialog box
Custom Data Type dialog box
The Custom Data Type dialog box allows you to configure indirect Input/
Output parameters. The dialog box displays:
• The connection name (see ConnectionN keyword on page 35).
• 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).
20
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Module Configuration Dialog Boxes
Chapter 3
Figure 13 - Custom Data Type dialog box
Figure 14 - How to display the Custom Data Type dialog box
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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
21
Chapter 3
Module Configuration Dialog Boxes
Figure 15 - Connection tab
Module Info tab
22
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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Module Configuration Dialog Boxes
Chapter 3
Figure 16 - Module Info tab
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.
Figure 17 - Internet Protocol tab
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
23
Chapter 3
Module Configuration Dialog Boxes
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.
Figure 18 - Port Configuration tab
Click the […] button on the Port Configuration tab to display the Port
Diagnostics dialog box (see Figure 19).
Port Diagnostics dialog box
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.
24
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Module Configuration Dialog Boxes
Chapter 3
Figure 19 - Port Diagnostic 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.
Figure 20 - Network tab
Click the Advanced button on the Network tab to display the Advanced
Network Configuration dialog box (see Figure 21).
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
25
Chapter 3
Module Configuration Dialog Boxes
Advanced Network Configuration dialog box
The Advanced Network Configuration dialog box displays the Network
Supervisor Mode settings if the module is a Network Supervisor.
Click the Advanced button on the Network tab to display the Advanced
Network Configuration dialog box (see Figure 20).
Figure 21 - Advanced Network Configuration dialog box
Time Sync tab
26
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).
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Module Configuration Dialog Boxes
Chapter 3
Figure 22 - Time Sync tab
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
27
Chapter 3
Module Configuration Dialog Boxes
Notes:
28
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Chapter
4
EDS File Sections
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] Section
[File]
DescText = "Test EDS Description";
CreateDate = 01-14-2011;
CreateTime = 14:26:47;
ModDate = 12-23-2011;
ModTime = 11:55:27;
Revision = 1.0;
Revision, CreateDate, CreateTime, ModDate and ModTime keywords
The revision, creation, and modification information are displayed on the About
dialog box.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
29
Chapter 4
EDS File Sections
Figure 23 - Revision, Create and Modification on the “About” dialog box
[Device] Section
[Device]
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";
Catalog and ProdName keywords
The Catalog string, followed by the ProdName string, are concatenated for
display on the General Tab, Type field (Figure 8 on page 18). If the optional
Catalog keyword is not present, the value of the ProdName keyword is displayed
alone).
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.
30
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
Figure 24 - Catalog string on Select Module Type dialog box
IMPORTANT
Module developers should include the Catalog keyword.
The Catalog keyword should not contain spaces, because space characters
cause problems with the Path control on the Communication tab of the
Message Configuration dialog box (the Message Configuration dialog box is
invoked from the MSG instruction).
The Catalog keyword is included in Catalog Organizer, Data Types tree, ModuleDefined data type name. Alpha-numeric characters and the underscore (_)
character should be used. Other characters are removed, except dash (-), which
is converted to underscore (_).
The Catalog keyword value is displayed in the I/O Configuration tree module
entry in Controller Organizer.
Figure 25 - Catalog string in I/O Configuration tree
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
31
Chapter 4
EDS File Sections
ProdName keyword
The ProdName keyword value is displayed in the Description column of the
Catalog and Favorites tab of the Select Module Type dialog box.
Figure 26 - ProdName string on Catalog tab of Select Module Type dialog box
The ProdName keyword value is displayed in the Modules column on the
Module Discovery tab of the Select Module Type dialog box.
Figure 27 - ProdName string on Module Discovery tab of Select Module Type dialog box
32
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
VendName keyword
If an ODVA-defined vendor string is not known for the VendCode, the
VendName from the first EDS file registered for the VendCode is used;
otherwise, the ODVA-defined vendor string is used.
IMPORTANT
There is no mechanism to change VendName once it has been set by
registering the first EDS file with that VendName.
The VendName keyword value is displayed on the General Tab in the Vendor
field.
Figure 28 - Vendor string on General tab
The VendName keyword value is displayed in the Vendor column on the Catalog
and Favorites tabs of the Select Module Type dialog box.
Figure 29 - Vendor string on 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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
33
Chapter 4
EDS File Sections
Figure 30 - ProdTypeStr string on Select Module Type dialog box
If an ODVA-defined profile string is not known for publicly defined ProdType
values, the ProdTypeStr from the first EDS registered for the ProdType is used;
otherwise, the ODVA-defined profile name is used, see THE CIP NETWORKS
LIBRARY Volume 1, Common Industrial Protocol (CIP™), Edition 3.11, table 67.1.
For vendor-specific ProdType values, the ProdTypeStr from the first EDS
registered for the VendCode/ProdType is used.
IMPORTANT
There is no mechanism to change ProdTypeStr once it has been set by
registering the first EDS with that ProdTypeStr.
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).
34
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
[Device Classification]
Section
Chapter 4
[Device Classification]
Class1 = EtherNetIP;
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]
Section
[Connection Manager]
Connection1 =
0x04030002,
0x44640405,
Param1,,Assem101,
Param1,,Assem102,
,,
,Assem100,
"I/O Connection",
"",
"20 04 24 64 2C 65 2C 66";
$
$
$
$
$
$
$
O−>T RPI, size, format
T−>O RPI, size, format
proxy config size, format
target config size, format
Connection Name
help string
Path
Extra comment lines have been removed from this example.
ConnectionN keyword
The ConnectionN keyword identifies a CIP connection supported by the
module.
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 46, for rules describing connections that can exist together). All ExclusiveOwner 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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
35
Chapter 4
EDS File Sections
ConnectionN fields
Trigger and Transport field
• Transport class
Must indicate Class 1 support (may indicate others).
The Transport Class field value of the Transport Class and Trigger
parameter sent in the Forward_Open request is always set to 1.
• Trigger
The Trigger is displayed on the Input Trigger column of the Connection
tab of the Modules Properties dialog box. The trigger (Cyclic, Change of
State, or Application) is selected by a list control.
Figure 31 - Connection Input Trigger selection
The user-selected Input Trigger value is the Forward_Open Transport
Class and Trigger parameter.
• Application type
Must indicate one of Listen-Only, Input-Only or Exclusive-Owner.
Redundant-Owner is not supported.
• Direction
The Direction value is the Forward_Open Transport Class and Trigger
parameter, Dir field value. This is to be set to Client.
Connection Parameters field
• T→O and O→T fixed/variable size supported
The T→O and O→T fixed/variable size supported value must indicate
fixed size.
Fixed is the Forward_Open T→O and O→T Network Connection
parameters, Fixed/Variable field values.
36
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
• O→T Real time transfer format
Must indicate one of:
– Connection is pure data and modeless – the controller will not include
a 32 bit run/idle header
– Heartbeat – no application data
– 32 bit run/idle header – the controller will include a 32 bit run/idle
header.
• T→O Real time transfer format
Must indicate one of:
– Connection is pure data and modeless – a 32 bit run/idle header will
not be included in the Input Module-Defined data type/tag definition
– Heartbeat – no application data
– 32 bit run/idle header – a 32 bit run/idle header will be included in the
Input Module-Defined data type or tag definition.
• O→T Connection type
Must indicate POINT2POINT, may also specify NULL.
Point to Point is the Forward_Open O→T Network Connection
parameter, Connection Type field value.
• T→O Connection type
The T→O Connection type must indicate POINT2POINT or
MULTICAST; the T→O Connection type may indicate all connection
type values (POINT2POINT, MULTICAST and NULL).
Figure 32 - Connection Input Type selection
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 user selection of Point to Point or Multicast is the Forward_Open
T→O Network Connection parameter, Connection Type field value.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
37
Chapter 4
EDS File Sections
• T→O and O→T Connection types
The module can be reconfigured by a NULL Forward_Open service
(while the I/O connection is open) if the following conditions are true:
– Both T→O and O→T NULL connection types are indicated.
– The Write Allowed bit group in the configuration assembly descriptor
has a value of 0 (assembly may or may not be written when I/O
connection is open) or the Write Allowed bit group in the
configuration assembly descriptor has a value of 1 (assembly can be
written when any I/O connection is open).
A NULL Forward_Open service is sent when a MSG instruction, Module
Reconfiguration Message Type is executed.
• T→O and O→T Priority
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.
High or Scheduled (Scheduled if both are specified) is the Forward_Open
T→O and O→T Network Connection parameters, Priority field values.
T→O and O→T RPI fields
• If both fields are empty, the default RPI for the bus type will be selected
and the default range for the bus type will be enabled. For Ethernet bus
– minimum RPI is 1.0ms, maximum RPI is 3200.0ms, and default RPI
is 20.0ms.
If a UDINT value or ParamN is specified, the intersection of the T→O and
O→T value(s) and bus minimum and maximum values are used to generate the
minimum and maximum RPI values. If no intersection exists, no RPI value can
be chosen and as a consequence, the connection cannot be added via EDS AOP.
IMPORTANT
Enumerated ParamNs are not supported for RPIs.
The RPI is displayed in the RPI column on the Connection tab (page 21).
Figure 33 - Connection RPI selection
38
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
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.
T→O and O→T Size fields
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.
Figure 34 - Module Definition size selection
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.
T→O and O→T Format fields
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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
39
Chapter 4
EDS File Sections
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.
Proxy Config Size and Format fields
If not empty, the connection will be ignored.
Target Config Size field
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).
Target Config Format field
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.
40
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
Some configuration parameters are not included in the configuration ModuleDefined data type and tag. The parameters not included are:
• I/O assembly variant selectors – if a configuration parameter is an I/O
variant selector, the variant selections are displayed on the Module
Definition dialog box, Assembly column.
Figure 35 - Variant I/O assemblies on Module Definition dialog box
• I/O assembly variant selectors – if a configuration parameter is an I/O
variant selector, the variant selections are displayed on the Connections
control in the Module Definition group on the General Tab.
Figure 36 - Variant I/O assemblies in Module Definition group box
• Indirect I/O parameter – if a configuration parameter is an indirect
I/O parameter, the pointed to name is displayed on the Custom Data
Type dialog box (launched from Module Definition dialog box).
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
41
Chapter 4
EDS File Sections
Figure 37 - Indirect I/O parameters on Custom Data Type dialog box
• I/O size parameter – if a configuration parameter is used to specify a
variable I/O size, it is displayed on the Module Definition dialog box,
Size column.
Figure 38 - I/O size parameters on Custom Data Type dialog box
Connection Name String field
The Connection Name String is displayed on the Connections control in the
Module Definition group on the General Tab.
42
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
Figure 39 - Connection Name in Module Definition group
The Connection Name string is displayed on the Connections grid of the
Connection tab.
Figure 40 - Connection Name on Connection tab
The Connection Name string is displayed on Connections grid of the Module
Definition dialog box.
Figure 41 - Connection Name on Module Definition dialog box
TIP
It is recommended to limit name strings to 22 characters to allow display of the
chosen connection name without resizing the dialog box.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
43
Chapter 4
EDS File Sections
Help String field
Ignored.
Path field
The ConnectionN path field is the part of the Forward_Open Connection_Path
parameter immediately prior to the data segment (if a data segment exists) or at
the end of the Connection_Path parameter (if the data segment does not exist).
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.
Configuration application path
If a configured ConnectionN entry includes non-empty Target Config
size/format fields, then all other ConnectionN entries, which include a
different Configuration application path and non-empty Target Config
size/format fields, are not available to be added.
Originator to Target application path
If a configured ConnectionN entry specifies an O→T Real time transfer
format that is not heartbeat, then all other ConnectionN entries, which
include the same Originator to Target application path, are not available to
be added.
Target to Originator application path
If a configured ConnectionN entry specifies a T→O Real time transfer
format that is not heartbeat, then all other ConnectionN entries, which
include the same Target to Originator application path, are not available to
be added.
44
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
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.
The ConnectionN path field can contain symbols (ANSI_SYMBOL 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 tag value in
the Remote Data column.
[ParamClass] Section
CfgAssembly keyword
Ignored
CfgAssemblyExa keyword
Ignored
Descriptor keyword
Ignored.
[Assembly] Section
AssemN/AssemExaN keyword
Supported uses
• ConnectionN O→T Format – see ConnectionN keyword on page 35.
• ConnectionN T→O Format – see ConnectionN keyword on page 35.
• ConnectionN Target Config Format – see ConnectionN keyword on
page 35.
Nested assemblies
Assemblies can be nested. The result of nested assemblies will always be flat; no
nested structures will be displayed.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
45
Chapter 4
EDS File Sections
AssemN/AssemExaN fields
Name field
If this AssemN/AssemExaN is specified as a VariantExaN Selection Entry for a
variant specified for a ConnectionN T→O or O→T Format, then the name is
displayed on the Module Definition dialog box, Assembly column.
If this AssemN/AssemExaN is specified as a VariantExaN Selection Entry for a
variant specified for a ConnectionN T→O or O→T Format, then the name is
displayed on the General Tab, Module Definition group, Connections control.
Path field
Ignored
Size field
The Size field defines the size of the Assembly.
The Size field can be empty if the Member Size/Member Reference is provided
for all members.
Descriptor field
• Allow Value Edit bit field
If this AssemN/AssemExaN is specified as the ConnectionN T→O or
O→T Format and all AssemN/AssemExaN Member Reference fields are
empty, then the Module-Defined data type created will have a single data
member of type SINT, INT, DINT, or REAL array as chosen by the user
in the Module Definition dialog box.
If this AssemN/AssemExaN is specified as the ConnectionN Target
Config Format and all AssemN/AssemExaN Member Reference fields are
empty, then the Module-Defined data type created will have a single data
member of type SINT if the Allow Value Edit bit is set; otherwise this data
member is hidden.
• Assem Type bit field
Not supported.
• Not Addressable bit field
Not supported.
• Write Allowed bit field
If this AssemN/AssemExaN is specified as the ConnectionN Target
Config Format and the Write Allowed value is either 0 (write with I/O
connection may be allowed) or 1 (write with I/O connection is allowed)
46
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
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.
• Indirect Parameter Handling bit field
If this AssemN/AssemExaN is specified as the ConnectionN T→O or
O→T Format and indirect parameters exist in this AssemN/AssemExaN,
this value must be set to 0 (treat indirect parameters as indirect parameter).
If this AssemN/AssemExaN is specified as the ConnectionN Target
Config Format and indirect parameters exist in this AssemN/AssemExaN,
this value must be set to 1 (treat indirect parameters as direct parameter).
Member Size field
No EDS AOP specific handling.
Member Reference field
If this AssemN/AssemExaN is specified as the ConnectionN Target
Config Format, then this member is included in the configuration
Module-Defined data type.
If this AssemN/AssemExaN is specified as the ConnectionN T→O or
O→T Format, then the size of this member is included in the Input/
Output Module-Defined data type array size.
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.
The supported uses of the Variant/VariantExaN keywords are listed in the
description of the referencing keyword. See [Connection Manager] Section on
page 35, ConnectionN keyword and Target Config Format field description. See
also [Assembly] Section on page 45, AssemN/AssemExaN keyword, Name field
description.
[Params] Section
ParamN keyword
Input/Output/Configuration details uses
• ConnectionN O→T Format – see ConnectionN keyword on page 35.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
47
Chapter 4
EDS File Sections
• ConnectionN T→O Format – see ConnectionN keyword on page 35.
• ConnectionN Target Config Format – see ConnectionN keyword on page 35.
The ParamN name should follow Module-Defined data type member
name naming conventions, see Parameter Name field on page 50.
ParamN fields
Link Path field
Ignored.
Descriptor field
• Supports settable path
Ignored.
• Get_Enumerated_String Supported
Ignored.
Enumerations are supported as described in other parts of this
TIP
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.
48
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
• Not Addressable
Ignored.
• Save Supported
Ignored.
• Apply Supported
Ignored.
• Write Only Parameter
Ignored.
Data Type field
STIME, DATE_AND_TIME, STRING2, LTIME, STRINGN, TIME,
EPATH, ENGUNIT, and STRINGI types are not supported. The ParamN
entry is discarded and any keyword that specifies the ParamN entry as a field
value is discarded.
If ParamN is in a Configuration assembly, the data type determines the ModuleDefined data type member type:
• CIP BOOL type results in controller BOOL type.
• CIP SINT type results in controller SINT type.
• CIP INT type results in controller INT type.
• CIP DINT type results in controller DINT type.
• CIP LINT type results in 2 controller DINT types.
• CIP USINT type results in controller SINT type.(1)
• CIP UINT type results in controller INT type. (2)
• CIP UDINT type results in controller DINT type. (3)
•
•
•
•
•
•
•
•
•
•
•
CIP ULINT type results in 2 controller DINT types.(4)
CIP REAL type results in controller REAL type.
CIP LREAL type results in 64 controller BOOL types.
CIP DATE type results in controller INT type.
CIP TIME_OF_DAY type results in controller DINT type.
CIP STRING type results in array of controller SINT type. Note that
the length member will be hidden.
CIP BYTE type results in controller SINT type.
CIP WORD type results in controller INT type.
CIP DWORD type results in controller DINT type.
CIP LWORD type results in 2 controller DINT types.
CIP FTIME type results in controller DINT type.
(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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
49
Chapter 4
EDS File Sections
• CIP ITIME type results in controller INT type.
• CIP SHORT_STRING type results in array of controller SINT type.
Note that the length member will be hidden.
Data Size field
Follows the CIP specification. See THE CIP NETWORKS LIBRARY Volume 1,
Common Industrial Protocol (CIP™), Edition 3.11.
Parameter Name field
If the ParamN is a member of a Configuration assembly, the Parameter Name is
used as the Module-Defined data type member name. The Parameter Name is
converted to conform to the IEC 61131 name standard (alpha-numeric character
or underscore(_) character). 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. Parameter Names
should not include underscore and space characters.
These guidelines should be followed for Parameter Names that are included in
Configuration assemblies:
• Member names should be as short as practical. Users don’t want to type
ConfigDataBits when Data will suffice. Note that the user can infer much
from the context. Data appearing in an Input data type is obviously Input
data. Data from a discrete module is almost always represented as a bit.
The goal for Module-Defined data type member names is 15 characters or
less.
• 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.)
• Naming should be consistent. Refer to existing data types as a guide as
opposed to getting creative.
• Naming should not be redundant.
• Names should not reflect the data type.
• Naming of BOOLEAN members should be for the positive sense of the
member. Note that this requires the proper design of the device. Note also
that the on state is not necessarily the most interesting state.
• 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.
• In cases where it is desirable to have individual homogeneous bits named
(vs. indexed through a Data array), the individual bits should be prefixed
(not post fixed) with Pt followed by the 2 digit point number.
50
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
Units String field
Ignored
Help String field
Ignored
Minimum Value field
Ignored if the parameter is part of a Configuration assembly. If used in the
Module Definition dialog box, this field represents the minimum value that the
user can choose.
Maximum Value field
If in a Configuration assembly, used to determine if a parameter can be properly
represented. If used in the Module Definition dialog box, this field represents the
maximum value that can be chosen.
Default Value field
Used as defined in the CIP specification. See THE CIP NETWORKS LIBRARY
Volume 1, Common Industrial Protocol (CIP™), Edition 3.11.
Scaling (Multiplier, Divider, Base and Offset) fields
Ignored
Link (Multiplier, Divider, Base and Offset) fields
Ignored
Decimal Precision field
Ignored
International Parameter Name field
Ignored
International Engineering Units field
Ignored
International Help String field
Ignored
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
51
Chapter 4
EDS File Sections
ParamN enumeration, EnumN
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:
• Bit names should be as short as practical
• 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).
• Naming should be consistent (for example, Data and Status). If two
different modules return status, both should probably be named Status.
Refer to existing data types as a guide as opposed to getting creative.
• Naming should not be redundant. For example, O.On instead of
O.OutputOn.
• 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.
[Groups] Section
Ignored
[Internationalization]
Section
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
not specified, then the string from the non-Internationalization section version of
the keyword is used.
TIP
52
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.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
Chapter 4
ProdName keyword
If this ProdName is defined, it is used instead of the ProdName specified in the
[Device] section.
ParamN keyword
Ignored
International Parameter Name field
Ignored
International Engineering Units field
Ignored
International Help String field
Ignored
EnumN keyword
Ignored
GroupN keyword
Ignored
AssemN/AssemExaN keyword
Used only for assemblies selected by I/O variants. If the Internationalized
Assembly Name String is defined, it is used instead of the name defined in the
[Assembly] section in all cases.
ConnectionN keyword
If the Internationalized Connection Name String is defined, it is used instead of
the name defined in the [Connection Manager] section in all cases.
The Internationalized Connection Help String is not used.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
53
Chapter 4
EDS File Sections
[Modular] Section
Ignored.
[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 following entry keywords should be defined:
• Number_Of_Static_Instances
• MaxInst
• Either
• InterfaceLabelN
• [Params] section ParamN entries with Path value of 20 F6 24 NN 30
0A where NN is the Ethernet Link object instance. The default value of
this ParamN should be the interface label string.
TIP
If no interface label is specified, a default label is displayed, the
instance value.
The Port Configuration tab display is affected by these items.
The optional or conditional Ethernet Link object Interface Counters and Media
Counters attributes should be implemented.
Figure 42 - Port Configuration tab
54
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
[TCP/IP Interface Class]
Section
Chapter 4
If the module supports the TCP/IP Interface object, this section should exist.
The following entry keywords should be defined:
• [Params] section ParamN entry with Path value of 20 F5 24 01 30 02. The
default value of this ParamN should represent the TCP/IP object
capabilities for this module.
TIP
If no capability ParamN entry exists, the value of 0 is used for the TCP/
IP capabilities attribute.
The Internet Protocol tab is affected by this item.
Figure 43 - Internet Protocol tab
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
55
Chapter 4
EDS File Sections
[DLR Class] Section
The following entry keywords should be defined:
• [Assembly] section AssemN entry with Path value of 20 47 24 01 30 04.
• 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
The Network tab is displayed if this section exists.
Figure 44 - Network tab
56
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
EDS File Sections
[Time Sync Class] Section
Chapter 4
If the module supports the Time Sync object, this section should exist.
The Time Sync tab is displayed if this section exists.
Figure 45 - Time Sync tab
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
57
Chapter 4
EDS File Sections
Notes:
58
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Chapter
5
Description of Data Types and Tags
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 ModuleDefined Configuration, Input, and Output data type names, tag names, and
Module-Defined data type member names.
Module-Defined Data Type
Naming
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
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.
Figure 46 - Module-Defined Data Type Names
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
59
Chapter 5
Description of Data Types and Tags
A C/I/O Module Defined data type name is constructed from:
<Vendor>:<Catalog_Number>_<CRC>:<Tag_Type>:<Version>
• Vendor code: the 4-digit hex value assigned by ODVA.
• Catalog_Number String value:
The Catalog_Number String comes from the Catalog string from the EDS
file. Dash (-) characters are converted to underscore (_) characters and all
non-IEC-61131 characters are removed. If no Catalog string exists in the
EDS file the 4 digit hex ProdType and 4 digit hex ProdCode are used
separated by an underscore (_) character (for example: 0002_0006). The
Catalog_Number string is truncated to limit the Module-Defined data
type name length to 40 characters.
• CRC String value:
Generated from the Module-Defined data type contents, the details of this
algorithm will not be provided.
• Tag_Type String value:
• C
• I
• O
• Version String value:
Always 0
Tag Naming
Figure 47 - Tag Names
• Name on the Module Properties General tab is used:
• <Name>:<I or O>[<Ordinal>]
• <Name>:C
• The ordinal comes from the Module Definition dialog box, Tag Suffix
column. Ordinal only exists when more than one connection can be
configured.
60
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Description of Data Types and Tags
Chapter 5
Figure 48 - Module Definition, Tag Suffix column
Module-Defined Data Type
Member Naming
• Member names are truncated to 40 characters.
• Duplicate member names are made unique by appending an ordinal suffix.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
61
Chapter 5
Description of Data Types and Tags
Notes:
62
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Chapter
6
Example EDS Files
The following sections describe examples of EDS files and how these EDS files
translate into details in Logix Designer.
TIP
Minimum EDS
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.
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.
• Selection of Unicast and Multicast data production where appropriate and
offered by the EDS.
• Selection of Cyclic or Change-of-State trigger if offered by the EDS.
• Creation of an Input tag (for an Exclusive-Owner Connection, an InputOnly Connection, or a Listen-Only Connection) and possibly an Output
tag (only for an Exclusive-Owner Connection), depending on what is
offered in the EDS.
• Choice of SINT, INT, DINT, or REAL data structure for the I/O tags.
This sample EDS actually contains only an entry for an Exclusive-Owner
Connection. See the attached Minimal EDS.eds file for details.
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
63
Chapter 6
Example EDS Files
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:
Figure 49 - I/O tags for minimum EDS
Enhanced EDS, Single
Connection
To provide a better user experience, at least the following enhancements are
recommended:
• Range limitation for RPI
See the attached One Connection, IO Assemblies with Structures EDS.eds
file for details. The EDS file includes six parameters and two assemblies.
• Param1 limits the RPI range to values between 4.0 and 100.0ms with a
default value of 10.0ms
64
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Example EDS Files
Chapter 6
This is what this module looks like in Logix Designer:
Figure 50 - I/O tags for enhanced EDS
Enhanced EDS, Single
Connection, Configuration
Data
This EDS includes a configuration assembly structured into individual
parameters in addition to the features of the previous EDS. See the attached One
Connection, 3 Assemblies with Structures EDS.eds file for details.
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:
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
65
Chapter 6
Example EDS Files
Figure 51 - I/O and Configuration tags for enhanced EDS
Enhanced EDS, Multiple
Choice of Connections and
Multiple Simultaneous
Connections
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
connections:
• An Exclusive-Owner Connection (if the module has Output data).
• 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.
See the attached Multiple Connections 3 Assemblies with Structures EDS.eds
file for details.
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.
66
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Example EDS Files
Chapter 6
Figure 52 - Module Definition Dialog box and connection selection
If Logix Designer determines that there are multiple sets of ConnectionN entries,
a group of connections is created.
Figure 53 - Module Definition Dialog box with multiple connection configuration
Once a member of a group of connections has been chosen, further connections
can only be selected from ConnectionN entries outside that group.
Figure 54 - Module Definition Dialog box with multiple connections configured
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
67
Chapter 6
Example EDS Files
The tags created by multiple connections have numbers appended to make them
unambiguous.
68
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Index
Custom Data Type dialog box 20
D
A
abbreviations 4
About Module Profile dialog box 18
about this publication 3
acronyms 4
Advanced Network Configuration dialog box
26
AOP
definition 5
Generic Device 3
[Assembly] section 45
Configuration parameters 13
Input and Output parameters 11
AssemN/AssemExaN keyword 45, 53
Descriptor field 46
Name field 46
Path field 46
Size field 46
B
bit-enumerated parameters 10, 14
buses, supported 4
C
Catalog keyword 30
CfgAssembly keyword 45
CfgAssemblyExa keyword 45
CIP connections 9
ClassN keyword 35
Configuration
data structure 12
parameters 12, 13
tags 12
conformance testing 5
[Connection Manager] section 35
Connection Name String field 42
Connection Parameters field 36
Connection tab 21
ConnectionN keyword 35, 53
Connection Name String field 42
Connection Parameters field 36
Help String field 44
Path field 44
Proxy Config Size and Format fields 40
T−>O and O−>T Format fields 39
T−>O and O−>T RPI fields 38
T−>O and O−>T Size fields 39
Target Config Format field 40
Target Config Size field 40
Trigger and Transport fields 36
CreateDate keyword 29
CreateTime keyword 29
creating EDS files 3
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
data structures
Configuration 12
Input 9
Output 9
definitions
AOP 5
EDS 5
EDS AOP 5
profile 5
deploying EDS files 5
Descriptor field 46
Descriptor keyword 45
[Device] section 30
[Device Classification] section 35
devices
not supported 4
supported 4
[DLR Class] section 56
E
editing EDS files 5
EDS AOP
definition 5
feature limitations 4
EDS file sections
[Assembly] 45
[Connection Manager] 35
[Device Classification] 35
[Device] 30
[DLR Class] 56
[Ethernet Link Class] 54
[File] 29
[Groups] 52
[Internationalization] 52
[Modular] 54
[ParamClass] 45
[Params] 47
[TCP/IP Interface Class] 55
[Time Sync Class] 57
EDS files
and Logix Designer 4
creating 3
deploying 5
editing 5
Enhanced EDS, multiple connections 66
Enhanced EDS, single connection 64
Enhanced EDS, single connection, config data
65
examples 63
general information 5
icon files 6
internationalization 14
Minimum EDS 63
not available 6
registering 5
requirements for module developers 4
EDS Hardware Installation Tool
registering EDS files 5
warnings 6
EDS, definition 5
69
Index
Enhanced EDS, multiple connections file
example 66
Enhanced EDS, single connection file example
64
Enhanced EDS, single connection, config data
file example 65
enumeration
EnumN 52
parameter 10
parameters 13
ParamN 52
EnumN enumeration 52
EnumN keyword 53
[Ethernet Link Class] section 54
example EDS files 63
Enhanced EDS, single connection 64, 66
Enhanced EDS, single connection, config data
65
Minimum EDS 63
EZ-EDS authoring tool 5
F
fields
Data Size 50
Data Type 49
Decimal Precision 51
Default Value 51
Descriptor 48
Help String 51
International Engineering Units 51, 53
International Help String 51, 53
International Parameter Name 51, 53
Link (Multiplier, Divider, Base and Offset) 51
Link Path 48
Maximum Value 51
Minimum Value 51
Parameter Name 50
Scaling (Multiplier, Divider, Base and Offset)
51
Units String 51
[File] section 29
G
general information, EDS files 5
General tab 17
Generic Device AOP 3
GroupN keyword 53
[Groups] section 52
H
Help String field 44
I
icon files
guidelines 6
Logix Designer 7
70
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
icon files for EDS files 6
Input
data structures 9
parameters 10
tags 10
installing EDS files
See registering EDS files
[Internationalization] section 52
internationalization
EDS files 14
keywords 15
Internet Protocol tab 23
K
keywords
AssemN/AssemExaN 45, 53
Catalog 30
CfgAssembly 45
CfgAssemblyExa 45
ClassN 35
ConnectionN 35, 53
CreateDate 29
CreateTime 29
Descriptor 45
EnumN 53
GroupN 53
MajRev 34
MinRev 34
ModDate 29
ModTime 29
ParamN 47, 53
ProdName 30, 32, 53
ProdTypeStr 33
Revision 29
VariantN/VariantExaN 47
VendName 33
L
limitations of EDS AOP feature 4
literature, related 4
Logix Designer
About Module Profile dialog box 18
Advanced Network Configuration dialog box
26
and EDS files 4
Connection tab 21
Custom Data Type dialog box 20
EDS Hardware Installation Tool 5
EDS icon files 7
General tab 17
Internet Protocol tab 23
Module Definition dialog box 19
Module Info tab 22
Network tab 25
Port Configuration tab 24
Port Diagnostics dialog box 24
Time Sync tab 26
M
MajRev keyword 34
Index
Minimum EDS file example 63
MinRev keyword 34
ModDate and ModTime keywords 29
[Modular] section 54
Module Definition dialog box 19
module developers, requirements 4
Module Info tab 22
module-defined data types
member naming 61
naming 59
multiple languages
See internationialization
N
Name field 46
naming
module-defined data type members 61
module-defined data types 59
Network tab 25
[Params] section 47
configuration parameters 13
Input and Output parameters 11
Path field 44, 46
Port Configuration tab 24
Port Diagnostics dialog box 24
ProdName keyword 30, 32, 53
ProdTypeStr keyword 33
profile, definition 5
Proxy Config Size and Format fields 40
R
references 4
registering EDS files 5
related literature 4
requirements for module developers 4
Revision keyword 29
S
O
ODVA
conformance testing 5
EZ-EDS authoring tool 5
Output
data structues 9
parameters 10
tags 10
P
[ParamClass] section 45
parameters
bit-enumerated 10, 14
Configuration 12, 13
Input 10
Output 10
ParamN enumeration 52
ParamN keyword 47, 53
Data Size field 50
Data Type field 49
Decimal Precision field 51
Default Value field 51
Descriptor field 48
Help String field 51
International Engineering Units field 51, 53
International Help String field 51, 53
International Parameter Name field 51, 53
Link (Multiplier, Divider, Base and Offset)
fields 51
Link Path field 48
Maximum Value field 51
Minimum Value field 51
Parameter Name field 50
Scaling (Multiplier, Divider, Base and Offset)
fields 51
Units String field 51
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
sample EDS files See example EDS files
Size field 46
supported devices and buses 4
T
T−>O and O−>T Format fields 39
T−>O and O−>T RPI fields 38
T−>O and O−>T Size fields 39
tags
Configuration 12
Input 10
Output 10
Target Config Format field 40
Target Config Size field 40
[TCP/IP Interface Class] section 55
[Time Sync Class] section 57
Time Sync tab 26
translation
See internationalization
Transport field 36
Trigger field 36
U
unsupported devices 4
V
VariantN/VariantExaN keywords 47
VendName keyword 33
71
Index
72
Rockwell Automation Publication 1756-CO003A-EN-E - April 2012
Rockwell Automation Support
Rockwell Automation provides technical information on the Web to assist you in using its products.
At http://www.rockwellautomation.com/support, you can find technical manuals, technical and application notes, sample
code and links to software service packs, and a MySupport feature that you can customize to make the best use of these
tools. You can also visit our Knowledgebase at http://www.rockwellautomation.com/knowledgebase for FAQs, technical
information, support chat and forums, software updates, and to sign up for product notification updates.
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.
New Product Satisfaction Return
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/.
Publication 1756-CO003A-EN-E - April 2012
Copyright © 2012 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.