Professional Documents
Culture Documents
20comm Um015 - en P
20comm Um015 - en P
Allen-Bradley, Rockwell Software, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of Contents
Preface
7
7
8
8
Chapter 1
Getting Started
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compatible Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Required Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Equipment Shipped with the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . .
User-Supplied Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Safety Precautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11
12
13
13
13
13
15
16
Chapter 2
Installing the Adapter
EMC Conformance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Preparing for an Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the Web Pages Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting the Adapter to the Drive or SMC . . . . . . . . . . . . . . . . . . . . . .
Connecting the Adapter to the Network . . . . . . . . . . . . . . . . . . . . . . . . . . .
Applying Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Start-Up Status Indications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring and Verifying Key Drive Parameters. . . . . . . . . . . . . . . .
Commissioning the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
18
19
20
23
24
24
26
26
Chapter 3
Configuring the Adapter
Configuration Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the PowerFlex 7-Class HIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using an LED HIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using an LCD HIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using BOOTP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure the Adapter Using a BOOTP Server . . . . . . . . . . . . . . . . .
Setting the IP Address, Subnet Mask, and Gateway Address. . . . . . . . . .
Disable the BOOTP Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set an IP Address Using Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set a Subnet Mask Using Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set a Gateway Address Using Parameters . . . . . . . . . . . . . . . . . . . . . . .
Setting the Data Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the I/O Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selecting Master-Slave or Peer-to-Peer . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting a Master-Slave Hierarchy 36
Setting the Adapter to Transmit Peer-to-Peer Data . . . . . . . . . . . . .
Setting the Adapter to Receive Peer-to-Peer Data. . . . . . . . . . . . . . . .
Setting the Reference Adjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting a Fault Action. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rockwell Automation Publication 20COMM-UM015B-EN-P June 2013
27
28
28
28
29
29
32
32
32
33
33
34
35
36
37
38
41
41
3
Table of Contents
42
42
42
43
44
44
Chapter 4
Configuring the I/O
Chapter 5
Using the I/O
Chapter 6
4
Table of Contents
Chapter 7
Troubleshooting
143
144
145
145
145
146
146
149
Chapter 8
Viewing the Adapter Web Pages
153
153
154
155
156
156
157
157
158
159
159
160
160
160
161
161
162
165
Chapter 9
Using the Adapter in a DPI External
Comms Kit (20-XCOMM-DC-BASE)
Table of Contents
Appendix A
Specifications
Communications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Electrical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mechanical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Environmental . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regulatory Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
169
169
170
170
170
Appendix B
Adapter Parameters
Appendix C
EtherNet/IP Objects
182
182
183
184
185
188
189
190
190
196
198
204
206
207
209
211
213
Appendix D
Logic Command/Status Words
215
215
216
217
217
218
219
219
220
Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
6
Preface
Topic
Page
Additional Resources
This manual provides information about the adapter and using it with PowerFlex
7-Class (Architecture-Class) drives or Bulletin 150 SMC Soft Starters. The
adapter can be used with other products that support a DPI adapter, such as the
DPI External Comms Kit (20-XCOMM-DC-BASE). See the documentation
for your product for specific information about how it works with the adapter.
Rockwell Automation
Support
Rockwell Automation offers support services worldwide, with over 75 sales and
support offices, over 500 authorized distributors, and over 250 authorized
systems integrators located through the United States alone. In addition,
Rockwell Automation representatives are in every major country in the world.
Preface
Warranty support
Support service agreements
Additional Resources
Resource
Description
PowerFlex 7-Class DPI (Drive Peripheral Interface) Network Communication Adapter Installation Information on the installation of PowerFlex
20-COMM-x Network Communication Adapters.
Instructions, publication 20COMM-IN004
EtherNet/IP Media Planning and Installation Manual, ODVA publication 148 (1)
EtherNet/IP Network Infrastructure Guidelines, ODVA publication 35 (1)
Information on the use of the PowerFlex 20-HIM-A3, 20HIM-A5, 20-HIM-C3S, and 20-HIM-C5S HIMs.
PowerFlex 20-HIM-A6/-C6S HIM (Human Interface Module) User Manual, publication 20HIMUM001
Preface
Resource
Description
PowerFlex 700S w/Phase I Control Installation Manual (Frames 16), publication 20D-IN024
PowerFlex 700S w/Phase I Control Installation Manual (Frames 9 and 10), publication PFLEXIN006
PowerFlex 700S w/Phase I Control User Manual (All Frame Sizes), publication 20D-UM001
PowerFlex 700S w/Phase I Control Reference Manual, publication PFLEX-RM002
PowerFlex 700S w/Phase II Control Installation Manual (Frames 16), publication 20D-IN024
PowerFlex 700S w/Phase II Control Installation Manual (Frames 914), publication PFLEXIN006
PowerFlex 700S w/Phase II Control Programming Manual (All Frame Sizes), publication 20DPM001
PowerFlex 700S w/Phase II Control Reference Manual, publication PFLEX-RM003
Getting Results with RSLinx Guide, publication LINX-GR001and online help (1)
RSLogix Emulate 5/500 Getting Results Guide, publication EMULAT-GR002 and online help
RSLogix 500 Getting Results Guide, publication LG500-GR002 and online help (1)
RSLogix 5000 PIDE Autotuner Getting Results Guide, publication PIDE-GR001 and online help Information on using RSLogix 5000 software tool.
(1)
Enhanced and Ethernet PLC-5 Programmable Controllers User Manual, publication 1785UM012
(1)
Preface
Notes:
10
Chapter
Getting Started
The adapter is intended for installation in a PowerFlex 7-Class drive or Bulletin
150 SMC soft starter and is used for network communication.
Topic
Page
Components
11
Features
12
Compatible Products
13
Required Equipment
13
Safety Precautions
15
Quick Start
16
Components
Item
Part
Description
Status Indicators
Four status indicators that indicate the status of the DPI, the
adapter, and network connection. See Chapter 7, Troubleshooting.
DPI Connector
Ethernet Connector
Enables or disables the adapter web pages. See Setting the Web
Pages Switch on page 19.
Address/mode
switches
11
Chapter 1
Features
Getting Started
12
Getting Started
Compatible Products
Chapter 1
At the time of publication, the adapter is compatible with the following products:
PowerFlex 70/70EC drives
PowerFlex 700L drives
PowerFlex 700/700VC drives
PowerFlex Digital DC drives
PowerFlex 700H drives
DPI External Comms Kit
PowerFlex 700S drives
SMC-50
PowerFlex 7000/7000-2 drives
SMC Flex
Note: The adapter is not compatible with PowerFlex 750 series drives.
Required Equipment
Some of the equipment that is required for use with the adapter is shipped with
the adapter, but some you must supply yourself.
User-Supplied Equipment
To install and configure the adapter, you must supply the following:
A small flathead screwdriver
Ethernet cable (for details, see the EtherNet/IP Media Planning and
Installation Manual, ODVA publication 148 available on the ODVA
website at http://odva.org/Home/ODVATECHNOLOGIES/
EtherNetIP/EtherNetIPLibrary/tabid/76/Default.aspx)
Ethernet switch (for details, see the Ethernet Design Considerations
Reference Manual, publication ENET-RM002)
Configuration tool, such as the following:
PowerFlex 20-HIM-xx HIM
13
Chapter 1
Getting Started
14
Getting Started
Safety Precautions
Chapter 1
15
Chapter 1
Getting Started
Quick Start
This section is provided to help experienced users quickly start using the adapter.
If you are unsure how to complete a step, refer to the referenced chapter.
Step Action
See
Chapter 2,
Installing the Adapter
Chapter 2,
Installing the Adapter
16
Chapter 3,
Configuring the Adapter
Chapter 4,
Configuring the I/O
Chapter 5,
Using the I/O
Chapter 6,
Using Explicit
Messaging
Chapter
This chapter provides instructions for installing the adapter in a PowerFlex 7Class drive.
EMC Conformance
Topic
Page
18
19
20
23
Applying Power
24
26
For all PowerFlex 70 and 700 drive installations that require CE conformance per
EN61800-3, a ferrite core must be installed on each EtherNet/IP cable connected
to the drive.
These ferrites are not required for installation on SMC products.
A ferrite core such as FAIR-RITE part number 2643803802 needs to be installed
according to the following diagram.
Note: the cable is wrapped 4 times around each core.
Figure 1 - Ferrite Core Installation
17
Chapter 2
Preparing for an
Installation
18
Chapter 2
See Appendix A for the number of CIP connections supported by the 20COMM-ER adapter.
Verify that you have all required equipment. See Required Equipment on
page 13.
To use the adapter web pages, the Web Pages Switch must be set to its Enable
Web position. For information to enable or disable web pages for an adapter, see
Setting Web Access Control on page 42.
ATTENTION: Risk of equipment damage exists. The adapter contains
electrostatic discharge (ESD) sensitive parts that can be damaged if you do
not follow ESD control procedures. Static control precautions are required
when handling the adapter. If you are unfamiliar with static control
procedures, see Guarding Against Electrostatic Damage, publication 80004.5.2.
Web Pages
Switch
O
N
Up Position =
Disable
Down Position =
Enable
Setting
Description
Up (ON) position
19
Chapter 2
20
Chapter 2
20-COMM-ER Adapter
SMC-50
SMC Flex
X2
X1
Place ground
wire tab
between
mounting
screw and
circuit board
Description
DPI Connector
Ethernet cable
21
Chapter 2
Adapter
Internal Interface Cable
folded behind the adapter
and in front of the drive.
Ground Tab Detail
0.9 Nm
(8.0 lbin)
Verify metal ground tab is bent 90 and
is under the adapter before tightening
screw. After tightening the screw,
verify continuity exists between the
head of the screw and drive ground.
PowerFlex 700 Frames 0 and 1
PowerFlex 700S Frames 0 and 1
(Adapter mounts on door.)
X2
X1
0.9 Nm
(8.0 lbin)
4 Places
Verify metal ground tab is bent 90 and is under
the adapter before tightening screw. After
tightening the screw, verify continuity exists
between the head of the screw and drive ground.
PowerFlex 700H Frames 9 and Larger
PowerFlex 700S Frames 9 and Larger
(Adapter mounts behind HIM panel.)
22
Chapter 2
To other
EtherNet/IP
networks
Drive or SMC(1)
(with 20-COMM-ER Option Modules)
Controller
(ControlLogix controller
shown with 1756-EN2TR Bridge)
Computer with
Ethernet Connection
Ethernet
Switch
(1)
Drive or SMC(1)
(with 20-COMM-ER Option Modules)
Controller
(ControlLogix controller
shown with 1756-EN2TR Bridge)
1783-ETAP
1783-ETAP
Computer with
Ethernet Connection
(1)
4. For Linear or DLR Network Topology, route the other end of the Ethernet
cable from the network through the bottom of the first drive, and insert its
cable plug into the option module ENET1 network port.
Rockwell Automation Publication 20COMM-UM015B-EN-P - July 2013
23
Chapter 2
Applying Power
Install the device cover or close the drive door, and apply power to the device. The
adapter receives its power from the connected device. When you apply power to
the adapter for the first time, its topmost PORT status indicator should be steady
green or flashing green after an initialization. If it is red, there is a problem. See
Chapter 7, Troubleshooting.
LS1
LS2
STS
24
Chapter 2
Name
Color
State
Description
Drive STS Indicator
Flashing
Steady
Flashing,
device stopped
An inhibit condition exists the drive cannot be started. Check device Parameter 214 - [Start
Inhibits].
Flashing,
device running
An intermittent type 1 alarm condition is occurring. Check device Parameter 211 - [Drive Alarm 1].
Steady,
device running
A continuous type 1 alarm condition exists. Check device Parameter 211 - [Drive Alarm 1].
Flashing
Steady
Off
Steady
No power
Orange
Flashing
Steady
Flashing
Steady
Flashing
Steady
Green/
Red
Flashing
Off
Steady
No power OR no IP Address
Green
Flashing
An IP address is configured, but no CIP connections are established, and an Exclusive Owner
connection has not timed out
Steady
At least one CIP connection (any transport class) is established, and an Exclusive Owner
connection has not timed out
Flashing
Connection has timed out see the The EtherNet Adaptation of CIP Specification sections 9-4.4
for detailed behavior description
Steady
Orange
Steady
Green/
Red
Flashing
Self-test on power up
Off
Steady
No Network Activity
Green
Flashing
Yellow
Flashing
Off
Steady
No Network Activity
Green
Flashing
Yellow
Flashing
Red
PS
Green
Red
NS
Red
LS1
LS2
After verifying correct operation, close or install the drive cover. For more details
on status indicator operation, see page 144 and page 145.
25
Chapter 2
To commission the adapter, you must set a unique IP address on the network.
After installing the adapter and applying power, you can set the IP address by
using a BOOTP/DHCP server or adapter parameters. See Setting the IP
Address, Subnet Mask, and Gateway Address on page 32 for details.
By default, the adapter is configured so that you must set the IP address using a
BOOTP/DHCP server or by setting the adapter to a valid address, 1-254, via the
rotary switches on the adapter. An invalid address 0 or >254 will cause the
module to defer to the addressing mode selected by parameter 3 [BOOTP/
DHCP]. If disabled, the adapter will use the address information stored in the
adapters database. If that address is invalid, the adapter will try to contact a
DHCP server on the network. To use adapter parameters, you must disable the
BOOTP feature. For details, see Disable the BOOTP Feature on page 32.
Important: New settings for some adapter parameters (for example,
Parameters 04 - [IP Addr Cfg 1] through 07 - [IP Addr Cfg
4]) are recognized only when power is applied to the adapter or
it is reset. After you change parameter settings, cycle power or
reset the adapter.
26
Chapter
This chapter provides instructions and information for setting the parameters in
the adapter.
Topic
Page
Configuration Tools
27
28
Using BOOTP
29
32
34
35
36
41
41
42
43
44
44
Configuration Tools
The adapter stores parameters and other information in its own nonvolatile
storage (NVS) memory. You must, therefore, access the adapter to view and edit
its parameters. The following tools can be used to access the adapter parameters.
Tool
See
page 28
BOOTP/DHCP server
page 29
http://www.ab.com/support/abdrives/webupdate/
software.html, or online help (installed with the software)
27
Chapter 3
If your drive has either an LED or LCD HIM (Human Interface Module), it can
be used to access parameters in the adapter as shown below. It is recommended
that you read through the steps for your HIM before performing the sequence.
For additional information, see the drive documentation or the PowerFlex 7Class HIM Quick Reference, publication 20HIM-QR001.
Example Screens
1. Press the
key and then the Device
display the Device Screen.
ALT
Sel
(Sel) key to
2. Press the
or
key to scroll to the adapter. Letters
represent files in the drive, and numbers represent ports. The
adapter is usually connected to port 5.
3. Press the
(Enter) key to enter your selection. A
parameter database is constructed, and then the first
parameter is displayed.
4. Edit the parameters using the same techniques that you use to
edit drive parameters.
Example Screens
or
key to scroll to
2. Press the
3. Press the
COMM-ER).
or
4. Press the
F-> Stopped
Auto
0.00
Hz
Main Menu:
Diagnostics
Parameter
Device Select
Port 5 Device
20-COMM-ER
Main Menu:
Diagnostics
Parameter
Device Select
NOTE: All configuration procedures throughout this chapter use the PowerFlex
7-Class LCD HIM to access parameters in the adapter and show example LCD
HIM screens.
TIP
When using a PowerFlex 20-HIM-A6 or 20-HIM-C6S HIM, see its User Manual,
publication 20-HIM-UM001.
SMC Flex controllers require an external HIM (A3 or A6) to program the
adapter. The internal Human Interface of the SMC Flex does not allow
programming of the Adapter.
28
Using BOOTP
Chapter 3
The IP address, subnet mask and gateway address can be configured multiple
ways depending on the setting of the three rotary switches on the adapter. The
switches are read on power up or reset.
1. If the switches are set to an address from 1254, that value will be used as
the LSB of the IP address 192.168.1.xxx
2. If the switches are set to an invalid number (000 or a value greater than
254), the unit will check if DHCP is enabled. If DHCP is enabled, the
unit requests an address from a DHCP server.
If DHCP is not enabled and switches are set to an illegal value, the adapter
will use the IP address (along with other TCP configurable parameters)
stored in nonvolatile memory. If the unit finds that the stored IP
configuration is not usable (set to 0), then the unit will revert to the out-ofbox behavior of DHCP being enabled.
3. Any other switch setting will cause the adapter to use the IP address data
set in the adapter's database parameters.
By default, the adapter is configured so that you can set its IP address, subnet
mask, and gateway address by using a BOOTP or a DHCP server. There is a
variety of BOOTP servers available. The following instructions use Rockwell
Automations BOOTP Server, version 2.3 or later, a free standalone program that
incorporates the functionality of standard BOOTP utilities with a graphical
interface. It is available from http://www.software.rockwell.com/support/
download/detail.cfm?ID=3390. See the Readme file and online Help for
directions and more information.
TIP
If desired, you can disable BOOTP and configure the IP address, subnet mask, and
gateway address with adapter parameters. For details, see Setting the IP Address,
Subnet Mask, and Gateway Address on page 32.
29
Chapter 3
3. Select Tools > Network Settings to display the Network Settings window.
Type
Subnet Mask
Gateway
(1)
(1)
Primary DNS
The address of the primary DNS server to be used on the local end of
the link for negotiating with remote devices.
Secondary DNS
Domain Name
Chapter 3
Type
IP Address
Host Name
Optional
Description
Optional
To enable BOOTP for an adapter that has had BOOTP disabled, first select the
adapter in the Relation List, then click Enable BOOTP, and lastly reset the adapter
or power cycle the drive.
31
Chapter 3
By default, the adapter is configured so that you set its IP address, subnet mask,
and gateway address using a BOOTP/DHCP server. To use adapter parameters
instead, you must disable BOOTP/DHCP and then set the associated adapter
parameters.
The IP address can be set using the rotary switches on the adapter to an address
from 1254 that will be used as the lower byte of the IP address 192.168.1.xxx.
The Subnet mask will be set to 255.255.255.0.
If the rotary switches are set to any invalid address (0 or >254), the address
programmed in the adapter's internal data base will be used.
Value
0
1
Setting
Disabled
Enabled (Default)
Note: The internal port used by the adapter is different for different
products. The examples here show port 5, used by the SMC Flex and drive
products. The SMC-50 uses port 4.
2. Reset the adapter; see Resetting the Adapter on page 43.
After disabling the BOOTP/DHCP feature, you can then configure the
IP address, subnet mask, and gateway address using adapter parameters.
32
Chapter 3
2. Set the value of Parameters 04 - [IP Addr Cfg 1] through 07 - [IP Addr
Cfg 4] to a unique IP address.
Port 5 Device
20-COMM-ER
Parameter #: 04
IP Addr Cfg 1
0
Default = 0.0.0.0
0 <> 255
255.255.255.255
Default = 0.0.0.0
0 <> 255
255.255.255.255
[Subnet Cfg 1]
[Subnet Cfg 2]
[Subnet Cfg 3]
[Subnet Cfg 4]
Default = 0.0.0.0
0 <> 255
255.255.255.255
[Gateway Cfg
[Gateway Cfg 2]
[Gateway Cfg 3]
[Gateway Cfg 4]
33
Chapter 3
By default, the adapter is set to autodetect, so it automatically detects the data rate
and duplex setting used on the network. If you need to set a specific data rate and
duplex setting, the value of Parameter 16 - [EN P1 Rate Config] determines the
Ethernet data rate and duplex setting that the adapter will use to communicate. For
definitions of data rate and duplex, see Glossary on page 221.
1. Set the value of Parameter 16 - [EN P1 Rate Config] to the data rate at
which your network is operating.
Port 5 Device
20-COMM-ER
Parameter #: 16
EN P1 Rate Config
0
Autodetect
TIP
Value
0
1
2
3
4
Data Rate
Autodetect (default)
10 Mbps Full
10 Mbps Half
100 Mbps Full
100 Mbps Half
Auto detection of baud rate and duplex works properly only if the device (usually a
switch) on the other end of the cable is also set to automatically detect the baud
rate/duplex. If one device has the baud rate/duplex hard-coded, the other device
must be hard-coded to the same settings.
TIP
Value
0
1
2
3
4
Data Rate
Autodetect (default)
10 Mbps Full
10 Mbps Half
100 Mbps Full
100 Mbps Half
Auto detection of baud rate and duplex works properly only if the device (usually a
switch) on the other end of the cable is also set to automatically detect the baud
rate/duplex. If one device has the baud rate/duplex hard-coded, the other device
must be hard-coded to the same settings.
34
Chapter 3
The I/O configuration determines the data that is sent to and from the drive.
Logic Command/Status, Reference/Feedback, and Datalinks may be enabled or
disabled. (Datalinks allow you to read/write directly to parameters in the drive
using implicit I/O.) A 1 enables the I/O and a 0 disables the I/O.
1. Set the bits in Parameter 25 - [DPI I/O Cfg].
Port 5 Device
20-COMM-ER
Parameter #: 25
DPI I/O Cfg
xxxxxxxxxxx0 0 0 0 1
Cmd/Ref
b00
Bit
0
1
2
3
4
515
Description
Logic Command/Reference (Default)
Datalink A
Datalink B
Datalink C
Datalink D
Not Used
35
Chapter 3
Selecting Master-Slave or
Peer-to-Peer
A hierarchy determines the type of device with which the adapter exchanges data.
In a Master-Slave hierarchy, the adapter exchanges data with a master, such as a
scanner or bridge (1756-ENBT, 1756-EN2T, 1747-L5-xxx, and so forth). In a
Peer-to-Peer hierarchy, the adapter exchanges data with one or more EtherNet/IP
adapters in other devices. (The devices must have compatible Logic Command/
Status words.)
For both Master-Slave and Peer-to-Peer hierarchies, the devices exchanging data
must be on the same IP subnet. See IP Addresses in the for information about
IP subnets.
Bit
0
1
2
3
4
515
Description
Logic Command/Reference (Default)
Datalink A Input
Datalink B Input
Datalink C Input
Datalink D Input
Not Used
Bit
0
1
2
3
4
515
Description
Status/Feedback (Default)
Datalink A Output
Datalink B Output
Datalink C Output
Datalink D Output
Not Used
36
Chapter 3
The adapter is ready to receive I/O from the master (that is, scanner). You must
now configure the scanner to recognize and transmit I/O to the adapter. See
Chapter 4, Configuring the I/O.
Value
0
1
Setting
Off (Default)
On
Value
0
1
25
69
Description
Off (Default)
Logic Command/Reference
Datalink A, B, C, or D Input
Datalink A, B, C, or D Output
Value
0
1
25
69
Description
Off (Default)
Logic Command/Reference
Datalink A, B, C, or D Input
Datalink A, B, C, or D Output
37
Chapter 3
Port 5 Device
20-COMM-ER
Parameter #: 55
Peer Out Skip
2
Default = 10.00 s
1 <>16
Default = 1
Value
0
1
Setting
Off (Default)
On
38
Chapter 3
0 <> 255
IP Address of Node
255.255.255.255
Transmitting Peer I/O
[Peer Inp Addr 1]
[Peer Inp Addr 2]
[Peer Inp Addr 3]
[Peer Inp Addr 4]
Default = 0.0.0.0
3. Set Parameter 40 - [Peer A Input] to select the destination of the data that
is input to the drive as Peer A.
Port 5 Device
20-COMM-ER
Parameter #: 40
Peer A Input
1
Cmd/Ref
Value
0
1
25
Description
Off (Default)
Logic Command/Reference
Datalink A, B, C, or D Input
Data is used from the least significant word in the event of a mismatch in
Reference or Datalink sizes.
4. If desired, set Parameter 41 - [Peer B Input] to select the destination of
the data to input to the device as Peer B.
Port 5 Device
20-COMM-ER
Parameter #: 41
Peer B Input
2
DL A Input
Value
0
1
25
Description
Off (Default)
Logic Command/Reference
Datalink A, B, C, or D Input
5. If the adapter receives a Logic Command, set the bits in Parameter 42 [Peer Cmd Mask] that the device should use.
The bit definitions for the Logic Command word will depend on the
drive to which the adapter is connected. See Appendix D or the device
documentation.
Port 5 Device
20-COMM-ER
Parameter #: 42
Peer Cmd Mask
0000000000000000
Bit 0
B00
Value
0
1
Description
Ignore this command bit. (Default)
Use this command bit.
If the adapter receives a Logic Command from both a master device and a
peer device, each command bit must have only one source. The source of
command bits set to 0 will be the master device. The source of command
bits set to 1 will be the peer device.
39
Chapter 3
6. Reset the adapter (see Resetting the Adapter on page 43) so that changes to
Parameter 42 - [Peer Cmd Mask] take effect.
7. Set Parameter 48 - [Peer Inp Timeout] to the maximum amount of time
the adapter will wait for a message before timing out.
Important: This value must be greater than the product of Parameter
54 - [Peer Out Time] multiplied by Parameter 55 - [Peer
Out Skip] in the adapter from which you are receiving I/O.
For example, if the value of Parameter 54 - [Peer Out Time] is 2.00
seconds and the value of Parameter 55 - [Peer Out Skip] is 2 (see
example screen in step 4 on page 37), then Parameter 48 - [Peer Inp
Timeout] needs to have a value greater than 4.00, such as 5.00 in the
example screen below.
Port 5 Device
20-COMM-ER
Parameter #: 48
Peer Inp Timeout
5.00
s
0.01 <> 10.00
Default = 10.00 s
8. Set Parameter 43 - [Peer Flt Action] to the action that the adapter will
take if it times out.
ATTENTION: Risk of injury or equipment damage exists. Parameter 43 [Peer Flt Action] lets you determine the action of the adapter and
connected device if peer communication is disrupted. By default, this
parameter faults the device. You can set this parameter so that the device
continues to run, however, precautions should be taken to ensure that the
setting of this parameter does not create a hazard of injury or equipment
damage. When commissioning the device, verify that your system responds
correctly to various situations (for example, a disconnected cable).
Port 5 Device
20-COMM-ER
Parameter #: 43
Peer Flt Action
0
Fault
Value
0
1
2
3
4
Description
Fault (Default)
Stop
Zero Data
Hold Last
Send Flt Cfg
40
Chapter 3
A Reference Adjustment is a percent scaling factor for the Reference from the
network. It can be set from 0.00200.00% to allow the drives Reference to either
match the network Reference (= 100.00%), scale below the network Reference
(< 100.00%), or scale above the network Reference (> 100.00%).
The SMC controllers do not currently use the reference data sent in the IO frame.
No Reference configuration is required. Refer to the applicable SMC user manual
for the latest reference configuration information.
ATTENTION: To guard against equipment damage and/or personal injury,
note that changes to adapter Parameter 39 - [Ref Adjust] take effect
immediately. A drive receiving its Reference from the adapter will receive
the newly scaled Reference, resulting in a change of speed.
Default = 100.00%
41
Chapter 3
Action
Description
Fault
Stop
Zero Data
The device is sent 0 for output data. This does not command a stop.
Hold Last
The device is sent the data that you set in the fault configuration
parameters (Parameters 27 - [Flt Cfg Logic] through 36 - [Flt Cfg D2
In]).
Port 5 Device
20-COMM-ER
Parameter #: 23
Comm Flt Action
0
Fault
Port 5 Device
20-COMM-ER
Parameter #: 24
Idle Flt Action
0
Fault
Description
Important: If the device uses a 16-bit Reference or 16-bit Datalinks, the most
significant word of the value must be set to zero (0) or a fault will occur.
42
By using a web browser to access the IP address set for the adapter, you can view
the adapters web pages for information about the adapter, its connected device,
and other DPI devices connected to the device, such as HIMs or converters.
Additionally, the adapter can be configured to automatically send e-mail messages
Rockwell Automation Publication 20COMM-UM015B-EN-P - July 2013
Chapter 3
to desired addresses when selected device faults occur and/or are cleared, and/or
when the adapter takes a communication or idle fault action. For more details on
the adapters web pages, refer to Chapter 8, Viewing the Adapter Web Pages.
By default, the adapter web pages are disabled. See Figure 2 and set the Web Pages
Switch (SW4) to the Enable Web (up) position. Parameter 56 [Web Enabled]
reflects the position of the web enable DIP switch on the adapter.
Important: For a change to the switch setting to take effect, the adapter
must be reset (see Resetting the Adapter on page 43).
Bit 0 of Parameter 57 - [Web Features] is used to protect the configured settings
for e-mail messaging. By default, settings are not protected and the user can make
changes. To protect the configured settings, set the value of E-mail Cfg Bit 0 to 0
(Disabled). You can unprotect the configuration by changing Bit 0 back to 1
(Enabled). E-mail messaging will always remain active regardless of whether or
not its settings are protectedunless e-mail messaging was never configured. For
more information about configuring adapter e-mail messaging or to stop e-mail
messages, see Email Configuration Link on page 162.
Port 5 Device
20-COMM-ER
Parameter #: 57
Web Features
xxxxxxxxxxxxxxx 1
E-mail Cfg
b00
Bit
0
17
Description
E-mail Cfg (Default = 0 = Disabled)
Not Used
Changes to switch settings and some adapter parameters require that you reset
the adapter before the new settings take effect. You can reset the adapter by power
cycling the drive or by using Parameter 22- [Reset Module].
ATTENTION: Risk of injury or equipment damage exists. If the adapter is
transmitting control I/O to the drive, the drive may fault when you reset the
adapter. Determine how your drive will respond before resetting a
connected adapter.
Value
0
1
2
Description
Ready (Default)
Reset Module
Set Defaults
43
Chapter 3
When you enter 1 (Reset Module), the adapter will be immediately reset. When
you enter 2 (Set Defaults), the adapter will set all adapter parameters to their
factory-default values. After performing a Set Defaults, enter 1 (Reset Module)
so that the new values take effect. The value of this parameter will be restored to
0 (Ready) after the adapter is reset.
The following parameters provide information about the status of the adapter.
You can view these parameters at any time.
Parameter
Description
20 - [Ref/Fdbk Size]
21 - [Datalink Size]
The size of the Datalinks. It will either be 16 bits or 32 bits. It is set in the
device and the adapter automatically uses the correct size.
Not Used
Not Used
Not Used
Datalink D
Datalink C
Datalink B
Datalink A
Cmd/Ref
x x x 0 0 0 0 1
7 6 5 4 3 2 1 0
0 = I/O disabled
1 = I/O enabled
The adapter firmware can be updated over the network or serially through a
direct connection from a computer to the drive using a 1203-USB or 1203-SSS
serial converter.
When updating firmware over the network, you can use the Allen-Bradley
ControlFLASH software tool, the built-in update capability of DriveExplorer
Full software, or the built-in update capability of DriveExecutive software.
When updating firmware through a direct serial connection from a computer to a
drive, you can use the same Allen-Bradley software tools described above, or you
can use terminal emulation software set to the X-modem protocol.
If using a direct serial connection, you can use DriveExplorer Lite software.
44
Chapter 3
45
Chapter 3
46
Chapter
Topic
Page
47
48
68
RSLinx Classic software, in all its variations (Lite, Gateway, OEM, and so forth),
is used to provide a communication link between the computer, network, and
controller. RSLinx Classic software requires its network-specific driver to be
configured before communication is established with network devices. To
configure the RSLinx driver, follow this procedure.
1. Start RSLinx Classic software and select Communications > Configure
Drivers to display the Configure Drivers screen.
2. From the Available Driver Types pull-down menu, choose EtherNet/IP
Driver.
3. Click Add New to display the Add New RSLinx Driver screen.
4. Use the default name or type a new name and click OK. The Configure
driver: screen appears.
5. Depending on your application, select either the browse local or remote
subnet option.
6. Click OK.
47
Chapter 4
The Configure Drivers screen reappears with the new driver in the
Configured Drivers list.
ControlLogix Controller
Example
After the adapter is configured, the connected drive and adapter will be a single
node on the network. This section provides the steps needed to configure a simple
EtherNet/IP network (see Figure 8). In our example, we will configure a
ControlLogix controller with 1756-ENBT (Series A) bridge to communicate
with a drive using Logic Command/Status, Reference/Feedback, and 16
Datalinks (8 to read and 8 to write) over the network.
Figure 8 - Example ControlLogix EtherNet/IP Network
IP Address 10.91.100.80
ControlLogix Controller
with 1756-ENBT Bridge
IP Address 10.91.100.79
PowerFlex 70 Drive with
20-COMM-ER Adapter
Ethernet
Switch
Computer with
Ethernet Connection
48
Chapter 4
a. Choose the appropriate choices for the fields in the screen to match
your application.
b. Click OK.
The RSLogix 5000 window reappears with the treeview in the left
pane.
3. In the treeview, right-click the I/O Configuration folder and choose New
Module
The Select Module screen appears.
4. Expand the Communications group to display all of the available
communication modules.
49
Chapter 4
Setting
Name
Description
IP Address
Host Name
Not used.
Slot
Revision
The minor revision of the firmware in the bridge. (You already set the major
revision by selecting the bridge series in step 5.)
Electronic
Keying
Open
Module
Properties
50
Chapter 4
For convenience, keep the project open. Later in this chapter the project
will need to be downloaded to the controller.
There are three ways to add the adapter into the I/O configuration:
Device Add-on Profiles (RSLogix 5000 software, version 16.00 or later)
Classic Profile (RSLogix 5000 software, versions 13.0015.00)
Generic Profile (RSLogix 5000 software, all versions)
These are described in separate sections below. If your version of RSLogix 5000
software supports device Add-on Profiles, we recommend that you use this
method.
51
Chapter 4
webupdate and download the latest RSLogix 5000 device Add-on Profile.
2. From the list, select the drive and its connected adapter.
For this example, we selected PowerFlex 70 EC-E.
3. Click OK.
The drives New Module screen appears.
4. On the General tab, edit the following data about the drive/adapter.
Box
Setting
Name
Description
IP Address
Write to
www.ab.com/support/abdrives/webupdate.
52
Chapter 4
Setting
Revision
The major and minor revision of the firmware (database) in the drive. If the
drives major and minor revision is not available, the drive database is not
installed on your computer. To get the correct database revision, use one of the
following buttons at the bottom left of the Module Definition screen:
Web Update: When a drive is not available online, opens the Allen-Bradley
Match Drive: Use this button when the drive being added to the network
Electronic
Keying
Drive
Rating
The voltage and current rating of the drive. If the drive rating is not listed, the
drive database is not installed on your computer. To get the correct drive rating,
use the Create Database, Web Update, or Match Drive button described
above.
Connection
Data
Format
Datalink
A, B, C, D
In the Input Data column, assigns selected drive parameters to be READ by the
controller. In the Output Data column, assigns selected drive parameters to be
WRITTEN by the controller.
Sort Input/
Output
selection
When this box is checked, sorts the Input Data and Output Data assigned
parameters by name and then by number, and enables parameter search by
name. When unchecked, sorts the assigned parameters by parameter number
and then by name, and enables parameter search by number.
Use
Network
Reference
Conveniently selects the speed reference for the drive to come from the
network. This box is checked by default.
When a 32-bit parameter is selected for Input Data or Output Data for a
drive with 16-bit Datalinks, two contiguous Datalinks (for example, x1
and x2, where x = A, B, C or D) are automatically assigned as a pair to
53
Chapter 4
54
Chapter 4
Screen for
RSLogix 5000
software, version
16.00 or 17.00
Screen for
RSLogix 5000
software, version
18.00 or later
9. In the Requested Packet Interval (RPI) box, set the value to 5.0
milliseconds or greater.
This value determines the maximum interval that a controller should use
to move data to and from the adapter. To conserve bandwidth, use
higher values for communicating with low priority devices.
The Inhibit Module box, when checked, inhibits the module from
communicating with the RSLogix 5000 project. When the Major Fault on
box is checked, a major controller fault will occur when the modules
connection fails while the controller is in the Run Mode. For this example,
leave the Inhibit Module and Major Fault On boxes unchecked.
Important: Unicast support has been added to RSLogix 5000 software,
version 18.00 or later. However, to also support unicast, the
controller firmware must be version 18.00 or later. Unicast
is recommended whenever possible. For the benefits of
unicast operation, see Preparing for an Installation on
page 18.
55
Chapter 4
10. On the New Module screen, click the Port Configuration tab.
11. In the Port Configuration tab screen, edit the following information.
Box
Setting
IP Address
The IP address of the adapter that was already set in the General tab. This
field is not configurable (grayed out).
Subnet Mask
The Subnet Mask configuration setting of the network. This setting must
match the setting of other devices on the network (for example,
255.255.255.0).
Gateway
Address
The Gateway Address configuration setting of the network. This setting must
match the setting of other devices on the network (for example,
10.91.100.1).
Enable BootP
When this box is checked, BOOTP is enabled in the adapter and will ignore
the IP address set in the General tab. When unchecked, the controller uses
the set IP address. This is another method to enable/disable BOOTP in the
adapter. For this example, leave this box unchecked.
12. Click Set to save the Port Configuration information which sets the
corresponding offline Subnet Cfg x and Gateway Cfg x parameters in the
adapter.
13. Click OK on the New Module screen.
The new node (My_PowerFlex_70_EC_Drive in this example) now
appears under the bridge (My_EtherNet_IP_Bridge in this example) in
the I/O Configuration folder. If you double-click the Controller Tags,
you will see that module-defined data types and tags have been
automatically created (Figure 9). Note that all tag names are defined and
Datalinks include the assigned drive parameter name. After you save
and download the configuration, these tags allow you to access the Input
and Output data of the drive via the controllers ladder logic.
56
Chapter 4
57
Chapter 4
TIP If a message box reports that RSLogix 5000 software is unable to go online,
select Communications > Who Active to find your controller in the Who
Active screen. After finding and selecting the controller, click Set Project
Path to establish the path. If your controller does not appear, you need to add
or configure the EtherNet/IP driver with RSLinx software. See Using RSLinx
Classic Software on page 47 and RSLinx online help for details.
58
Chapter 4
TIP On subsequent connections to the drive (after initial download), click Upload.
5. When the Reset Comm Module screen appears, click Yes to reset the
communication adapter so that the new I/O settings take effect.
59
Chapter 4
the treeview under the I/O Configuration folder and drive profile should
be gone.
TIP If the yellow warning symbol
You can view the drives Parameter List, Diagnostic Items List, and lists
for any connected peripheral, including the 20-COMM-ER. While
connected to the drive, you can dynamically change values of
parameters. Diagnostic items and diagram views can be used for
troubleshooting. Table 24 on page 147 provides diagnostic items for
troubleshooting the adapter.
7. Click OK when finished to close the Module Properties screen for the
drive.
60
Chapter 4
Since the RSLogix 5000 Classic Profile has been significantly improved upon by
RSLogix 5000 Device Add-on Profiles, version 16.00 or later, we recommend using
RSLogix 5000 Device Add-on Profiles to take advantage of its benefits (more
intuitive, time saving, and less likely to make I/O configuration errors).
Figure 10 - Classic Profile Screens for Drives
When Datalinks are used, you must enable the desired Datalinks and assign
names to their non-descriptive controller tags. When a Datalink is enabled, you
must set the following adapter I/O parameters:
Parameter 25 - [DPI I/O Cfg] turns on the enabled Datalink bit so the
20-COMM-ER adapter will communicate that Datalinks information
with the drive.
Parameter 37 - [M-S Input] turns on the enabled Datalink bit so the 20COMM-ER adapter will input that Datalinks information from the
controller.
Parameter 38 - [M-S Output] turns on the enabled Datalink bit so the
20-COMM-ER adapter will output that Datalinks information to the
controller.
61
Chapter 4
62
Chapter 4
Setting
Name
Description
Comm Format
IP Address
Open Module
Properties
Assembly Instance
Size
Input
1
The value will vary based on your application
(This value is required.) (setting of Parameters 25 - [DPI I/O Cfg] and 38 [M-S Output]) and the size (16-bit or 32-bit) of the
Reference/Feedback and Datalinks in the drive.
See Table 2, Table 3, or Table 4 on page 64.
Output
2
The value will vary based on your application
(This value is required.) (setting of Parameters 25 - [DPI I/O Cfg] and 37 [M-S Input]) and the size (16-bit or 32-bit) of the
Reference/Feedback and Datalinks in the drive.
See Table 2, Table 3, or Table 4 on page 64.
Configuration 6
0 (This value is required.)
(This value is required.)
The following tables define the number of 16-bit words that you need to
enter for the Input Size and Output Size boxes depending on your
configuration.
63
Chapter 4
Ref/Fdbk
(16-bit)
Datalinks (16-bit)
Input
Output
0 0001
0 0001
0 0001
0 0011
0 0011
0 0011
0 0111
0 0111
0 0111
10
0 1111
0 1111
0 1111
12
10
1 1111
1 1111
1 1111
Ref/Fdbk
(16-bit)
Datalinks (32-bit)
Input
Output
0 0001
0 0001
0 0001
0 0011
0 0011
0 0011
12
10
0 0111
0 0111
0 0111
16
14
0 1111
0 1111
0 1111
20
18
1 1111
1 1111
1 1111
Ref/Fdbk
(32-bit)
Datalinks (32-bit)
Output
0 0001
0 0001
0 0001
10
0 0011
0 0011
0 0011
14
12
0 0111
0 0111
0 0111
18
16
0 1111
0 1111
0 1111
22
20
1 1111
1 1111
1 1111
TIP For instructions on configuring the I/O for the adapter using Parameter 25 -
[DPI I/O Cfg] and its Master-Slave Hierarchy using Parameters 37 - [M-S
Input] and 38 - [M-S Output], see
Setting the I/O Configuration on page 35.
64
Chapter 4
9. In the Requested Packet Interval (RPI) box, set the value to 5.0 ms or
greater.
This value determines the maximum interval that a controller should use
to move data to and from the adapter. To conserve bandwidth, use
higher values for communicating with low priority devices. For this
example, leave the Inhibit Module and Major Fault boxes
unchecked.
10. Click OK.
The new node (My_PowerFlex_70_EC_Drive in this example) now
appears under the bridge (My_EtherNet_IP_Bridge in this example) in
the I/O Configuration folder. If you double-click the Controller Tags,
you will see that module-defined data types and tags have been
automatically created (Figure 11). After you save and download the
configuration, these tags allow you to access the Input and Output data
of the drive via the controllers ladder logic.
For this example, all Datalinks (A, B, C, and D) are enabled. The Input
Size is set to 12 words and the Output Size is set to 10 words. Also, the
following adapter I/O parameters are set to the following values.
Adapter Parameter No.
Setting
37 - [M-S Input]
38 - [M-S Output]
11. Reset the adapter (see Resetting the Adapter on page 43) or power cycle
the device.
65
Chapter 4
For the device speed reference and Datalink parameter values and the
adapter setup parameter values, see Drive and Adapter Parameter
Settings on page 90.
Figure 11 - Controller Tags
configuration of a Generic Profile while the controller is online and in the Run
mode.
66
TIP
Chapter 4
If a message box reports that RSLogix 5000 software is unable to go online, select
Communications > Who Active to find your controller in the Who Active
screen. After finding and selecting the controller, click Set Project Path to
establish the path. If your controller does not appear, you need to add or configure
the EtherNet/IP driver with RSLinx software. See Using RSLinx Classic
Software on page 47 and RSLinx online help for details.
67
Chapter 4
Limitations Using a
MicroLogix 1100/1400
Controller
MicroLogix 1100/1400
Controller Example
68
After the adapter is configured, the connected drive and adapter will be a single
node on the network. This section provides the steps needed to configure a
simple EtherNet/IP network (see Figure 12). In our example, we will configure a
MicroLogix 1100 controller to communicate with a drive using Logic
Command/Status, Reference/Feedback, and Datalinks over the network.
Chapter 4
Ethernet
Switch
Computer with
Ethernet Connection
TIP
Information for PowerFlex 750-Series drives has been added where applicable.
Setting
37 - [M-S Input]
38 - [M-S Output]
2. Reset the adapter (see Resetting the Adapter on page 43) or power cycle
the drive.
For the drive speed reference and Datalink parameter values and the
adapter setup parameter values, refer to Drive and Adapter Parameter
Settings on page 96.
69
Chapter 4
70
Chapter 4
5. Press Enter.
6. Insert another separate rung.
7. Double-click on the rung to display the rung editor.
8. Enter BST XIC MGxx:n/DN NXB XIC MGxx:n/ER BND OTU
MGxx:n/EN, where:
xx and n must correspond to the assigned data file number and element
(for example, MG10:0) for the message created in steps 25.
Steps 69
Step 10
11. Configure the General tab fields by entering or verifying the information
shown in the message configuration screen.
71
Chapter 4
Setting
Communication Command
500CPU Write. The controller type and command type for the controller to read or write data.
Because the MicroLogix 1100 is part of the SLC-500 controller family, the 500CPU controller type
was selected. The Write command type was selected to write the control timeout value to the drive.
N20:0. An unused controller data table address containing the control timeout value to be written.
(3)
Setting
To Address
(1) For details on data table addresses for this example project, see Table 11Table 14 starting on page 98.
(2) For details to determine element size for a specific drive, see Understanding Controller Data Table Addresses on page 97.
(3) For details on setting the control timeout value and its function, see N-Files on page 192. The Control Timeout (N42:3) is stored in RAM. If the 20COMM-ER adapter is power cycled, the Control Timeout Message must be re-sent. If the Control Timeout is not changed from a non-zero value, the
control message (page 75) will error out.
TIP The Control Timeout (N42:3) must be changed to a non-zero value (520 seconds
recommended). If the Control Timeout is not changed from a non-zero value, the
control message (page 75) will error out. The Control Timeout is stored in RAM. If
the adapter is power cycled, the Control Timeout Message must be re-sent.
72
Chapter 4
Create MicroLogix 1100/1400 Ladder Logic for the Logic Status, Feedback,
and Datalink Out
1. Insert another separate rung.
2. Double-click on the rung to display the rung editor.
3. Enter MSG MGxx:n, where:
xx is an unused data file number (for example, MG11:n), and
n is an unused element of the data file chosen for xx (for example, MG11:0)
4. Press Enter.
5. Insert another separate rung.
6. Double-click on the rung to display the rung editor.
7. Enter BST XIC MGxx:n/DN NXB XIC MGxx:n/ER BND OTU
MGxx:n/EN, where:
xx and n must correspond to the assigned data file number and element
(for example, MG11:0) for the message created in steps 14.
Steps 58
Step 9
10. Configure the General tab fields by entering or verifying the information
shown in the message configuration screen.
73
Chapter 4
Setting
Communication Command
500CPU Read. The controller type and command type for the controller to read or write data.
Because the MicroLogix 1100 is part of the SLC-500 controller family, the 500CPU controller
type was selected. The Read command type was selected to read data from the drive.
N20:1. An unused controller data table address containing the data to be read from the drive.
Size in Elements
(2)
19. Number of elements (words) to be transferred. Each element size is a 16-bit integer.
Setting
To Address
(1) For details on data table addresses for this example project, see Table 11Table 14 starting on page 98.
(2) For details to determine element size for a specific drive, see Understanding Controller Data Table Addresses on page 97.
(3) For N-File details, see N-Files on page 192.
74
Chapter 4
4. Press Enter.
5. Insert another separate rung.
6. Double-click on the rung to display the rung editor.
7. Enter BST XIC MGxx:n/DN NXB XIC MGxx:n/ER BND OTU
MGxx:n/EN, where:
xx and n must correspond to the assigned data file number and element
(for example, MG12:0) for the message created in steps 14.
Steps 58
Step 9
10. Configure the General tab fields by entering or verifying the information
shown in the message configuration screen.
75
Chapter 4
Setting
Communication Command
500CPU Write. The controller type and command type for the controller to read or write data.
Because the MicroLogix 1100 is part of the SLC-500 controller family, the 500CPU controller
type was selected. The Write command type was selected to write data to the drive.
N20:20. An unused controller data table address containing the data to be written to the drive.
19. Number of elements (words) to be transferred. Each element size is a 16-bit integer.
(3)
Setting
To Address
(1) For details on data table addresses for this example project, see Table 11Table 14 starting on page 98.
(2) For details to determine element size for a specific drive, see Understanding Controller Data Table Addresses on page 97.
(3) For N-File details, see N-Files on page 192.
TIP This message will error out if the Control Timeout value is not changed from a non-
zero value. Refer to page 71 for writing a value to the Control Timeout.
intersperse the control I/O messaging for each drive to conserve network
bandwidth and decrease response time. That is, sequence the message
instructions for each drive so that its group of messages will occur at a different
time than those for another drive.
76
Chapter 4
Notes:
77
Chapter 4
78
Chapter
This chapter provides information and examples that explain how to control,
configure, and monitor a PowerFlex 7-Class drive or SMC using the configured
I/O.
Topic
Page
79
80
84
Using Reference/Feedback
84
Using Datalinks
86
87
88
79
Chapter 5
The terms input and output are defined from the controllers point of view.
Therefore, output I/O is data that is produced by the controller and consumed by
the adapter. Input I/O is status data that is produced by the adapter and
consumed as input by the controller. The I/O image will vary based on the
following:
Size (either 16-bit or 32-bit) of the Reference/Feedback words and
Datalink words used by the device. To determine the size of the Reference/
Feedback and Datalinks, view adapter Parameters 20 - [Ref/Fdbk Size]
and 21- [Datalink Size]. For information to access parameters, see Using
the PowerFlex 7-Class HIM on page 28.
Configuration of I/O (Parameter 25 - [DPI I/O Cfg]). If all I/O is not
enabled, the image is truncated. The image always uses consecutive words
starting at word 0.
ControlLogix/CompactLogix Controllers onlyThe drive profile used
in RSLogix 5000 software (device Add-on Profile in version 16.00 or later,
Classic Profile in versions 13.0015.00, or Generic Profile in all versions).
80
Chapter 5
Table 5 - ControlLogix Controller I/O Image for Devices with 16-bit Reference/
Feedback and 16-bit Datalinks Using Generic Profile
These products include the following:
PowerFlex 70 drives with standard or enhanced control
PowerFlex 700 drives with standard control
PowerFlex 700H drives
Word
0
1
2
3
4
5
6
7
8
9
Output I/O
Logic Command
Reference
Datalink In A1
Datalink In A2
Datalink In B1
Datalink In B2
Datalink In C1
Datalink In C2
Datalink In D1
Datalink In D2
Word
0
1
2
3
4
5
6
7
8
9
10
11
Input I/O
Pad Word
Pad Word
Logic Status
Feedback
Datalink Out A1
Datalink Out A2
Datalink Out B1
Datalink Out B2
Datalink Out C1
Datalink Out C2
Datalink Out D1
Datalink Out D2
Table 6 - ControlLogix Controller I/O Image for Devices with 16-bit Reference/
Feedback and 32-bit Datalinks Using Generic Profile
These products include the following:
PowerFlex 700 drives with vector control
PowerFlex 700L drives with 700 control
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Output I/O
Logic Command
Reference
Datalink In A1 (LSW)
Datalink In A1 (MSW)
Datalink In A2 (LSW)
Datalink In A2 (MSW)
Datalink In B1 (LSW)
Datalink In B1 (MSW)
Datalink In B2 (LSW)
Datalink In B2 (MSW)
Datalink In C1 (LSW)
Datalink In C1 (MSW)
Datalink In C2 (LSW)
Datalink In C2 (MSW)
Datalink In D1 (LSW)
Datalink In D1 (MSW)
Datalink In D2 (LSW)
Datalink In D2 (MSW)
Input I/O
Pad Word
Pad Word
Logic Status
Feedback
Datalink Out A1 (LSW)
Datalink Out A1 (MSW)
Datalink Out A2 (LSW)
Datalink Out A2 (MSW)
Datalink Out B1 (LSW)
Datalink Out B1 (MSW)
Datalink Out B2 (LSW)
Datalink Out B2 (MSW)
Datalink Out C1 (LSW)
Datalink Out C1 (MSW)
Datalink Out C2 (LSW)
Datalink Out C2 (MSW)
Datalink Out D1 (LSW)
Datalink Out D1 (MSW)
Datalink Out D2 (LSW)
Datalink Out D2 (MSW)
81
Chapter 5
Table 7 - ControlLogix Controller I/O Image for Drives with 32-bit Reference/
Feedback and 32-bit Datalinks Using Generic Profile
These products include the following:
PowerFlex 700S drives with Phase I or Phase II control
PowerFlex 700L drives with 700S control
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Output I/O
Logic Command
Not Used
Reference (LSW)
Reference (MSW)
Datalink In A1 (LSW)
Datalink In A1 (MSW)
Datalink In A2 (LSW)
Datalink In A2 (MSW)
Datalink In B1 (LSW)
Datalink In B1 (MSW)
Datalink In B2 (LSW)
Datalink In B2 (MSW)
Datalink In C1 (LSW)
Datalink In C1 (MSW)
Datalink In C2 (LSW)
Datalink In C2 (MSW)
Datalink In D1 (LSW)
Datalink In D1 (MSW)
Datalink In D2 (LSW)
Datalink In D2 (MSW)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Input I/O
Pad Word
Pad Word
Logic Status
Not Used
Feedback (LSW)
Feedback (MSW)
Datalink Out A1 (LSW)
Datalink Out A1 (MSW)
Datalink Out A2 (LSW)
Datalink Out A2 (MSW)
Datalink Out B1 (LSW)
Datalink Out B1 (MSW)
Datalink Out B2 (LSW)
Datalink Out B2 (MSW)
Datalink Out C1 (LSW)
Datalink Out C1 (MSW)
Datalink Out C2 (LSW)
Datalink Out C2 (MSW)
Datalink Out D1 (LSW)
Datalink Out D1 (MSW)
Datalink Out D2 (LSW)
Datalink Out D2 (MSW)
82
Chapter 5
Table 8 - MicroLogix 1100/1400 I/O Image for PowerFlex 70/ 700/700H Drives and
SMC Flex (16-bit Reference/Feedback and 16-bit Datalinks)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Output I/O
Logic Command
Not used
Reference (MSW)
Not used
Datalink In A1 (MSW)
Not used
Datalink In A2 (MSW)
Not used
Datalink In B1 (MSW)
Not used
Datalink In B2 (MSW)
Not used
Datalink In C1 (MSW)
Not used
Datalink In C2 (MSW)
Not used
Datalink In D1 (MSW)
Not used
Datalink In D2 (MSW)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Input I/O
Logic Status
Not used
Feedback (MSW)
Not used
Datalink Out A1 (MSW)
Not used
Datalink Out A2 (MSW)
Not used
Datalink Out B1 (MSW)
Not used
Datalink Out B2 (MSW)
Not used
Datalink Out C1 (MSW)
Not used
Datalink Out C2 (MSW)
Not used
Datalink Out D1 (MSW)
Not used
Datalink Out D2 (MSW)
Table 9 - MicroLogix 1100/1400 I/O Image for PowerFlex 700 VC Drives and SMC-50
Controllers (16-bit Reference/Feedback and 32-bit Datalinks)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Output I/O
Logic Command
Not used
Reference (MSW)
Datalink In A1 (LSW)
Datalink In A1 (MSW)
Datalink In A2 (LSW)
Datalink In A2 (MSW)
Datalink In B1 (LSW)
Datalink In B1 (MSW)
Datalink In B2 (LSW)
Datalink In B2 (MSW)
Datalink In C1 (LSW)
Datalink In C1 (MSW)
Datalink In C2 (LSW)
Datalink In C2 (MSW)
Datalink In D1 (LSW)
Datalink In D1 (MSW)
Datalink In D2 (LSW)
Datalink In D2 (MSW)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Input I/O
Logic Status
Not used
Feedback (MSW)
Datalink Out A1 (LSW)
Datalink Out A1 (MSW)
Datalink Out A2 (LSW)
Datalink Out A2 (MSW)
Datalink Out B1 (LSW)
Datalink Out B1 (MSW)
Datalink Out B2 (LSW)
Datalink Out B2 (MSW)
Datalink Out C1 (LSW)
Datalink Out C1 (MSW)
Datalink Out C2 (LSW)
Datalink Out C2 (MSW)
Datalink Out D1 (LSW)
Datalink Out D1 (MSW)
Datalink Out D2 (LSW)
Datalink Out D2 (MSW)
83
Chapter 5
Table 10 - MicroLogix 1100/1400 I/O Image for PowerFlex 700S Series Drives (32-bit
Reference/Feedback and 32-bit Datalinks)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Output I/O
Logic Command
Reference (LSW)
Reference (MSW)
Datalink In A1 (LSW)
Datalink In A1 (MSW)
Datalink In A2 (LSW)
Datalink In A2 (MSW)
Datalink In B1 (LSW)
Datalink In B1 (MSW)
Datalink In B2 (LSW)
Datalink In B2 (MSW)
Datalink In C1 (LSW)
Datalink In C1 (MSW)
Datalink In C2 (LSW)
Datalink In C2 (MSW)
Datalink In D1 (LSW)
Datalink In D1 (MSW)
Datalink In D2 (LSW)
Datalink In D2 (MSW)
Word
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Input I/O
Logic Status
Feedback (LSW)
Feedback (MSW)
Datalink Out A1 (LSW)
Datalink Out A1 (MSW)
Datalink Out A2 (LSW)
Datalink Out A2 (MSW)
Datalink Out B1 (LSW)
Datalink Out B1 (MSW)
Datalink Out B2 (LSW)
Datalink Out B2 (MSW)
Datalink Out C1 (LSW)
Datalink Out C1 (MSW)
Datalink Out C2 (LSW)
Datalink Out C2 (MSW)
Datalink Out D1 (LSW)
Datalink Out D1 (MSW)
Datalink Out D2 (LSW)
Datalink Out D2 (MSW)
The Logic Command is a 16-bit word of control data produced by the scanner
and consumed by the adapter. The Logic Status is a 16-bit word of status data
produced by the adapter and consumed by the scanner.
This manual contains the bit definitions for most compatible products available
at the time of publication in Appendix D, Logic Command/Status Words. For
other products, see their documentation.
Using Reference/Feedback
The Reference is produced by the controller and consumed by the adapter. The
Feedback is produced by the adapter and consumed by the controller. The size of
the Reference/Feedback is determined by the drive and displayed using adapter
Parameter 20 - [Ref/Fdbk Size].
Size
Valid Values
16-bit
-32768 to 32767
32-bit
-2147483648 to 2147483647
When the Reference and Feedback are enabled and a ControlLogix controller
with a device Add-on Profile or Classic Profile is used, specific controller tags are
automatically created, sized (16-bit or 32-bit), and placed in the I/O image.
84
Chapter 5
ed]
90 Hz
60 Hz
Par. 82
m Spe
[Maximu
0 Hz
0
15123
22685
32767
85
Chapter 5
TIP
For PowerFlex 700 VC drives, firmware 3.xxx or later, parameter 299 - [DPI Fdbk Select]
enables you to select the feedback data coming from the drive over DPI. The default is
Speed Fdbk in Hz or RPM determined by parameter 079 - [Speed Units]. The data
selection for parameter 299 is also displayed on the 1st line of the HIM and on
DriveExplorer and DriveExecutive software screens in the drive status area of the screen.
The controller in the system sends a reference to the SMC, but it is not used for
control purposes in the current release.
The SMC products use the feedback to send motor current information.
Using Datalinks
86
Chapter 5
LSW
215 through 20
In this example, the parameter 10 - [Elapsed Run Time] value of 6553.9 Hrs is
read as 6553.9 in Datalink A1 Out (Parameter 310) and Datalink A2 Out
(Parameter 311).
Datalink
Word
Parameter
Data (Hex)
A1 Out
LSW
10
0003
A2 Out
MSW
10
0001
Conversion Example:
Parameter 010 - [Elapsed Run Time] = 6553.9 Hrs
MSW = 0001hex = 0001binary = 216 = 65536
LSW = 0003hex =3
Engineering Value = 65536 + 3 = 65539
Parameter 10 Displayed Value = 6553.9 Hrs
Regardless of the Datalink combination, Datalink x1 Out will always contain the
LSW and Datalink x2 Out will always contain the MSW. In the following
example, the PowerFlex 70 drive parameter 242 - [Power Up Marker] contains a
value of 88.4541 hours.
Datalink
Word
Parameter
Data (Hex)
A2 Out
MSW
242
000D
B1 Out
LSW
242
7F3D
Conversion Example:
Parameter 242 - [Power Up Marker] = 88.4541 hours
MSW = 000Dhex = 1101binary = 219 + 218 + 216 = 851968
LSW = 7F3Dhex = 32573
Engineering Value = 851968 + 32573 = 884541
Parameter 242 Displayed Value = 88.4541 Hrs
The example ladder logic programs in the sections of this chapter are intended for
and operate PowerFlex 7-Class drives and SMC Flex controllers.
87
Chapter 5
ControlLogix Controller
Example
An example ladder logic program that uses the automatically created descriptive
Controller tags and passes their data to the user-defined Program tags is shown in
Figure 20 and Figure 21. Note that the prefix for the device Controller tags is
determined by the name assigned when configuring the I/O (Chapter 4).
88
Chapter 5
89
Chapter 5
recommended using the RSLogix 5000 device Add-on Profiles to take advantage
of their benefits (more intuitive, time saving, and less likely to make ladder logic
program errors).
Creating Ladder Logic Using the RSLogix 5000 Generic Profile, All
Versions
Drive and Adapter Parameter Settings
The following drive and adapter settings were used for the example ladder logic
program in this section.
Value
22 (DPI Port 5)
140
142
100
155
101
102
103
104
140
142
100
155
101
102
103
104
10.91.100.79
Description
Assigns 20-COMM-ER to be used for the Reference.
Points to Par. 140 - [Accel Time 1]
Points to Par. 142 - [Decel Time 1]
Points to Par. 100 - [Jog Speed]
Points to Par. 155 - [Stop Mode A]
Points to Par. 101 - [Preset Speed 1]
Points to Par. 102 - [Preset Speed 2]
Points to Par. 103 - [Preset Speed 3]
Points to Par. 104 - [Preset Speed 4]
Points to Par. 140 - [Accel Time 1]
Points to Par. 142 - [Decel Time 1]
Points to Par. 100 - [Jog Speed]
Points to Par. 155 - [Stop Mode A]
Points to Par. 101 - [Preset Speed 1]
Points to Par. 102 - [Preset Speed 2]
Points to Par. 103 - [Preset Speed 3]
Points to Par. 104 - [Preset Speed 4]
IP address for the adapter.
255.255.248.0
11 - [Subnet Cfg 4]
23 - [DPI I/O Cfg]
35 - [M-S Input]
xxx1 1111
xxx1 1111
36 - [M-S Output]
xxx1 1111
20-COMM-ER
Adapter
Parameter
90 - [Speed Ref A Sel]
300 - [Data In A1]
301 - [Data In A2]
302 - [Data In B1]
303 - [Data In B2]
304 - [Data In C1]
305 - [Data In C2]
306 - [Data In D1]
307 - [Data In D2]
310 - [Data Out A1]
311 - [Data Out A2]
312 - [Data Out B1]
313 - [Data Out B2]
314 - [Data Out C1]
315 - [Data Out C2]
316 - [Data Out D1]
317 - [Data Out D2]
04 - [IP Addr Cfg 1]
Device
PowerFlex 70 EC
Drive
TIP
90
Data In parameters are inputs into the device that come from controller
outputs (for example, data to write to a device parameter). Data Out
parameters are outputs from the device that go to controller inputs (for
example, data to read a device parameter).
Chapter 5
Controller Tags
When you add the adapter and drive to the I/O configuration (Chapter 4),
RSLogix 5000 software automatically creates generic (non-descriptive) controller
tags for them. In this example program, the following controller tags are used.
Figure 22 - ControlLogix Controller Tags for Drive Generic Profile Example Ladder
Logic Program
You can expand the Input and Output tags to reveal the input and output
configuration.
Figure 23 - ControlLogix Input Image for Drive Generic Profile Example Ladder
Logic Program
PowerFlex 70 Drive
16-bit Speed Feedback and
Datalinks
91
Chapter 5
Figure 24 - ControlLogix Output Image for Drive Generic Profile Example Ladder
Logic Program
PowerFlex 70 Drive
16-bit Speed Reference and
Datalinks
Program Tags
To use the Controller tags that are automatically created, you need to create the
following Program tags for this example program.
Figure 25 - ControlLogix Program Tags for Drive Generic Profile Example Ladder
Logic Program
For information on speed Reference and Feedback scaling, see PowerFlex 7-Class
Drives on page 85.
92
Chapter 5
PowerFlex 70
Series Drives
PowerFlex 70
Drive Speed
Feedback
PowerFlex
Drive Speed
Feedback
93
Chapter 5
PowerFlex 70
Series Drives
PowerFlex 70
Drive Speed
Reference
PowerFlex
Drive Speed
Reference
94
Chapter 5
Figure 28 - ControlLogix Example Datalinks for Ladder Logic Program Using a Drive
Generic Profile
PowerFlex 70 Drive
For PowerFlex 7-Class drives, the scaling may need to be multiplied by 10 or 100,
depending on the parameter. For more information, see Using Datalinks on
page 86.
95
Chapter 5
MicroLogix 1100/1400
Controller Example
Parameter
90 - [Speed Ref A Sel]
300 - [Data In A1]
301 - [Data In A2]
302 - [Data In B1]
303 - [Data In B2]
304 - [Data In C1]
305 - [Data In C2]
306 - [Data In D1]
307 - [Data In D2]
310 - [Data Out A1]
311 - [Data Out A2]
312 - [Data Out B1]
313 - [Data Out B2]
314 - [Data Out C1]
315 - [Data Out C2]
316 - [Data Out D1]
317 - [Data Out D2]
04 - [IP Addr Cfg 1]
Value
22 (DPI Port 5)
140
142
100
155
101
102
103
104
140
142
100
155
101
102
103
104
10.91.100.79
Description
Assigns 20-COMM-ER to be used for the Reference.
Points to Par. 140 - [Accel Time 1]
Points to Par. 142 - [Decel Time 1]
Points to Par. 100 - [Jog Speed]
Points to Par. 155 - [Stop Mode A]
Points to Par. 101 - [Preset Speed 1]
Points to Par. 102 - [Preset Speed 2]
Points to Par. 103 - [Preset Speed 3]
Points to Par. 104 - [Preset Speed 4]
Points to Par. 140 - [Accel Time 1]
Points to Par. 142 - [Decel Time 1]
Points to Par. 100 - [Jog Speed]
Points to Par. 155 - [Stop Mode A]
Points to Par. 101 - [Preset Speed 1]
Points to Par. 102 - [Preset Speed 2]
Points to Par. 103 - [Preset Speed 3]
Points to Par. 104 - [Preset Speed 4]
IP address for the adapter.
255.255.248.0
11 - [Subnet Cfg 4]
23 - [DPI I/O Cfg]
35 - [M-S Input]
xxx1 1111
xxx1 1111
36 - [M-S Output]
xxx1 1111
20-COMM-ER
Adapter
The following drive and adapter settings were used for the example ladder logic
program in this section.
Device
PowerFlex 70 EC
Drive
TIP
Data In parameters are inputs into the drive that come from controller outputs (for
example, data to write to a drive parameter). Data Out parameters are outputs from the
drive that go to controller inputs (for example, data to read a drive parameter).
TIP
When using a drive that has 16-bit Datalinks (PowerFlex 70, PowerFlex 700, and
PowerFlex 700H drives) to transfer a 32-bit parameter, two contiguous drive Datalink
parameters (for example, Data Out A1/A2, B1/B2, etc.) are required. To determine if a
parameter is a 32-bit parameter, see the Parameter section in the drive documentation
and look for a 32 symbol in the No. column. (All parameters in PowerFlex 700 Series B
drives are 32-bit parameters.) For example, parameter 3 - [Output Current] in a PowerFlex
70 EC drive is a 32-bit parameter. When using a drive that has 32-bit Datalinks (PowerFlex
700 VC and PowerFlex 700S), only one drive Datalink parameter is required to transfer any
parameter.
96
Chapter 5
Important: The N20:0 data table address in this example is used to set a
control timeout value (in seconds) which determines how long
it will take the adapter to detect a communication loss. Enter a
valid value (132767) for N20:0. A value of zero (0) is not
valid, because it disables the timeout and all I/O connections
(Logic Command/Status, Reference/Feedback, and Datalinks)
intended for the drive will not execute. A timeout value of
520 seconds is recommended.
Depending on the drive you are using, Table 11, Table 12, Table 13, or Table 14
show the I/O definitions as they relate to the N20 data table (Figure 29) being
used in this example.
When using PowerFlex 70 or 70 EC, PowerFlex 700, PowerFlex 700VC drives, or
SMC Flex controllerswhich all contain INT (16-bit format) data types, you
will read from and write to the MSW data table address in the controller.
When using PowerFlex 700 VC drives or SMC-50 controllers, which contain
DINT (32-bit format) data types, you will read from and write to the LSW data
table address in the controller.
When using PowerFlex 700S drives, which contain both DINT (32-bit format)
and REAL (floating point format) data types, you will always read from and write
to the LSW data table address in the controller first. Then if the data value
exceeds 16 bits, the remaining value will be in the MSW data table address.
97
Chapter 5
98
Description
Logic Status (see Appendix D)
Reserved
Speed Feedback
Value of parameter assigned to Parameter 310 [Data Out A1] LSW
Value of parameter assigned to Parameter 310 [Data Out A1] MSW
Value of parameter assigned to Parameter 311 [Data Out A2] LSW
Value of parameter assigned to Parameter 311 [Data Out A2] MSW
Value of parameter assigned to Parameter 312 [Data Out B1] LSW
Value of parameter assigned to Parameter 312 [Data Out B1] MSW
Value of parameter assigned to Parameter 313 [Data Out B2] LSW
Value of parameter assigned to Parameter 313 [Data Out B2] MSW
Value of parameter assigned to Parameter 314 [Data Out C1] LSW
Value of parameter assigned to Parameter 314 [Data Out C1] MSW
Value of parameter assigned to Parameter 315 [Data Out C2] LSW
Value of parameter assigned to Parameter 315 [Data Out C2] MSW
Value of parameter assigned to Parameter 316 [Data Out D1] LSW
Value of parameter assigned to Parameter 316 [Data Out D1] MSW
Value of parameter assigned to Parameter 317 [Data Out D2] LSW
Value of parameter assigned to Parameter 317 [Data Out D2] MSW
Logic Command (see Appendix D)
Reserved
Speed Reference
Value of parameter assigned to Parameter 300 [Data In A1] LSW
Value of parameter assigned to Parameter 300 [Data In A1] MSW
Value of parameter assigned to Parameter 301 [Data In A2] LSW
Value of parameter assigned to Parameter 301 [Data In A2] MSW
Value of parameter assigned to Parameter 302 [Data In B1] LSW
Value of parameter assigned to Parameter 302 [Data In B1] MSW
Value of parameter assigned to Parameter 303 [Data In B2] LSW
Value of parameter assigned to Parameter 303 [Data In B2] MSW
Value of parameter assigned to Parameter 304 [Data In C1] LSW
Value of parameter assigned to Parameter 304 [Data In C1] MSW
Value of parameter assigned to Parameter 305 [Data In C2] LSW
Value of parameter assigned to Parameter 305 [Data In C2] MSW
Value of parameter assigned to Parameter 306 [Data In D1] LSW
Value of parameter assigned to Parameter 306 [Data In D1] MSW
Value of parameter assigned to Parameter 307 [Data In D2] LSW
Value of parameter assigned to Parameter 307 [Data In D2] MSW
Chapter 5
Table 12 - Controller Data Table Addresses for PowerFlex 700 VC Drives and SMC50 Controllers
Data Table Address
N20:1
N20:2
N20:3
N20:4
N20:5
N20:6
N20:7
N20:8
N20:9
N20:10
N20:11
N20:12
N20:13
N20:14
N20:15
N20:16
N20:17
N20:18
N20:19
N20:20
N20:21
N20:22
N20:23
N20:24
N20:25
N20:26
N20:27
N20:28
N20:29
N20:30
N20:31
N20:32
N20:33
N20:34
N20:35
N20:36
N20:37
N20:38
Description
Logic Status (see Appendix D)
Reserved
Speed Feedback
Value of parameter assigned to Parameter 310 [Data Out A1] LSW
Value of parameter assigned to Parameter 310 [Data Out A1] MSW
Value of parameter assigned to Parameter 311 [Data Out A2] LSW
Value of parameter assigned to Parameter 311 [Data Out A2] MSW
Value of parameter assigned to Parameter 312 [Data Out B1] LSW
Value of parameter assigned to Parameter 312 [Data Out B1] MSW
Value of parameter assigned to Parameter 313 [Data Out B2] LSW
Value of parameter assigned to Parameter 313 [Data Out B2] MSW
Value of parameter assigned to Parameter 314 [Data Out C1] LSW
Value of parameter assigned to Parameter 314 [Data Out C1] MSW
Value of parameter assigned to Parameter 315 [Data Out C2] LSW
Value of parameter assigned to Parameter 315 [Data Out C2] MSW
Value of parameter assigned to Parameter 316 [Data Out D1] LSW
Value of parameter assigned to Parameter 316 [Data Out D1] MSW
Value of parameter assigned to Parameter 317 [Data Out D2] LSW
Value of parameter assigned to Parameter 317 [Data Out D2] MSW
Logic Command (see Appendix D)
Reserved
Speed Reference
Value of parameter assigned to Parameter 300 [Data In A1] LSW
Value of parameter assigned to Parameter 300 [Data In A1] MSW
Value of parameter assigned to Parameter 301 [Data In A2] LSW
Value of parameter assigned to Parameter 301 [Data In A2] MSW
Value of parameter assigned to Parameter 302 [Data In B1] LSW
Value of parameter assigned to Parameter 302 [Data In B1] MSW
Value of parameter assigned to Parameter 303 [Data In B2] LSW
Value of parameter assigned to Parameter 303 [Data In B2] MSW
Value of parameter assigned to Parameter 304 [Data In C1] LSW
Value of parameter assigned to Parameter 304 [Data In C1] MSW
Value of parameter assigned to Parameter 305 [Data In C2] LSW
Value of parameter assigned to Parameter 305 [Data In C2] MSW
Value of parameter assigned to Parameter 306 [Data In D1] LSW
Value of parameter assigned to Parameter 306 [Data In D1] MSW
Value of parameter assigned to Parameter 307 [Data In D2] LSW
Value of parameter assigned to Parameter 307 [Data In D2] MSW
99
Chapter 5
Table 13 - Controller Data Table Addresses for PowerFlex 700S Drives with Phase I
Control
Data Table Address
N20:1
N20:2
N20:3
N20:4
N20:5
N20:6
N20:7
N20:8
N20:9
N20:10
N20:11
N20:12
N20:13
N20:14
N20:15
N20:16
N20:17
N20:18
N20:19
N20:20
N20:21
N20:22
N20:23
N20:24
N20:25
N20:26
N20:27
N20:28
N20:29
N20:30
N20:31
N20:32
N20:33
N20:34
N20:35
N20:36
N20:37
N20:38
100
Description
Logic Status (see Appendix D)
Speed Feedback LSW
Speed Feedback MSW
Value of parameter assigned to Parameter 724/725 [Data Out A1] LSW
Value of parameter assigned to Parameter 724/725 [Data Out A1] MSW
Value of parameter assigned to Parameter 726/727 [Data Out A2] LSW
Value of parameter assigned to Parameter 726/727 [Data Out A2] MSW
Value of parameter assigned to Parameter 728/729 [Data Out B1] LSW
Value of parameter assigned to Parameter 728/729 [Data Out B1] MSW
Value of parameter assigned to Parameter 730/731 [Data Out B2] LSW
Value of parameter assigned to Parameter 730/731 [Data Out B2] MSW
Value of parameter assigned to Parameter 732/733 [Data Out C1] LSW
Value of parameter assigned to Parameter 732/733 [Data Out C1] MSW
Value of parameter assigned to Parameter 734/735 [Data Out C2] LSW
Value of parameter assigned to Parameter 734/735 [Data Out C2] MSW
Value of parameter assigned to Parameter 736/737 [Data Out D1] LSW
Value of parameter assigned to Parameter 736/737 [Data Out D1] MSW
Value of parameter assigned to Parameter 738/739 [Data Out D2] LSW
Value of parameter assigned to Parameter 738/739 [Data Out D2] MSW
Logic Command (see Appendix D)
Speed Reference LSW
Speed Reference MSW
Value of parameter assigned to Parameter 707/708 [Data In A1] LSW
Value of parameter assigned to Parameter 707/708 [Data In A1] MSW
Value of parameter assigned to Parameter 709/710 [Data In A2] LSW
Value of parameter assigned to Parameter 709/710 [Data In A2] MSW
Value of parameter assigned to Parameter 711/712 [Data In B1] LSW
Value of parameter assigned to Parameter 711/712 [Data In B1] MSW
Value of parameter assigned to Parameter 713/714 [Data In B2] LSW
Value of parameter assigned to Parameter 713/714 [Data In B2] MSW
Value of parameter assigned to Parameter 715/716 [Data In C1] LSW
Value of parameter assigned to Parameter 715/716 [Data In C1] MSW
Value of parameter assigned to Parameter 717/718 [Data In C2] LSW
Value of parameter assigned to Parameter 717/718 [Data In C2] MSW
Value of parameter assigned to Parameter 719/720 [Data In D1] LSW
Value of parameter assigned to Parameter 719/720 [Data In D1] MSW
Value of parameter assigned to Parameter 721/722 [Data In D2] LSW
Value of parameter assigned to Parameter 721/722 [Data In D2] MSW
Chapter 5
Table 14 - Controller Data Table Addresses for PowerFlex 700S Drives with Phase II
Control
Data Table Address
N20:1
N20:2
N20:3
N20:4
N20:5
N20:6
N20:7
N20:8
N20:9
N20:10
N20:11
N20:12
N20:13
N20:14
N20:15
N20:16
N20:17
N20:18
N20:19
N20:20
N20:21
N20:22
N20:23
N20:24
N20:25
N20:26
N20:27
N20:28
N20:29
N20:30
N20:31
N20:32
N20:33
N20:34
N20:35
N20:36
N20:37
N20:38
Description
Logic Status (see Appendix D)
Speed Feedback LSW
Speed Feedback MSW
Value of parameter assigned to Parameter 660 [DPI Data Out A1] LSW
Value of parameter assigned to Parameter 660 [DPI Data Out A1] MSW
Value of parameter assigned to Parameter 661 [DPI Data Out A2] LSW
Value of parameter assigned to Parameter 661 [DPI Data Out A2] MSW
Value of parameter assigned to Parameter 662 [DPI Data Out B1] LSW
Value of parameter assigned to Parameter 662 [DPI Data Out B1] MSW
Value of parameter assigned to Parameter 663 [DPI Data Out B2] LSW
Value of parameter assigned to Parameter 663 [DPI Data Out B2] MSW
Value of parameter assigned to Parameter 664 [DPI Data Out C1] LSW
Value of parameter assigned to Parameter 664 [DPI Data Out C1] MSW
Value of parameter assigned to Parameter 665 [DPI Data Out C2] LSW
Value of parameter assigned to Parameter 665 [DPI Data Out C2] MSW
Value of parameter assigned to Parameter 666 [DPI Data Out D1] LSW
Value of parameter assigned to Parameter 666 [DPI Data Out D1] MSW
Value of parameter assigned to Parameter 667 [DPI Data Out D2] LSW
Value of parameter assigned to Parameter 667 [DPI Data Out D2] MSW
Logic Command (see Appendix D)
Speed Reference LSW
Speed Reference MSW
Value of parameter assigned to Parameter 651 [DPI Data In A1] LSW
Value of parameter assigned to Parameter 651 [DPI Data In A1] MSW
Value of parameter assigned to Parameter 652 [DPI Data In A2] LSW
Value of parameter assigned to Parameter 652 [DPI Data In A2] MSW
Value of parameter assigned to Parameter 653 [DPI Data In B1] LSW
Value of parameter assigned to Parameter 653 [DPI Data In B1] MSW
Value of parameter assigned to Parameter 654 [DPI Data In B2] LSW
Value of parameter assigned to Parameter 654 [DPI Data In B2] MSW
Value of parameter assigned to Parameter 655 [DPI Data In C1] LSW
Value of parameter assigned to Parameter 655 [DPI Data In C1] MSW
Value of parameter assigned to Parameter 656 [DPI Data In C2] LSW
Value of parameter assigned to Parameter 656 [DPI Data In C2] MSW
Value of parameter assigned to Parameter 657 [DPI Data In D1] LSW
Value of parameter assigned to Parameter 657 [DPI Data In D1] MSW
Value of parameter assigned to Parameter 658 [DPI Data In D2] LSW
Value of parameter assigned to Parameter 658 [DPI Data In D2] MSW
You can use the controller data table addresses to directly control and monitor the
drive without creating any ladder logic program. However, if you intend to use
Human Machine Interface devices (PanelView, and so forth) to operate the drive
and view its status, you will need to create descriptive controller data table
addresses (Table 15 and Table 16) and a ladder logic program that will pass that
data to the data table addresses used for messaging.
101
Chapter 5
Table 15 - Controller and Program Data Table Address Descriptions for Example
Logic Status/Feedback Ladder Logic Program
Description
Drive Ready
Drive Active
Actual Direction (XIO)
Actual Direction (XIC)
Drive Faulted
Drive At Speed
Speed Feedback
Controller Data
Table Address
N20:1/0
N20:1/1
N20:1/3
N20:1/3
N20:1/7
N20:1/8
N20:3
Description
Status Ready
Status Active
Status Forward
Status Reverse
Status Faulted
Status At Speed
Speed Feedback
Program Data
Table Address
B3:1/0
B3:1/1
B3:1/3
B3:1/4
B3:1/7
B3:1/8
B30:3
Table 16 - Program and Controller Data Table Address Descriptions for Example
Logic Command/Reference Ladder Logic Program
Program Data
Table Address
Command Stop
B3:20/0
Command Start
B3:20/1
Command Jog
B3:20/2
Command Clear Faults
B3:20/3
Command Forward Reverse (XIO) B3:20/4
Command Forward Reverse (XIC) B3:20/4
Speed Reference
N30:22
Description
Description
Drive Stop
Drive Start
Drive Jog
Drive Clear Faults
Drive Forward
Drive Reverse
Speed Reference
Controller Data
Table Address
N20:20/0
N20:20/1
N20:20/2
N20:20/3
N20:20/4
N20:20/5
N20:22
An example ladder logic program that uses these descriptive controller data table
addresses and passes their data to the descriptive program data table addresses is
shown in Figure 30, Figure 31, Figure 32, and Figure 33.
Figure 30 - MicroLogix 1100/1400 Example Ladder Logic Program for Logic Status
PowerFlex 70
Drives
102
Chapter 5
PowerFlex 70
Drive Speed
Feedback
PowerFlex 70
Drives
PowerFlex 70
Drive Speed
Reference
103
Chapter 5
104
Chapter
This chapter provides information and examples that explain how to use Explicit
Messaging to configure and monitor the adapter and connected PowerFlex 7Class drive or SMC.
Topic
Page
106
106
108
124
See Chapter 5 for information about the I/O Image, using Logic Command/
Status, Reference/Feedback, and Datalinks.
105
Chapter 6
Explicit Messaging is used to transfer data that does not require continuous
updates. With Explicit Messaging, you can configure and monitor a slave devices
parameters on the network.
Important: When an explicit message is performed, by default no
connection is made since it is an unconnected message. When
timing of the message transaction is important, you can create a
dedicated message connection between the controller and drive
by checking the Connected box on the Communications tab
message configuration screen during message setup. These
message connections are in addition to the I/O connection.
However, the trade off for more message connections is
decreased network performance. If your application cannot
tolerate this, do not check the Connected box, which is
recommended.
Important: PowerFlex 7-Class drives have explicit messaging limitations.
Table 17 shows the EtherNet/IP Object Class code
compatibilities for these drives.
Table 17 - Explicit Messaging Class Code Compatibility with Drives
Performing Explicit
Messages
EtherNet/IP Object
Class Code
PowerFlex
7-Class Drives
Yes
Yes
There are five basic events in the Explicit Messaging process. The details of each
step will vary depending on the type of controller being used. See the
documentation for your controller.
Important: There must be a request message and a response message for all
Explicit Messages, whether you are reading or writing data.
106
Chapter 6
Complete Explicit
Message
Retrieve Explicit
Message Response
Ethernet
Switch
Event Description
You format the required data and set up the ladder logic program to send an Explicit
Message request to the scanner or bridge module (download).
The scanner or bridge module transmits the Explicit Message Request to the slave device
over the network.
The slave device transmits the Explicit Message Response back to the scanner. The data is
stored in the scanner buffer.
The controller retrieves the Explicit Message Response from the scanners buffer (upload).
107
Chapter 6
ControlLogix Controller
Examples
TIP
Data Type
XIC
Execute_Single_Read_Message
BOOL
MSG
Single_Read_Message
MESSAGE
108
Chapter 6
The following table identifies the data that is required in each box to configure a
message to read a single parameter.
Configuration Tab
Example Value
Description
Message Type
Service Type (1)
Service Code (1)
Class
Instance (2)
Attribute
Destination
CIP Generic
Parameter Read
e (Hex.)
f (Hex.)
3 (Dec.)
1 (Hex.)
Output_Current (4)
Communication Tab
Example Value
Description
My_PowerFlex_Drive
Path
(3)
Tag Tab
Example Value
Description
Name
Single_Read_Message
(1) The default setting for Service Type is Custom, enabling entry of a Service Code not available from the Service Type pulldown menu. When choosing a Service Type other than Custom from the pull-down menu, an appropriate Hex. value is
automatically assigned to the Service Code box which is dimmed (unavailable).
(2) Only drive parameters (Port 0) can be read using Parameter Object Class code 0x0F. To read a parameter of a peripheral in
another port, use DPI Parameter Object Class code 0x93 (see page 121).
(3) Click Browse to find the path, or type in the name of the device listed in the I/O Configuration folder.
(4) In this example, Output Current is a 32-bit parameter requiring the Data Type field to be set to DINT when creating the
controller tag. If the parameter being read is a 16-bit parameter, the tag Data Type field must be set to INT. When using a
PowerFlex 700S drive, Output Current is a floating point parameter requiring the Data Type field to be set to REAL when
creating the controller tag. See the drive documentation to determine the size of the parameter and its data type (16-bit or
32-bit integer or REAL).
109
Chapter 6
Data Type
XIC
Execute_Single_Write_Message
BOOL
MSG
Single_Write_Message
MESSAGE
110
Chapter 6
The following table identifies the data that is required in each box to configure a
message to write a single parameter.
Configuration Tab
Example Value
Description
Message Type
Service Type (1)
Service Code (1)
Class
Instance (2)
Attribute
Source Element
Source Length
CIP Generic
Parameter Write
10 (Hex.)
f (Hex.)
140 (Dec.)
1 (Hex.)
Accel_Time_1 (4)
2 (4)
Description
My_PowerFlex_Drive
Tag Tab
Example Value
Description
Name
Single_Write_Message
Path
(1) The default setting for Service Type is Custom, enabling entry of a Service Code not available from the Service Type pull-down menu. When choosing a Service
Type other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which is dimmed (unavailable).
(2) Only drive parameters (Port 0) can be written to using Parameter Object Class code 0x0F. To write to a parameter of a peripheral in another port, use DPI Parameter
Object Class code 0x93 (see page 123).
(3) Click Browse to find the path, or type in the name of the device listed in the I/O Configuration folder.
(4) In this example, Accel Time 1 is a 16-bit parameter requiring the tag Data Type field to be set to INT when creating the controller tag. If the parameter being
written to is a 32-bit parameter, the tag Data Type field must be set to DINT. Also, the Source Length field on the Message Configuration screen must correspond
to the selected Data Type in bytes (for example, 4 bytes for a DINT or a REAL). When using a PowerFlex 700S drive, Accel Time 1 is a floating point number requiring
the Data Type field to be set to REAL when creating the controller tag. See the drive documentation to determine the size of the parameter and its data type (16bit or 32-bit integer or REAL).
111
Chapter 6
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Important: See Table 17 on page 106 for limitations of PowerFlex 7-Class
drives when using Class code 0x93.
Table 20 - Example Controller Tags to Read Multiple Parameters
Operand
Data Type
XIC
Execute_Scattered_Read_Message
BOOL
MSG
Scattered_Read_Message
MESSAGE
112
Chapter 6
The following table identifies the data that is required in each box to configure a
message to read multiple parameters.
Configuration Tab
Example Value
Description
Message Type
Service Type (1)
Service Code (1)
Class
Instance
Attribute
Source Element
Source Length
Destination
CIP Generic
Custom
4b (Hex.)
93 or 9F (Hex.) (3)
0 (Dec.)
0 (Hex.)
Scattered_Read_Request (4)
30 (4)
Scattered_Read_Response
Description
My_PowerFlex_Drive
Tag Tab
Example Value
Description
Name
Scattered_Read_Message
Path
(1) The default setting for Service Type is Custom, enabling entry of a Service Code not available from the Service Type pull-down menu. When choosing a Service Type
other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which is dimmed (unavailable).
(2) Click Browse to find the path, or type in the name of the device listed in the I/O Configuration folder.
(3) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit messaging.
(4) In this example, we are reading five parameters. Each parameter being read requires an array of three INT registers. Therefore, a controller tag was created with its
Data Type field set to INT[15]. Also, the Source Length field on the Message Configuration screen must correspond to the selected Data Type in bytes (for this
example, 30 bytes for an INT[15] array). Scattered read messages always assume that every parameter being read is a 32-bit parameter, regardless of its actual size.
Maximum length is 132 bytes or 66 words which equates to 22 parameters. For parameter numbering, see DPI Parameter Object on page 198 (Class code 0x93).
113
Chapter 6
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Figure 41 - Example Scattered Read Request Data for PowerFlex 7-Class Drive
114
Chapter 6
Read Value
1 - [Output Freq]
32.5 Hz
3 - [Output Current]
0.01 Amp
6 - [Output Voltage]
118.7 VAC
329.2 VDC
8.318 mA
115
Chapter 6
Write Value
11.1 Sec.
22.2 Sec.
33.3 Hz.
44.4 Hz.
55.5 Hz.
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Important: See Table 17 on page 106 for limitations of PowerFlex 7-Class
drives when using Class code 0x93 for explicit messaging.
Table 21 - Example Controller Tags to Write Multiple Parameters
Operand
Data Type
XIC
Execute_Scattered_Write_Message
BOOL
MSG
Scattered_Write_Message
MESSAGE
116
Chapter 6
The following table identifies the data that is required in each box to configure a
message to write multiple parameters.
Configuration Tab
Example Value
Description
Message Type
Service Type (1)
Service Code (1)
Class
Instance
Attribute
Source Element
Source Length
Destination
CIP Generic
Custom
4c (Hex.)
93 or 9F (Hex.) (3)
0 (Dec.)
0 (Hex.)
Scattered_Write_Request (4)
30 (4)
Scattered_Write_Response
(2)
My_PowerFlex_Drive
Description
The path is the route that the message will follow.
Tag Tab
Example Value
Description
Name
Scattered_Write_Message
(1) The default setting for Service Type is Custom, enabling entry of a Service Code not available from the Service Type pull-down menu. When choosing a Service Type
other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which is dimmed (unavailable).
(2) Click Browse to find the path, or type in the name of the device listed in the I/O Configuration folder.
(3) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit messaging.
(4) In this example, we are writing to five parameters. Each parameter being written to requires an array of three INT registers. Therefore, a controller tag was created with
its Data Type field set to INT[15]. Also, the Source Length field on the Message Configuration screen must correspond to the selected Data Type in bytes (for this
example, 30 bytes for an INT[15] array). Scattered write messages always assume that every parameter being written to is a 32-bit parameter, regardless of its actual
size. Maximum length is 132 bytes or 66 words which equates to 22 parameters. For parameter numbering, see DPI Parameter Object on page 198 (Class code 0x93).
117
Chapter 6
Write Value
11.1 Sec.
22.2 Sec.
33.3 Hz.
44.4 Hz.
55.5 Hz.
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Figure 45 shows the parameter values.
Figure 45 - Example Scattered Write Request Data for PowerFlex 7-Class Drive
118
Chapter 6
119
Chapter 6
Word 0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
...
63 Parameter Number
64 Pad Word
65 Pad Word
63 Parameter Number
64 Parameter Value LSW
65 Parameter Value MSW
Word 0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
...
120
63 Parameter Number
64 Parameter Value LSW
65 Parameter Value MSW
63 Parameter Number
64 Pad Word
65 Pad Word
Chapter 6
Data Type
XIC
Execute_Single_Read_Message
BOOL
MSG
Single_Read_Message
MESSAGE
121
Chapter 6
The following table identifies the data that is required in each box to configure a
message to read a single parameter.
Configuration Tab
Example Value
Description
Message Type
Service Type (1)
Service Code (1)
Class
Instance (2)
Attribute
Destination
CIP Generic
Get Attribute Single
e (Hex.)
93 or 9F (Hex.) (4)
3 (Dec.)
9 (Hex.)
Output_Current (5)
Communication Tab
Example Value
Description
My_PowerFlex_Drive
Path
(3)
Tag Tab
Example Value
Description
Name
Single_Read_Message
(1) The default setting for Service Type is Custom, enabling entry of a Service Code not available from the Service Type pull-down menu. When choosing a Service Type
other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which is dimmed (unavailable).
(2) The instance is the parameter number in the drive (Port 0). For example, to read parameter 4 of a peripheral in Port 5 of an SMC-50 controller, the instance would be 21504
+ 4 = 21508. See DPI Parameter Object on page 198 (Class code 0x93) to determine the instance number.
(3) Click Browse to find the path, or type in the name of the device listed in the I/O Configuration folder.
(4) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit messaging.
(5) In this example, Output Current is a 32-bit parameter requiring the Data Type field to be set to DINT when creating the controller tag. If the parameter being read is a 16bit parameter, the tag Data Type field must be set to INT. When using a PowerFlex 700S drive, Output Current is a floating point number requiring the Data Type field to
be set to REAL when the creating controller tag. See the drive documentation to determine the size of the parameter and its data type (16-bit or 32-bit integer or REAL).
122
Chapter 6
Data Type
XIC
Execute_Single_Write_Message
BOOL
MSG
Single_Write_Message
MESSAGE
123
Chapter 6
The following table identifies the data that is required in each box to configure a
message to write a single parameter.
Configuration Tab
Example Value
Description
Message Type
Service Type (1)
Service Code (1)
Class
Instance (2)
Attribute (3)
Source Element
Source Length
CIP Generic
Set Attribute Single
10 (Hex.)
93 or 9F (Hex.) (5)
140 (Dec.)
9 or A (Hex.)
Accel_Time_1 (6)
2 (6)
Description
My_PowerFlex_Drive
Tag Tab
Example Value
Description
Name
Single_Write_Message
Path
(1) The default setting for Service Type is Custom, enabling entry of a Service Code not available from the Service Type pull-down menu. When choosing a Service
Type other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which is dimmed (unavailable).
(2) The instance is the parameter number in the drive (Port 0). For example, to write to parameter 4 of a peripheral in Port 7 of an SMC-50 controller, the instance would
be 21504 + 4 = 21508. See DPI Parameter Object on page 198 (Class code 0x93) to determine the instance number.
(3) Setting the Attribute value to 9 will write the parameter value to the drives Nonvolatile Storage (EEPROM) memory, which retains the parameter value even after
the drive is power cycled. Important: When set to 9, the EEPROM may quickly exceed its life cycle and cause the drive to malfunction. Setting the Attribute value
to A (10 decimal) will write the parameter value to temporary memory, which deletes the parameter value after the drive is power cycled. When frequent write
messages are required, we recommend using the A (10 decimal) setting.
(4) Click Browse to find the path, or type in the name of the device listed in the I/O Configuration folder.
(5) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit messaging.
(6) In this example, Accel Time 1 is a 16-bit parameter requiring the tag Data Type field to be set to INT when creating the controller tag. If the parameter being written
to is a 32-bit parameter, the tag Data Type field must be set to DINT. Also, the Source Length field on the Message Configuration screen must correspond to the
selected Data Type in bytes (for example, 4 bytes for a DINT or a REAL). When using a PowerFlex 700S drive, Accel Time 1 is a floating point number requiring the
Data Type field to be set to REAL when creating the controller tag. See the drive documentation to determine the size of the parameter and its data type (16-bit or
32-bit integer or REAL).
MicroLogix 1100/1400
Controller Examples
When using RSLogix 500 software, version 7.10 and earlier, explicit messaging
must be performed using the PCCC N-File method. For RSLogix 500 software,
version 7.20 and later, the CIP messaging method has been added along with the
PCCC N-File method. However, it is recommended to use the CIP method
because it is easier to use and understand. For this reason, only instructions for
the CIP method are provided.
The CIP messaging method provides two ways to perform explicit messaging:
124
Chapter 6
125
Chapter 6
The following table identifies the data that is required in each box to configure a
message to read a single parameter.
General Tab
Example Value
Description
Channel
Comm Command
Data Table Address
1
CIP Generic
N40:0
Size in Bytes
Extended Routing
Service (1)
Instance (2)
4 (3)
RIX15:0
Read Parameter
3 (Dec.)
MultiHop Tab
Example Value
Description
To Address
10.91.100.79
(1) The default setting for Service is Custom, enabling entry of a Service Code not available from the Service pull-down menu. When
choosing a Service other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the
Service Code box which is dimmed (unavailable).
(2) Only drive parameters (Port 0) can be read using Parameter Object Class code 0x0F. To read a parameter of a peripheral in another
port, use DPI Parameter Object Class code 0x93 (see page 130).
(3) In this example, Output Current is a 32-bit parameter. If the parameter being read is a 16-bit parameter, the Size in Bytes would be
set to 2. When the parameter being read is a 32-bit REAL (floating point) data type, the size in bytes would be set to 4. See the
drive documentation to determine the size of the parameter and its data type (16-bit or 32-bit integer or REAL).
126
Chapter 6
Figure 56 shows example ladder logic to correctly format the three possible data
types for read messages in the MicroLogix 1100/1400 controller.
Figure 56 - Example Ladder Logic to Format Parameter Data Types for Reads
127
Chapter 6
128
Chapter 6
The following table identifies the data that is required in each box to configure a
message to write a single parameter.
General Tab
Example Value
Description
Channel
Comm Command
Data Table Address
1
CIP Generic
N50:0
Size in Bytes
Extended Routing
Service (1)
Instance (2)
2 (3)
RIX16:0
Write Parameter
140 (Dec.)
MultiHop Tab
Example Value
Description
To Address
10.91.100.79
(1) The default setting for Service is Custom, enabling entry of a Service Code not available from the Service pull-down menu. When
choosing a Service other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the
Service Code box which is dimmed (unavailable).
(2) Only drive parameters (Port 0) can be written to using Parameter Object Class code 0x0F. To write to a parameter of a peripheral in
another port, use DPI Parameter Object Class code 0x93 (see page 133).
(3) In this example, Accel Time 1 is a 16-bit parameter. If the parameter being written to is a 32-bit parameter, the Size in Bytes would
be set to 4. When the parameter being written to is a 32-bit REAL (floating point) data type, the size in bytes would be set to 4. See
the drive documentation to determine the size of the parameter and its data type (16-bit or 32-bit integer or REAL).
Figure 60 shows example ladder logic to correctly format the three possible data
types for write messages in the MicroLogix 1100/1400 controller.
129
Chapter 6
Figure 60 - Example Ladder Logic to Format Parameter Data Types for Writes
130
Chapter 6
The following table identifies the data that is required in each box to configure a
message to read a single parameter.
General Tab
Example Value
Description
Channel
Comm Command
Data Table Address
1
CIP Generic
N40:0
Size in Bytes
Extended Routing
Service (1)
Class
Instance (2)
Attribute
4 (3)
RIX15:0
Generic Get Attribute Single
93 or 9F (Hex.) (4)
3 (Dec.)
9 (Dec.)
MultiHop Tab
Example Value
Description
To Address
10.91.100.79
(1) The default setting for Service is Custom, enabling entry of a Service Code not available from the Service pull-down menu. When choosing
a Service other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which
is dimmed (unavailable).
(2) The instance is the parameter number in the drive (Port 0). For example, to read parameter 4 of a peripheral in Port 7 of an SMC-50 controller,
the instance would be 21504 + 4 = 21508. See DPI Parameter Object on page 198 (Class code 0x93) to determine the instance number.
(3) In this example, Output Current is a 32-bit parameter. If the parameter being read is a 16-bit parameter, the Size in Bytes would be set to 2.
When the parameter being read is a 32-bit REAL (floating point) data type, the size in bytes would be set to 4. See the drive documentation
to determine the size of the parameter and its data type (16-bit or 32-bit integer or REAL).
(4) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit
messaging.
131
Chapter 6
Figure 64 shows example ladder logic to correctly format the three possible data
types for read messages in the MicroLogix 1100/1400 controller.
Figure 64 - Example Ladder Logic to Format Parameter Data Types for Gets
132
Chapter 6
133
Chapter 6
The following table identifies the data that is required in each box to configure a
message to write a single parameter.
General Tab
Example Value
Description
Channel
Comm Command
Data Table Address
1
CIP Generic
N50:0
Size in Bytes
Extended Routing
Service (1)
Class
Instance (2)
Attribute (3)
2 (4)
RIX16:0
Generic Set Attribute Single
93 or 9F (Hex.) (5)
140 (Dec.)
9 or 10 (Dec.)
MultiHop Tab
Example Value
Description
To Address
10.91.100.79
(1) The default setting for Service is Custom, enabling entry of a Service Code not available from the Service pull-down menu. When choosing a Service other than Custom
from the pull-down menu, an appropriate Hex. value is automatically assigned to the Service Code box which is dimmed (unavailable).
(2) The instance is the parameter number in the drive (Port 0). For example, to write to parameter 4 of a peripheral in Port 5 of an SMC-50 controller, the instance would be
21504 + 4 = 21508. See DPI Parameter Object on page 198 (Class code 0x93) to determine the instance number.
(3) Setting the Attribute value to 9 will write the parameter value to the drives Nonvolatile Storage (EEPROM) memory, which retains the parameter value even after the
drive is power cycled. Important: When set to 9, the EEPROM may quickly exceed its life cycle and cause the drive to malfunction. Setting the Attribute value to 10 will
write the parameter value to temporary memory, which deletes the parameter value after the drive is power cycled. When frequent write messages are required, we
recommend using the 10 setting.
(4) In this example, Accel Time 1 is a 16-bit parameter. If the parameter being written to is a 32-bit parameter, the Size in Bytes would be set to 4.
(5) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit messaging.
Figure 68 shows example ladder logic to correctly format the three possible data
types for write messages in the MicroLogix 1100/1400 controller.
134
Chapter 6
Figure 68 - Example Ladder Logic to Format Parameter Data Types for Sets
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Important: See Table 17 on page 106 for limitations of PowerFlex 7-Class
drives when using Class code 0x93 for explicit messaging.
135
Chapter 6
136
Chapter 6
The following table identifies the data that is required in each box to configure a
message to read multiple parameters.
General Tab
Example Value
Description
Channel
Comm Command
Data Table Address
1
CIP Generic
N60:0
Size in Bytes
Extended Routing
Service (1)
Service Code
Class
Instance
Attribute
30 (2)
RIX19:0
Custom
4B (Hex.)
93 or 9F (Hex.) (3)
0 (Dec.)
0 (Dec.)
MultiHop Tab
Example Value
Description
To Address
10.91.100.79
(1) The default setting for Service is Custom, enabling entry of a Service Code not available from the Service pull-down menu. When
choosing a Service other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the
Service Code box which is dimmed (unavailable).
(2) In this example, we are reading five parameters. Each parameter being read requires three contiguous 16-bit words. Scattered
read messages always assume that every parameter being read is a 32-bit parameter, regardless of its actual size. Therefore, the
Size in Bytes must be set to 30. The data structure format is the same as shown on page 141. Maximum length is 66 words (132
bytes), which equates to 22 parameters. For parameter numbering, see DPI Parameter Object on page 198 (Class code 0x93).
(3) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for explicit
messaging.
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Figure 71 - Example Scattered Read Request Data File for PowerFlex 7-Class Drive
137
Chapter 6
Address
Read Value
1 - [Output Freq]
N60:1
32.5 Hz
3 - [Output Current]
N60:4
0.01 Amp
6 - [Output Voltage]
N60:7
118.7 VAC
N60:10
329.2 VDC
N60:13
8.318 mA
Write Value
11.1 Sec.
22.2 Sec.
33.3 Hz.
44.4 Hz.
55.5 Hz.
See DPI Parameter Object on page 198 (Class code 0x93) for parameter
numbering.
Important: See Table 17 on page 106 for limitations of PowerFlex 7-Class
drives when using Class code 0x93 for explicit messaging.
138
Chapter 6
139
Chapter 6
The following table identifies the data that is required in each box to configure a
message to write multiple parameters.
General Tab
Example Value
Description
Channel
Comm Command
Data Table Address
1
CIP Generic
N80:0
Size in Bytes
Extended Routing
Service (1)
Service Code
Class
Instance
Attribute
30 (2)
RIX21:0
Custom
4C (Hex.)
93 or 9F (Hex.) (3)
0 (Dec.)
0 (Dec.)
MultiHop Tab
Example Value
Description
To Address
10.91.100.79
(1) The default setting for Service is Custom, enabling entry of a Service Code not available from the Service pull-down menu. When
choosing a Service other than Custom from the pull-down menu, an appropriate Hex. value is automatically assigned to the
Service Code box which is dimmed (unavailable).
(2) In this example, we are writing to five parameters. Each parameter being written to requires three contiguous 16-bit words.
Scattered write messages always assume that every parameter being written to is a 32-bit parameter, regardless of its actual
size. Therefore, the Size in Bytes must be set to 30. The data structure format is the same as shown on page 120. Maximum length
is 66 words (132 bytes), which equates to 22 parameters. For parameter numbering, see DPI Parameter Object on page 198 (Class
code 0x93).
(3) See Table 17 on page 106 for limitations of PowerFlex 7-Class drives when using DPI Parameter Object Class code 0x93 for
explicit messaging.
140
Chapter 6
The results of the explicit message appear in the destination tag array N80 (Figure
76). Values of 0 indicate no errors occurred.
Word 0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
...
141
Chapter 6
63 Parameter Number
64 Pad Word
65 Pad Word
63 Parameter Number
64 Parameter Value LSW
65 Parameter Value MSW
Word 0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
...
142
63 Parameter Number
64 Parameter Value LSW
65 Parameter Value MSW
63 Parameter Number
64 Pad Word
65 Pad Word
Chapter
Troubleshooting
Topic
Page
143
144
145
145
145
146
146
149
The adapter has four status indicators. They can be viewed on the adapter or
through the device cover.
Location on device
may vary.
143
Chapter 7
Troubleshooting
Flashing Red
144
Item
Indicator Name
Description
See
PS
page 144
NS
Network Status
page 145
LS1
Link Status 1
page 145
LS2
Link Status 2
page 145
The LED indicates the status of the adapters connection to the device as shown
in the table below.
Cause
Corrective Action
Securely connect the adapter to the drive using the internal interface (ribbon)
No power
cable.
Verify that cables are securely connected and not damaged.
Peripheral is Connected to an incompatible product, Replace cables if necessary.
or no DPI ping events are detected.
Cycle power to the device.
Verify that Host is an Allen-Bradley compatible product.
Requesting DPI I/O Connections
No action required this is normal operation if No DPI IO is enabled
Place the scanner in RUN mode.
Normal Operation (DPI connected) - No I/O, or PLC Program the controller to recognize and transmit I/O to the adapter. Configure
in Program
the adapter for the program in the controller.
Normal behavior if no DPI I/O is enabled.
Normal Operation (DPI connected) - I/O
No action required.
Operational
DPI Problem, Bad CRC of Adapter Parameters or
Replace adapter
Flash Program
Clear faults in the adapter.
Verify that all DPI cables on the drive are securely connected and not
damaged. Replace cables if necessary.
Verify that the DPI drive supports Datalinks.
Configure the adapter to use a Datalink that is not already being used by
another peripheral.
DPI Failure or Failed power-on diagnostic test
Check mode switch settings.
(hardware failure)
Cycle power to the device
If cycling power does not correct the problem, the adapter parameter settings
may have been corrupted. Reset defaults and reconfigure the adapter.
If resetting defaults does not correct the problem, flash the adapter with the
latest firmware release.
Flash update in progress
Troubleshooting
Chapter 7
The LED indicates the status of the adapters connection to the device as shown
in the table below.
Status
Cause
Steady Off
No power OR No IP Address
Flashing Green
Corrective Action
Securely connect the adapter to the drive using the Internal Interface (ribbon)
cable and to the network using an Ethernet cable.
Correctly connect the Ethernet cable to the Ethernet connector.
Set a unique IP address and disable BOOTP using a BOOTP server, or set a
unique IP address by using adapter parameters.
Apply power to the drive (or adapter if mounted in a DPI External Comms Kit).
Place the controller in RUN mode, or apply power to the peer device that will
send I/O.
Program the controller or peer device to recognize and transmit I/O or make a
messaging connection to the adapter.
Configure the adapter for the program in the controller or the I/O from the peer
device.
The LED indicates the status of the adapters connection to the device as shown
in the table below.
Cause
Network at 10M Baud
Network at 100M Baudr
Corrective Action
Normal Operation
Normal Operation
This red/green bicolor LED indicates the status of the network connection as
shown in the table below.
Status
Off
Cause
The adapter is not powered, the
adapter is not properly connected to
the network, the adapter needs an IP
address, or BOOTP is enabled.
Steady Red
Flashing Red
Corrective Actions
Securely connect the adapter to the drive using the Internal
Interface (ribbon) cable and to the network using an Ethernet cable.
Correctly connect the Ethernet cable to the Ethernet connector.
Set a unique IP address and disable BOOTP using a BOOTP server,
or set a unique IP address by using adapter parameters.
Apply power to the drive (or adapter if mounted in a DPI External
Comms Kit).
Configure the adapter to use a unique IP address and cycle power.
Place the scanner in RUN mode, or apply power to the peer device
that will send I/O.
Check the IGMP Snooping/Ethernet Switches for correct operation.
Check the amount of traffic on the network.
145
Chapter 7
Troubleshooting
Status
Flashing Red/
Green
Flashing Green
Cause
The adapter is performing a self-test.
Corrective Actions
No action required.
Steady Green
Place the controller in RUN mode, or apply power to the peer device
that will send I/O.
Program the controller or peer device to recognize and transmit I/O
or make a messaging connection to the adapter.
Configure the adapter for the program in the controller or the I/O
from the peer device.
No action required.
The special switch value of 888 allows the user to return the module to its factory
default configuration. The setting of 888 shall reset all local configuration
parameters on the adapter,
The setting of 888 is useful in situations where the user wishes to decommission
an adapter (but may use it again later, e.g., as a spare module), or when the user
wishes to commission a previously-used module that has unknown configuration
parameters.
When the switches are set to 888, upon the next power up, a module shall behave
as follows:
Return to factory default settings local to the adapter.
Cease communications on all communication ports.
The Port Status LED shall transition to blinking red.
The Network Status LED shall transition to off.
The purpose of the above behavior is to prevent the user from resetting the
module and then never changing the switch setting from 888. Upon the next
power up, the module would simply reset itself again.
Viewing Adapter
Diagnostic Items
146
Troubleshooting
Chapter 7
Example Screen
Main Menu:
Diagnostics
Parameter
Device Select
Device Item #
Reference
Name
Common Logic Cmd
Prod Logic Cmd
Reference
4
5
Feedback
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Datalink A1 In
Datalink A2 In
Datalink B1 In
Datalink B2 In
Datalink C1 In
Datalink C2 In
Datalink D1 In
Datalink D2 In
Datalink A1 Out
Datalink A2 Out
Datalink B1 Out
Datalink B2 Out
Datalink C1 Out
Datalink C2 Out
Datalink D1 Out
Datalink D2 Out
DPI Rx Errors
DPI Rx Error Max
DPI Tx Errors
DPI Tx Error Max
Boot Flash Count
App Flash Count
M-S Input Size
M-S Output Size
Description
The present value of the Common Logic Command being transmitted to the drive by this adapter.
The present value of the Product Logic Command being transmitted to the drive by this adapter from the controller.
The present value of the Reference being transmitted to the drive by this adapter. Note that a 16-bit value will be
sent as the Most Significant Word of the 32-bit field.
The present value of the Common Logic Status being received from the drive by this adapter.
The present value of the Product Logic Status being received from the drive by this adapter to the controller.
The present value of the Feedback being received from the drive by this adapter. Note that a 16-bit value will be
sent as the Most Significant Word of the 32-bit field.
The present value of respective Datalink In being transmitted to the drive by this adapter. (If not using a Datalink,
this parameter should have a value of zero.)
The present value of respective Datalink Out being received from the drive by this adapter. (If the drive indicates a
16-bit datalink size, the value appears in the least significant 16 bits of this diagnostic item, and the most significant
16 bits of this diagnostic item are zero.)
147
Chapter 7
Troubleshooting
No.
Name
31
32
33
34
35
36
HW Addr 1
HW Addr 2
HW Addr 3
HW Addr 4
HW Addr 5
HW Addr 6
37
38
39
40
IP Addr Act 1
IP Addr Act 2
IP Addr Act 3
IP Addr Act 4
Description
Decimal value of each byte in the adapters Ethernet hardware address.
255:255:255:255:255:255
[HW Addr 1]
[HW Addr 2]
[HW Addr 3]
[HW Addr 4]
HW Addr 5]
[HW Addr 6]
Value of each byte in the adapters present IP address. A value of 0 appears if the adapter does not currently have
an IP address.
255.255.255.255
[IP Addr Act 1]
[IP Addr Act 2]
[IP Addr Act 3]
[IP Addr Act 4]
Value of each byte in the adapters present subnet mask. A value of 0 appears if the adapter does not currently
have a subnet mask.
41
42
43
44
Subnet Act 1
Subnet Act 2
Subnet Act 3
Subnet Act 4
255.255.255.255
[Subnet Act 1]
[Subnet Act 2]
[Subnet Act 3]
[Subnet Act 4]
Value of each byte in the adapters present gateway address. A value of 0 appears if the adapter does not currently
have a gateway address.
148
45
46
47
48
Gateway Act 1
Gateway Act 2
Gateway Act 3
Gateway Act 4
49
50
51
52
53
54
55
EN Rx Overruns
EN Rx Packets
EN Rx Errors
EN Tx Packets
EN Tx Errors
Last TCP Reset
Missed IO Pkts
56
OPT Status
57
58
OPT RX Errors
OPT FW Version
255.255.255.255
[Gateway Act 1]
[Gateway Act 2]
[Gateway Act 3]
[Gateway Act 4]
Number of receive buffer overruns reported by the Ethernet hardware.
Number of Ethernet packets that the adapter has received.
Number of receive errors reported by the Ethernet hardware.
Number of Ethernet packets that the adapter has sent.
Number of transmit errors reported by the Ethernet hardware.
Last reason that the adapter reset or rejected a TCP/IP connection.
Number of incoming I/O connection packets that the adapter did not receive.
Operating status of optional I/O board in DPI External Comms Kit. For the meanings of the individual bits, see
Viewing Adapter Diagnostic Items on page 146.
Number of optional I/O board receive errors.
Firmware version of optional I/O board (in DPI External Comms Kit).
Chapter 7
Troubleshooting
The adapter has an event queue to record significant events that occur in the
operation of the adapter. When such an event occurs, an entry is put into the
event queue. You can view the event queue with any of these drive configuration
tools:
LCD PowerFlex 7-Class HIM
Connected Components Workbench software, version 1.02 or later
DriveExplorer software, version 2.01 or later
DriveExecutive software, version 1.01 or later
Other clients using the DPI Fault object
The event queue can contain up to 32 entries. Eventually the event queue will
become full, since its contents are retained through adapter resets. At that point, a
new entry replaces the oldest entry. Only an event queue clear operation or
adapter power cycle will clear the event queue contents.
Resetting the adapter to defaults has no effect on the event queue.
Example Screen
Main Menu:
Diagnostics
Parameter
Device Select
Event Q:
Ping Time Flt
E3
Dgn: Events
View Event Queue
Clear Event
Clr Event Queue
149
Chapter 7
Troubleshooting
Events
Many events in the event queue occur under normal operation. If you encounter
unexpected communications problems, the events may help you or Allen-Bradley
personnel troubleshoot the problem. The following events may appear in the
event queue.
Table 25 - Adapter Events
150
Code
Event
Description
No Event
Device Power Up
Cold/hard boot.
Device Reset
Warm/soft boot.
App Updated
Boot Updated
FATAL Error
No Ping message was received on DPI for longer than the maximum time allowed
10
The debounced DPI Pin ID is read as zero or seven after the peripheral has completed startup.
11
The debounced DPI Pin ID has changed after the peripheral has completed startup.
12
13
14
15
Connected to a SCANport product and peripheral does not support a SCANport mode.
16
17
18
The peripheral has not received a Type 0 status message for longer than the maximum Type 0 time.
19
DPI DL Logon
20
DPI DL Error
The host rejects a login to a data link (e.g., data link not supported or already in use)
21
DPI DL Time
No Datalink status message is received on DPI for longer than the maximum time allowed
22
The peripheral has sent a Soft Control Disable command to the host.
23
The peripheral has sent a Soft Control Enable command to the host.
24
A Client-Server message sent by the peripheral has not completed within one second.
25
31
IP address conflict.
32
33
34
Net IO Close
35
36
Net IO Open
An I/O connection to the peripheral from the network has been opened.
37
Net IO Timeout
An I/O connection from the network to the Peripheral has timed out.
38
39
PCCC IO Close
The device sending PCCC Control messages to the Peripheral has set the PCCC Control Timeout to a value of zero.
Troubleshooting
Chapter 7
Event
Description
40
PCCC IO Open
The Peripheral has begun receiving PCCC Control messages (the PCCC Control Timeout was previously set to a
non-zero value).
41
PCCC IO Timeout
The Peripheral has not received a PCCC control message for longer than the PCCC Control Timeout.
42
The peripheral has sent a Soft Control Enable command to the host.
43
The peripheral has sent a Soft Control Disable command to the host.
44
A Client-Server message sent by the peripheral has not completed within one second.
45
Peer IO Open
Peer IO Timeout
The Peripheral has not received a Peer I/O message for longer
than the Peer I/O Timeout.
46
56
Email Failed
58
Adapter Defaulted
61
Net Link 1 Up
62
63
Net Link 2 Up
64
67
Net Ring Up
68
69
70
DHCP Response
151
Chapter 7
Troubleshooting
Notes:
152
Chapter
This chapter provides instructions on how to monitor the adapter and connected
PowerFlex drive by using the adapters web interface.
Topic
Page
153
153
156
156
157
160
Future enhancements may result in adapter web pages that look different than the
examples shown in this chapter.
After configuring the adapter, you can view its web pages. These pages present
information about the adapter, the device to which it is connected, and other DPI
devices connected to or installed in the device such as a HIM or I/O card.
The adapter can be configured to automatically send email messages to desired
addresses when selected device faults occur and/or are cleared when the adapter
rakes a communication or idle fault action. Bit 0 of Parameter 57-[Web
Features] can be used to protect the configured settings. For more details, see
page 162.
153
Chapter 8
The computer can access the adapter web pages if it is connected to:
The same network as the adapter.
A network with access to the adapters network via a gateway device
(for example, a router).
2. In the Address box, type the IP address of the adapter.
3. Press ENTER.
The adapter web Home Page (Figure 79) appears.
Important: Using the browsers View >Refresh function will always redisplay the adapter home page while viewing any of the
adapters web pages.
Figure 79 - Adapter Web Home Page Example
Description
Allen-Bradley logo
Adapter Title
Rockwell Automation logo This logo is a hyperlink. Click it to view the Rockwell Automation
web Home Page.
154
Chapter 8
Description
Home link
Click this link to view the adapters Home Page (Figure 79).
Click this link to view the host drives Process Display pop-up window
(Figure 81).
Click this folder to expand and view the Port folders for all present
DPI devices, including the drive, adapter, and other devices
connected to the drive such as a HIM.
Diagnostics
Administrative Settings
155
Chapter 8
The Process Display pop-up window dynamically shows the host drives
information. To view this window, click the Process display link in the
navigation pane.
Figure 81 - Example of Process Display Pop-up Window
This folder gives access to the databases, fault and alarm queues and diagnostic
data (if applicable) to all the devices connected to the DPI network.
Each Device on the DPI network has its own folder that has links to module
information, parameters, diagnostic information, fault queues and alarm queue.
The Parameters are further organized into the DPI groups defined for the specific
device.
Figure 82 shows an example of an SMC-50 device acting as the DPI host on port
0 of the DPI network.
Figure 82 - Example of an SMC-50 Controller Acting as DPI Host
Parameters for the SMC-50 can be changed via the parameters web page by
clicking on the Edit button near the bottom of the web page and entering the
correct username and password when the authorization pop up window appears.
156
Chapter 8
Note: PowerFlex drives on the network will not allow parameters to be changed
via the Parameter Web page.
Figure 83 - Example of Parameter Web Page
The diagnostics web page provides the user with Adapter performance on the
network detailing the configuration, status and traffic information about the
EtherNet/IP network communications.
157
Chapter 8
158
Chapter 8
159
Chapter 8
160
Administrative Web pages give the user access to the 20-COMM-ER module for
the purpose of configuring the device for network operation and messaging.
Chapter 8
161
Chapter 8
162
Chapter 8
Description
SMTP Server
Type in the address of the mail server that will be used to deliver
the email messages. (When the IP address is unknown, read the
TIP shown below this table to determine the mail server address.)
TO email recipient
163
Chapter 8
TIP
To stop email messages, uncheck all of the Send an e-mail message when boxes.
Disabling the adapter web pages by setting the Web Pages Switch (SW2 in Figure 2) to the Disable
Web position will not stop the adapter from sending email messages.
164
Password Configuration
Chapter 8
The Password Configuration Link allows the user to set or change a password.
The factory default configuration is:
Username: Administrator
Password: <none>
no password is set
165
Chapter 8
Notes:
166
Chapter
Topic
Page
167
For more information, see the DPI External Communications Kit Installation
Instructions, publication 20COMM-IN001.
167
Chapter 9
168
Appendix
Specifications
Communications
Topic
Page
Communications
169
Electrical
169
Mechanical
170
Environmental
170
Regulatory Compliance
170
Network
Protocol
EtherNet/IP
Data Rates
Connection Limits
30 TCP connections
Two 'class 1' connections and 14 'class 3' connections are supported.
The following activities use a CIP connection:
Explicit messaging where connected is chosen (for example, in a
checkbox in RSLogix 5000)
The following activities do not use a CIP connection:
Explicit messaging-based control using PCCC or the Register or
Assembly objects, including the PLC-5, SLC 500, and MicroLogix 1100
examples in Chapter 4
Explicit messaging where connected is not chosen, which is typically
the default
Requested Packet
Interval (RPI)
Electrical
2 ms minimum
Drive
Protocol
Data Rates
DPI
125 kbps or 500 kbps
Consumption
Drive
Network
169
Appendix A
Specifications
Mechanical
Environmental
Regulatory Compliance
Dimensions
Height
Length
Width
19 mm (0.75 inches)
86 mm (3.39 inches)
78.5 mm (3.09 inches)
Shipping Weight
Temperature
Operating
Storage
-1050 C (14122 F)
-4085 C (-40185 F)
Relative Humidity
595% non-condensing
Atmosphere
Certification
Drive Specification
SMC Specification
UL
UL508C
UL508
cUL
CE
EN61800-3
EN60947-4-2
CTick
EN61800-3
EN60947-4-2
170
Appendix
Adapter Parameters
Topic
Page
171
Parameter List
171
Numbering Scheme
HIM
Connected Components Workbench software
DriveExplorer
DriveExecutive
Explicit Messaging
Parameter List
Parameter
No.
Details
01
[DPI Port]
Default:
Minimum:
Maximum:
Type:
5
0
7
Read Only
Default:
Values:
0 = 125 kbps
0 = 125 kbps
1 = 500 kbps
Read Only
03
[BOOTP/DHCP]
Configures the adapter to use BOOTP so that you
can set its IP address, subnet mask, and gateway
address with a BOOTP server.
Type:
Default:
Values:
1 = Enabled
0 = Disabled
1 = Enabled
Type:
Read/Write
Reset Required: Yes
171
Appendix B
Adapter Parameters
Parameter
No.
Details
04
05
06
07
Default:
Default:
Default:
Default:
Minimum:
Maximum:
Type:
Reset Required:
0
0
0
0
0
255
Read/Write
Yes
Default:
Default:
Default:
Default:
Minimum:
Maximum:
Type:
Reset Required:
0
0
0
0
0
255
Read/Write
Yes
Default:
Default:
Default:
Default:
Minimum:
Maximum:
Type:
Reset Required:
0
0
0
0
0
255
Read/Write
Yes
[Subnet Cfg 1]
[Subnet Cfg 2]
[Subnet Cfg 3]
[Subnet Cfg 4]
Sets the subnet mask bytes for the adapters
network address when Parameter 03 - [BOOTP] is
set to 0 (Disabled).
255 . 255 . 255 . 255
[Subnet Cfg 1]
[Subnet Cfg 2]
[Subnet Cfg 3]
[Subnet Cfg 4]
12
13
14
15
[Gateway Cfg 1]
[Gateway Cfg 2]
[Gateway Cfg 3]
[Gateway Cfg 4]
Sets the gateway address bytes for the adapters
network address when Parameter 03 - [BOOTP] is
set to 0 (Disabled).
255 . 255 . 255 . 255
[Gateway Cfg 1]
[Gateway Cfg 2]
[Gateway Cfg 3]
[Gateway Cfg 4]
16
172
Default:
Values:
0 = Autodetect
0 = Autodetect
1 = 10 Mbps Full
2 = 10 Mbps Half
3 = 100 Mbps Full
4 = 100 Mbps Half
Type:
Read/Write
Reset Required: Yes
Parameter
No.
Details
17
Default:
Values:
Type:
18
19
Default:
Values:
0 = Autodetect
0 = Autodetect
1 = 10 Mbps Full
2 = 10 Mbps Half
3 = 100 Mbps Full
4 = 100 Mbps Half
Type:
Read/Write
Reset Required: Yes
Default:
Values:
Type:
20
[Ref/Fdbk Size]
Displays the size of the Reference/Feedback. The
drive determines the size of the Reference/
Feedback.
21
[Datalink Size]
Displays the size of each Datalink word. The drive
determines the size of Datalinks.
22
[Reset Module]
No action if set to 0 (Ready). Resets the adapter if
set to 1 (Reset Module). Restores the adapter to
its factory default settings if set to 2 (Set Defaults).
This parameter is a command. It will be reset to 0
(Ready) after the command has been performed.
0 = No Link
0 = No Link
1 = 10 Mbps Full
2 = 10 Mbps Half
3 = 100 Mbps Full
4 = 100 Mbps Half
Read Only
Default:
Values:
Type:
Default:
Values:
Type:
0 = No Link
0 = No Link
1 = 10 Mbps Full
2 = 10 Mbps Half
3 = 100 Mbps Full
4 = 100 Mbps Half
Read Only
0 = 16-bit
0 = 16-bit
1 = 32-bit
Read Only
0 = 16-bit
0 = 16-bit
1 = 32-bit
Read Only
Default:
Values:
0 = Ready
0 = Ready
1 = Reset Module
2 = Set Defaults
Type:
Read/Write
Reset Required: No
173
Appendix B
Adapter Parameters
Parameter
No.
Details
23
Default:
Values:
Sets the action that the adapter and drive will take
if the adapter detects that I/O communication has
been disrupted. This setting is effective only if I/O
that controls the drive is transmitted through the
adapter. When communication is re-established,
the drive will automatically receive commands over
the network again.
0 = Fault
0 = Fault
1 = Stop
2 = Zero Data
3 = Hold Last
4 = Send Flt Cfg
Type:
Read/Write
Reset Required: No
ATTENTION: Risk of injury or equipment damage exists. Parameter 23 [Comm Flt Action] lets you determine the action of the adapter and connected
drive if I/O communication is disrupted. By default, this parameter faults the
drive. You can set this parameter so that the drive continues to run, however,
precautions should be taken to verify that the setting of this parameter does not
create a risk of injury or equipment damage. When commissioning the drive,
verify that your system responds correctly to various situations (for example, a
disconnected cable).
24
Default:
Values:
0 = Fault
0 = Fault
1 = Stop
2 = Zero Data
3 = Hold Last
4 = Send Flt Cfg
Type:
Read/Write
Reset Required: No
174
Datalink B
Datalink A
Cmd/Ref
Default
Bit
Datalink C
Bit
Definition
Datalink D
xxx0 0001
0 = I/O Disabled
1 = I/O Enabled
Type:
Read/Write
Reset Required: Yes
Not Used
Default:
Sets the I/O that is transferred through the adapter. Bit Values:
Not Used
Not Used
25
x
7
x
6
x
5
0
4
0
3
0
2
0
1
1
0
Parameter
No.
Details
26
Default:
Bit Values:
27
Datalink D
Datalink C
Datalink B
Datalink A
Cmd/Ref
Default
Bit
Not Used
Bit
Definition
Not Used
Type:
Not Used
xxx0 0001
0 = I/O Disabled
1 = I/O Enabled
Read Only
x
7
x
6
x
5
0
4
0
3
0
2
0
1
1
0
Default:
Minimum:
Maximum:
Type:
Reset Required:
Default:
Minimum:
Maximum:
Type:
Reset Required:
0
0
4294967295
Read/Write
No
175
Appendix B
Adapter Parameters
Parameter
No.
Details
29
30
31
32
33
34
35
36
Default:
Default:
Default:
Default:
Default:
Default:
Default:
Default:
Minimum:
Maximum:
Type:
Reset Required:
0
0
0
0
0
0
0
0
0
4294967295
Read/Write
No
Datalink C Input
Datalink B Input
Datalink A Input
Cmd/Ref
0
3
0
2
0
1
1
0
Datalink B Output
Datalink A Output
Cmd/Ref
xxx0 0001
0 = I/O disabled
1 = I/O enabled
Type:
Read/Write
Reset Required: Yes
Default
Bit
[Ref Adjust]
0
4
Default:
Bit Values:
Bit
Definition
39
x
5
Datalink C Output
x
6
Datalink D Output
[M-S Output]
x
7
Not Used
38
Datalink D Input
Default
Bit
Not Used
Bit
Definition
Not Used
xxx0 0001
0 = I/O disabled
1 = I/O enabled
Type:
Read/Write
Reset Required: Yes
Not Used
Default:
Bit Values:
Not Used
[M-S Input]
Not Used
37
x
7
x
6
x
5
0
4
0
3
0
2
0
1
1
0
Default:
Minimum:
Maximum:
Type:
Reset Required:
100.00%
0.00%
200.00%
Read/Write
No
176
Parameter
No.
Details
40
41
[Peer A Input]
[Peer B Input]
Default:
Default:
Values:
43
0 = Off
0 = Off
0 = Off
1 = Cmd/Ref
2 = Datalink A Input
3 = Datalink B Input
4 = Datalink C Input
5 = Datalink D Input
Type:
Read/Write
Reset Required: No
Default:
Minimum:
Maximum:
Values:
Default:
Values:
0 = Fault
0 = Fault
1 = Stop
2 = Zero Data
3 = Hold Last
4 = Send Flt Cfg
Type:
Read/Write
Reset Required: No
177
Appendix B
Adapter Parameters
Parameter
No.
Details
44
45
46
47
Default:
Default:
Default:
Default:
Minimum:
Maximum:
Type:
Reset Required:
0
0
0
0
0
255
Read/Write
No
Default:
Minimum:
Maximum:
Type:
Reset Required:
10.00 Seconds
0.01 Seconds
10.00 Seconds
Read/Write
No
49
50
Default:
Values:
0 = Off
0 = Off
1 = On
Type:
Read/Write
Reset Required: No
Default:
Values:
Type:
178
0 = Off
0 = Off
1 = Waiting
2 = Running
3 = Faulted
Read Only
Parameter
No.
Details
51
52
[Peer A Output]
[Peer B Output]
Default:
Default:
Values:
53
54
55
0 = Off
0 = Off
0 = Off
1 = Cmd/Ref
2 = Datalink A Input
3 = Datalink B Input
4 = Datalink C Input
5 = Datalink D Input
6 = Datalink A Output
7 = Datalink B Output
8 = Datalink C Output
9 = Datalink D Output
Type:
Read/Write
Reset Required: No
Default:
Values:
0 = Off
0 = Off
1 = On
Type:
Read/Write
Reset Required: No
Default:
Minimum:
Maximum:
Type:
Reset Required:
10.00 Seconds
0.01 Seconds
10.00 Seconds
Read/Write
No
Default:
Minimum:
Maximum:
Type:
Reset Required:
1
1
16
Read/Write
No
Default:
Values:
0 = Disabled
0 = Disabled
1 = Enabled
Read Only
Bit
Definition
Default
Bit
E-mail Cfg
xxxx xxx0
0 = Disabled
1 = Enabled
Type:
Read/Write
Reset Required: No
Not Used
Default:
Bit Values:
Not Used
Not Used
[Web Features]
Not Used
57
Type:
Not Used
Not Used
[Web Enable]
Not Used
56
x
7
x
6
x
5
x
4
x
3
x
2
x
1
1
0
179
Appendix B
Adapter Parameters
Notes:
180
Appendix
EtherNet/IP Objects
This appendix presents information about the EtherNet/IP objects that can be
accessed using Explicit Messages. For information on the format of Explicit
Messages and example ladder logic programs, refer to Chapter 6, Using Explicit
Messaging.
Object
Class Code
Page
Hex.
Dec.
Identity Object
0x01
182
Assembly Object
0x04
183
Register Object
0x07
Parameter Object
0x0F
15
0x10
0x47
TIP
Object
Class Code
Page
Hex.
Dec.
0x92
146
196
0x93
147
198
184
0x97
151
204
185
0x98
152
206
16
188
0x99
153
207
71
189
0x9B
155
209
0x48
72
190
0xF5
245
211
0x67
103
190
0xF6
246
213
See the EtherNet/IP specification for more information about EtherNet/IP objects.
Information about the EtherNet/IP specification is available on the ODVA web site (http:/
/www.odva.org).
181
Appendix C
EtherNet/IP Objects
Identity Object
Description
8-bit value -- low bit is true or false
Array of n bits
8-bit unsigned integer
32-bit parameter value - sign extended if necessary
32-bit signed integer
32-bit unsigned integer
16-bit signed integer
64-bit unsigned integer
32-bit floating point
1-byte length indicator + that many characters
8-bit signed integer
Array of n characters
Structure name only - no size in addition to elements
8 or 16-bit character
32-bit unsigned integer
16-bit unsigned integer
8-bit unsigned integer
16-bit unsigned integer
Class Code
Hexadecimal
0x01
Decimal
1
Services
Service Code
0x05
0x0E
0x01
Implemented for:
Class
Instance
No
Yes
Yes
Yes
Yes
Yes
Service Name
Reset
Get_Attribute_Single
Get_Attributes_All
Instances
The number of instances depends on the number of components in the device
connected to the adapter. This number of components can be read in Instance 0,
Attribute 2.
Instance
0
1
215
182
Description
Class
Host
Peripherals on Ports 114
Class Attributes
Attribute ID
2
Access Rule
Get
Name
Max Instance
Data Type
WORD
Description
Total number of instances
Instance Attributes
Attribute ID
1
2
3
4
Assembly Object
Access Rule
Get
Get
Get
Get
Get
6
7
8
9
Get
Get
Get
Get
Name
Vendor ID
Device Type
Product Code
Revision:
Major
Minor
Status
Data Type
WORD
WORD
WORD
STRUCT of:
BYTE
BYTE
WORD
Serial Number
Product Name
State
Configuration
Consistency Value
DWORD
SHORT_STRING
USINT
UINT
Description
1 = Allen-Bradley
123
Number identifying product name and rating
Value varies
Value varies
Bit 0 = Owned
Bit 8 = Minor recoverable fault
Bit 10 = Major recoverable fault
Unique 32-bit number
Product name and rating
Always returns 3 (Operational)
For the Host (Instance #1) the CCV is determined from the Host's
NVS Checksum along with 20-COMM-ER's NVS Checksum.
For DPI Peripherals (Instances 2-15) the CCV is from the
peripheral's NVS Checksum only.
Class Code
Hexadecimal
0x04
Decimal
4
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
Instance
1
2
191
192
Description
All I/O data being read from the DPI device (read-only)
All I/O data written to the DPI device (read/write)
Input only
Listen only
Class Attributes
Attribute ID
1
2
100
Access Rule
Get
Get
Set
Name
Revision
Max Instance
Control Timeout
Data Type
WORD
WORD
WORD
Description
2
2
Control timeout in seconds
183
Appendix C
EtherNet/IP Objects
Instance Attributes
Attribute ID
1
Access Rule
Get
Get
3
4
Conditional (1)
Get
Name
Number of
Members
Member List
Data
Size
Data Type
WORD
Description
1
ARRAY of STRUCT:
WORD
WORD
Packed EPATH
Array of Bits
WORD
(1) For instance 1, access rule for the data attribute is Get. For instance 2, it is Get/Set.
Important: Setting an assembly object attribute can be done only when the
Control Timeout (class attribute 100) has been set to a non-zero
value.
Register Object
Class Code
Hexadecimal
0x07
Decimal
7
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
Instance
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Description
All I/O data being read from the DPI device (read-only)
All I/O data written to the DPI device (read/write)
Logic Status and Feedback data (read-only)
Logic Command and Reference data (read/write)
Datalink A (input data from device to scanner) (read only)
Datalink A (output data from scanner to device) (read/write)
Datalink B (input data from device to scanner) (read only)
Datalink B (output data from scanner to device) (read/write)
Datalink C (input data from device to scanner) (read only)
Datalink C (output data from scanner to device) (read/write)
Datalink D (input data from device to scanner) (read only)
Datalink D (output data from scanner to device) (read/write)
Logic Status and Feedback Data (read-only)
Mask (1) (read/write)
Logic Status (read-only)
Logic Command (read/write)
Feedback (read-only)
Reference (read/write)
(1) The mask command word is set to the value of the first word of the data where there are ones in the second word of the data.
Command = (word 1 and not word 2) or (word 1 and word 2). This only controls specified bits in the Logic Command data to the DPI
product and does not change the Reference value.
184
Class Attributes
Attribute ID
100
Access Rule
Set
Name
Control Timeout
Data Type
WORD
Description
Control timeout in seconds
Description
If set to 1, then attribute 4 may contain invalid data.
0 = good
1 = bad
Direction of data transfer
0 = Producer Register (drive to network)
1 = Consumer Register (network to drive)
Size of register data in bits
Data to be transferred
Instance Attributes
Attribute ID
1
Access Rule
Get
Name
Bad Flag
Data Type
BOOL
Get
Direction
BOOL
3
4
Get
Conditional (1)
Size
Data
WORD
ARRAY of BITS
(1) For this attribute, the Access Rule is Get if Direction = 0. The Access Rule is Set if Direction = 1.
Important: Setting a Register object attribute can be done only when the
Control Timeout (class attribute 100) has been set to a non-zero
value.
Parameter Object
Class Code
Hexadecimal
0x0F
Decimal
15
Services
Service Code
0x01
0x05
0x0E
0x10
0x4B
Implemented for:
Class
Yes
Yes
Yes
Yes
No
Service Name
Instance
Yes
No
Yes
Yes
Yes
Get_Attributes_All
Reset
Get_Attribute_Single
Set_Attribute_Single
Get_Enum_String
185
Appendix C
EtherNet/IP Objects
Instances
The number of instances depends on the number of parameters in the DPI drive.
The adapter parameters are appended to the list of drive parameters. The total
number of parameters can be read in Instance 0, Attribute 2.
n
n+1
Description
Class Attributes
Drive Parameter 1 Attributes
Instance
0
1
n+m
Class Attributes
186
Attribute ID
1
2
8
Access Rule
Get
Get
Get
Name
Revision
Max Instance
Parameter Class Descriptor
Data Type
WORD
WORD
WORD
9
10
Get
Set
WORD
BYTE
Description
1
Number of parameters
0 = False, 1 = True
Bit 0 = Supports parameter instances
Bit 1 = Supports full attributes
Bit 2 = Must do NVS save command
Bit 3 = Parameters are stored in NVS
0
0 = English
1 = French
2 = Spanish
3 = Italian
4 = German
5 = Japanese
6 = Portuguese
7 = Mandarin Chinese
8 = Russian
9 = Dutch
Instance Attributes
Attribute ID Access Rule
(1)
1
2
Get
Name
Parameter Value
Link Path Size
Data Type
Description
(2)
(3)
BYTE
0 = No link specified
n = The size of Attribute 3 in bytes
3
4
Get
Get
Link Path
Descriptor
WORD
Get
Data Type
BYTE
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Get
Data Size
Parameter Name String
Units String
Help String
Minimum Value
Maximum Value
Default Value
Scaling Multiplier
Scaling Divisor
Scaling Base
Scaling Offset
Multiplier Link
Divisor Link
Base Link
Offset Link
Decimal Precision
BYTE
SHORT_STRING
SHORT_STRING
SHORT_STRING
(3)
(2)
(3)
(2)
(3)
(4)
0 = False, 1 = True
Bit 1 = Supports ENUMs
Bit 2 = Supports scaling
Bit 3 = Supports scaling links
Bit 4 = Read only
Bit 5 = Monitor
Bit 6 = Extended precision scaling
1 = WORD (16-bit)
2 = UINT (16-bit)
3 = INT (16-bit)
5 = SINT
6 = DINT
8 = USINT
9 = UDINT
11 = REAL
22 = SHORT_STRING
24 = BYTE
25 = DWORD
(3)
(3)
Null string
(2)
(3)
WORD
WORD
WORD
WORD
WORD
WORD
WORD
WORD
BYTE
(3)
(3)
(3)
(3)
(3)
(3)
(3)
(3)
(3)
187
Appendix C
EtherNet/IP Objects
Class Code
Hexadecimal
0x10
Decimal
16
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
No
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
The number of instances depends on the number of groups in the device. A group
of adapter parameters is appended to the list of groups in the device. The total
number of groups can be read in Instance 0, Attribute 2.
Description
Class Attributes
Drive Group 1 Attributes
Number
0
1
n
n+1
Class Attributes
Attribute ID
1
2
8
Access Rule
Get
Get
Set
Name
Parameter group version
Max Instance
Native Language
Data Type
WORD
WORD
BYTE
Description
1
Total number of groups
0 = English
1 = French
2 = Spanish
3 = Italian
4 = German
5 = Japanese
6 = Portuguese
7 = Mandarin Chinese
8 = Russian
9 = Dutch
Instance Attributes
Access Rule
Get
Get
Get
Get
Get
Name
Group Name String
Number of Members in Group
1st Parameter Number in Group
2nd Parameter Number in Group
Attribute ID
1
2
3
4
n
Data Type
SHORT_STRING
WORD
WORD
WORD
WORD
188
Description
Group name
Number of parameters in group
(1)
(1)
(1)
Class Code
Hexadecimal
0x0047
Decimal
71
Services
The following common services will be implemented for the DLR Object.
Service Code
0x01
0x0E
Implemented for:
Class
Instance
No
Yes
Yes
Yes
Service Name
Get_Attributes_All
Get_Attribute_Single
Instances
Get_Attribute_ALL is implemented for instances and Get_Attribute_Single for
both class and instance.
The adapter supports one instance of the TCP/IP Interface object.
Number
0
1
Description
Class Attributes
Object Attributes
Class Attributes
The following class attributes will be supported for the DLR Object:
Attribute ID
1
Access Rule
Get
Name
Revision
Data Type
UNIT
Description
2
Instance Attributes
A single instance (instance 1) will be supported.
Attribute ID
1
Access Rule
Get
Name
Network Topology
Data Type
USINT
Get
Network Status
USINT
10
Get
12
Get
Capability Flags
STRUCT of:
UDINT
Array of 6
USINT
DWORD
Description
0 = Linear
1 = Ring
0 = Normal
1 = Ring Fault
2 = Unexpected Loop Detect
3 = Partial Network Fault
4 = Rapid Fault/Restore Cycle
Ring supervisor
0x00000002
189
Appendix C
EtherNet/IP Objects
Class Code
Hexadecimal
0x0048
Decimal
72
Services
Service Code
Implemented for:
Class
Instance
Yes
Yes
No
Yes
0x0E
0x10
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
Get_Attribute_Single is implemented on both class and instance.
Set_Attribute_Single is implemented on instances. Get_Attribute_All is not
implemented
The adapter supports one instance of the TCP/IP Interface object.
Number
0
1
Description
Class Attributes
Object Attributes
Class Attributes
Attribute ID
1
Access Rule
Get
Name
Revision
Data Type
UINT
Value
1
Instance Attributes
PCCC Object
Attribute ID
1
Access Rule
Set
Name
802.1Q Tag Enable
Data Type
USINT
4
5
6
7
8
Set
Set
Set
Set
Set
DSCP Urgent
DSCP Scheduled
DSCP High
DSCP Low
DSCP Explici
USINT
USINT
USINT
USINT
USINT
Description
0 = Disable (default)
1 = Enable
Default = 55
Default = 47
Default = 43
Default = 31
Default = 27
Class Code
Hexadecimal
0x67
Decimal
103
Services
Service Code
0x4B
0x4C
190
Implemented for:
Class
Instance
No
Yes
No
Yes
Service Name
Execute_PCCC
Execute_DH+
Instances
Supports Instance 1.
Class Attributes
Not supported.
Instance Attributes
Not supported.
Data Type
USINT
UINT
UDINT
Description
Length of requestor ID
Vendor number of requestor
ASA serial number of requestor
Product
Specific
USINT
USINT
UINT
USINT
ARRAY of
USINT
Response
Name
Length
Vendor
Serial
Number
Other
CMD
STS
TNSW
EXT_STS
PCCC_
results
Data Type
USINT
UINT
UDINT
Description
Length of requestor ID
Vendor number of requestor
ASA serial number of requestor
Product
Specific
USINT
USINT
UINT
USINT
ARRAY of
USINT
Data Type
UINT
USINT
USINT
UINT
USINT
USINT
USINT
USINT
UINT
USINT
ARRAY of
USINT
Description
Destination Link ID
Destination Station number
Destination User number
Source Link ID
Source Station number
Source User number
Command byte
0
Transport word
Function code; not used for all CMDs
CMD/FNC specific parameters
Response
Name
DLink
DSta
DUser
SLink
SSta
SUser
CMD
STS
TNSW
EXT_STS
PCCC_
results
Data Type
UINT
USINT
USINT
UINT
USINT
USINT
USINT
USINT
UINT
USINT
ARRAY of
USINT
Description
Destination Link ID
Destination Station number
Destination User number
Source Link ID
Source Station number
Source User number
Command byte
Status byte
Transport word. Same value as the request.
Extended status; not used for all CMDs
CMD/FNC specific result data
191
Appendix C
EtherNet/IP Objects
FNC
0x03
0x67
0x68
0x95
0xA2
0xAA
0xA1
0xA9
0x00
0x01
Description
Identify host and some status
PLC-5 typed write
PLC-5 typed read
Encapsulate other protocol
SLC 500 protected typed read with 3 address fields
SLC 500 protected typed write with 3 address fields
SLC 500 protected typed read with 2 address fields
SLC 500 protected typed write with 2 address fields
Word range read
Word range write
For more information regarding PCCC commands, see DF1 Protocol and
Command Set Manual, publication 1770-6.5.16.
N-Files
N-File
N40
Description
This N-file lets you use Emulated Block Transfer messages to read and write many types of DPI messages.
To use Emulated Block Transfer messages, you send a Write message to N40:0N40:63, wait until the
adapter responds with a reply message, and then read the response data in N40:0N40:63 with a Read
message.
For details about Block Transfer messages and the data required for each byte in the N-File, see the Remote
I/O Adapter User Manual, publication 20COMM-UM004.
Bits
N40:0
N40:1
N40:2
N40:3
N40:4
N40:5
N40:6
N40:63
N41
192
Bits 158 are the Most Significant Byte. Bits 70 are the Least Significant Byte.
Write
Read
15
0
15
0
0x00
Length (in Bytes)
0x00
Length (in Bytes)
DPI Port
0x81
Status Size
Status Type
0x00
CIP Service
Data
(length varies based on message)
CIP Class
CIP Instance
CIP Attribute
Data
(length varies based on message)
This N-file lets you read and write control I/O messages. You can write control I/O messages only when all
of the following conditions are true:
The adapter is not receiving I/O from a scanner. For example, there is no scanner on the network, the
scanner is in idle (program) mode, the scanner is faulted, or the adapter is not mapped to the scanner.
The adapter is not receiving peer I/O from another adapter.
The value of N42:3 is set to a non-zero value.
Write
Read
N-File
N41:0
N41:1
N41:2
N41:3
N41:4
N41:5
N41:6
N41:7
N41:8
N41:9
N41:10
N41:11
N41:12
N41:13
N41:14
N41:15
N41:16
N41:17
N41:18
N42
N42:3
N42:7
N42:8
Description
Logic Status Word
Logic Command Word
Feedback (least significant word)
Reference (least significant word)
Feedback (most significant word)
Reference (most significant word)
Datalink A1 (least significant word)
Datalink A1 (least significant word)
Datalink A1 (most significant word)
Datalink A1 (most significant word)
Datalink A2 (least significant word)
Datalink A2 (least significant word)
Datalink A2 (most significant word)
Datalink A2 (most significant word)
Datalink B1 (least significant word)
Datalink B1 (least significant word)
Datalink B1 (most significant word)
Datalink B1 (most significant word)
Datalink B2 (least significant word)
Datalink B2 (least significant word)
Datalink B2 (most significant word)
Datalink B2 (most significant word)
Datalink C1 (least significant word)
Datalink C1 (least significant word)
Datalink C1 (most significant word)
Datalink C1 (most significant word)
Datalink C2 (least significant word)
Datalink C2 (least significant word)
Datalink C2 (most significant word)
Datalink C2 (most significant word)
Datalink D1 (least significant word)
Datalink D1 (least significant word)
Datalink D1 (most significant word)
Datalink D1 (most significant word)
Datalink D2 (least significant word)
Datalink D2 (least significant word)
Datalink D2 (most significant word)
Datalink D2 (most significant word)
This N-file lets you read and write some values configuring the port.
Time-out (read/write): Time (in seconds) allowed between messages to the N41 file. If the adapter does
not receive a message in the specified time, it performs the fault action configured in its [Comm Flt Action]
parameter. A valid setting is between 1 and 32767 seconds (520 seconds is recommended).
Adapter Port Number (read only): DPI port on the drive to which the adapter is connected.
Peer Adapters (read only): Bit field of devices having DPI Peer capabilities.
193
Appendix C
EtherNet/IP Objects
N45
N45:0
N45:1
N45:2
N45:3
N45:4
N45:5
N45:6
N45:7
N45:8
N45:9
N45:10
N45:11
N45:12
N45:13
N45:14
N45:15
N45:16
N45:17
N45:18
N45:19
N45:20
N45:21
N45:22
N45:23
N45:24
N45:25
N45:26
N45:27
N45:28
N45:29
N45:30
N45:31
N45:32
N45:33
N45:34
N45:35
This N-file lets you read and write control I/O messages. You can write control I/O messages only when
all of the following conditions are true:
The adapter is not receiving I/O from a scanner. For example, there is no scanner on the network, the
scanner is in idle (program) mode, the scanner is faulted, or the adapter is not mapped to the scanner.
The adapter is not receiving peer I/O from another adapter.
The value of N42:3 is set to a non-zero value.
Write
Read
Logic Status (least significant)
Logic Command (least significant)
Logic Status (most significant)
Logic Command (most significant)
Feedback (least significant)
Reference (least significant)
Feedback (most significant)
Reference (most significant)
DL To Net 01 (least significant)
DL From Net 01 (least significant)
DL To Net 01 (most significant)
DL From Net 01 (most significant)
DL To Net 02 (least significant)
DL From Net 02 (least significant)
DL To Net 02 (most significant)
DL From Net 02 (most significant)
DL To Net 03 (least significant)
DL From Net 03 (least significant)
DL To Net 03 (most significant)
DL From Net 03 (most significant)
DL To Net 04 (least significant)
DL From Net 04 (least significant)
DL To Net 04 (most significant)
DL From Net 04 (most significant)
DL To Net 05 (least significant)
DL From Net 05 (least significant)
DL To Net 05 (most significant)
DL From Net 05 (most significant)
DL To Net 06 (least significant)
DL From Net 06 (least significant)
DL To Net 06 (most significant)
DL From Net 06 (most significant)
DL To Net 07 (least significant)
DL From Net 07 (least significant)
DL To Net 07 (most significant)
DL From Net 07 (most significant)
DL To Net 08 (least significant)
DL From Net 08 (least significant)
DL To Net 08 (most significant)
DL From Net 08 (most significant)
DL To Net 09 (least significant)
DL From Net 09 (least significant)
DL To Net 09 (most significant)
DL From Net 09 (most significant)
DL To Net 10 (least significant)
DL From Net 10 (least significant)
DL To Net 10 (most significant)
DL From Net 10 (most significant)
DL To Net 11 (least significant)
DL From Net 11 (least significant)
DL To Net 11 (most significant)
DL From Net 11 (most significant)
DL To Net 12 (least significant)
DL From Net 12 (least significant)
DL To Net 12 (most significant)
DL From Net 12 (most significant)
DL To Net 13 (least significant)
DL From Net 13 (least significant)
DL To Net 13 (most significant)
DL From Net 13 (most significant)
DL To Net 14 (least significant)
DL From Net 14 (least significant)
DL To Net 14 (most significant)
DL From Net 14 (most significant)
DL To Net 15 (least significant)
DL From Net 15 (least significant)
DL To Net 15 (most significant)
DL From Net 15 (most significant)
DL To Net 16 (least significant)
DL From Net 16 (least significant)
DL To Net 16 (most significant)
DL From Net 16 (most significant)
194
...
...
N150:01
N150:2249
N151:0249
N152:0249
N153:0249
Description
These N-files let you read and write parameter values in DPI Port 0 (the host PowerFlex drive) as 32bit double words. You can interpret the data in various ways (for example, 32-bit real, 32-bit integer)
To read a parameter, you need to send a message with two elements. For example, to read parameter
1, read two elements beginning at N150:2. As another example, to read parameters 26, read ten
elements beginning at N150:4.
Number of parameters in the drive
Drive parameters 1124
Drive parameters 125249
Drive parameters 250374
Drive parameters 375499
N199:0249
N-File
N201N212
Description
These N-files let you read and write values to DPI and Host parameters in Ports 114 (for example, a
HIM or adapter) as 32-bit double words. You can interpret the data in various ways (for example, 32bit real, 32-bit integer) To read a parameter, you need to send a message with two elements. For
example, to read parameter 1 in the peripheral connected to DPI port 1, read two elements beginning
at N201:2. As another example, to read parameters 26 in the peripheral connected to DPI port 5
(the adapter), read ten elements beginning at N209:4.
Number of parameters in the DPI peripheral at DPI port 1
N201:01
N201:2249 Parameters 1124 in the DPI peripheral at DPI port 1
N202:0249 Parameters 125249 in the DPI peripheral at DPI port 1
Number of parameters in the DPI peripheral at DPI port 2
N203:01
N203:2249 Parameters 1124 in the DPI peripheral at DPI port 2
N204:0249 Parameters 125249 in the DPI peripheral at DPI port 2
Number of parameters in the DPI peripheral at DPI port 3
N205:01
N205:2249 Parameters 1124 in the DPI peripheral at DPI port 3
N206:0249 Parameters 125249 in the DPI peripheral at DPI port 3
Number of parameters in the DPI peripheral at DPI port 4
N207:01
N207:2249 Parameters 1124 in the DPI peripheral at DPI port 4
N208:0249 Parameters 125249 in the DPI peripheral at DPI port 4
Number of parameters in the DPI peripheral at DPI port 5
N209:01
N209:2249 Parameters 1124 in the DPI peripheral at DPI port 5
N210:0249 Parameters 125249 in the DPI peripheral at DPI port 5
Number of parameters in the DPI peripheral at DPI port 6
N211:01
N211:2249 Parameters 1124 in the DPI peripheral at DPI port 6
N212:0249 Parameters 125249 in the DPI peripheral at DPI port 6
The following N-Files are supported only when the adapter is used with a PowerFlex 750-Series drive.
Number of parameters in the DPI peripheral at DPI port 7
N213:01
N213:2249 Parameters 1124 in the DPI peripheral at DPI port 7
N214:0249 Parameters 125249 in the DPI peripheral at DPI port 7
Number of parameters in the DPI peripheral at DPI port 8
N215:01
N215:2249 Parameters 1124 in the DPI peripheral at DPI port 8
N216:0249 Parameters 125249 in the DPI peripheral at DPI port 8
Number of parameters in the DPI peripheral at DPI port 9
N217:01
N217:2249 Parameters 1124 in the DPI peripheral at DPI port 9
N218:0249 Parameters 125249 in the DPI peripheral at DPI port 9
Number of parameters in the DPI peripheral at DPI port 10
N219:01
N219:2249 Parameters 1124 in the DPI peripheral at DPI port 10
N220:0249 Parameters 125249 in the DPI peripheral at DPI port 10
Number of parameters in the DPI peripheral at DPI port 11
N221:01
N221:2249 Parameters 1124 in the DPI peripheral at DPI port 11
N222:0249 Parameters 125249 in the DPI peripheral at DPI port 11
Number of parameters in the DPI peripheral at DPI port 12
N223:01
N223:2249 Parameters 1124 in the DPI peripheral at DPI port 12
N224:0249 Parameters 125249 in the DPI peripheral at DPI port 12
Number of parameters in the DPI peripheral at DPI port 13
N225:01
N225:2249 Parameters 1124 in the DPI peripheral at DPI port 13
N226:0249 Parameters 125249 in the DPI peripheral at DPI port 13
Number of parameters in the DPI peripheral at DPI port 14
N227:01
N227:2249 Parameters 1124 in the DPI peripheral at DPI port 14
N228:0249 Parameters 125249 in the DPI peripheral at DPI port 14
195
Appendix C
EtherNet/IP Objects
Class Code
Hexadecimal
0x92
Decimal
146
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
The number of instances depends on the number of components in the device.
The total number of components can be read in Instance 0, Class Attribute 4.
Description
Class Attributes (Drive)
Drive Component 1
Drive Component 2
Example
0
1
2
16384
16385
Device
Host
Adapter
DPI Port 1
DPI Port 2
DPI Port 3
DPI Port 4
DPI Port 5
DPI Port 6
DPI Port 7
DPI Port 8
DPI Port 9
DPI Port 10
DPI Port 11
DPI Port 12
DPI Port 13
DPI Port 14
(Dec.)
016383
1638417407
1740818431
1843219455
1945620479
2048021503
2150422527
2252823551
2255224575
2457625599
2560026623
2662427647
2764828671
2867229695
2969630719
3072031743
Instances (Hex.)
0x00000x3FFF
0x40000x43FF
0x44000x47FF
0x48000x4BFF
0x4C000x4FFF
0x50000x53FF
0x54000x57FF
0x58000x5BFF
0x5C000x5FFF (1)
0x60000x63FF (1)
0x64000x67FF (1)
0x68000x6BFF (1)
0x6C000x6FFF (1)
0x70000x73FF (1)
0x74000x77FF (1)
0x78000x7BFF (1)
(1) These instances are supported only when the adapter is used with a PowerFlex 750-Series drive.
Class Attributes
196
Name
Family Code
Data Type
BYTE
Family Text
STRING[16]
Get
Description
0x00 = DPI Peripheral
0x30 = PowerFlex 70
0x34 = PowerFlex 700H
0x38, 0x39, or 0x3A= PowerFlex 700
0x40 = PowerFlex 7000
0x48, 0x49, or 0x4A = PowerFlex 700S
0x5A = SMC Flex
0x68, 0x69, or 0x6A = PowerFlex 700VC
0x90 = PowerFlex 753/755
0xA0 = 20-750-xxx Option Module
0xFF = HIM
Text identifying the device.
Name
Language Code
Data Type
BYTE
Get
Product Series
BYTE
Get
Number of Components
BYTE
5
6
7
8
9
11
12
13
Set
Get
Get
Get
Get
Get
Get
Get
STRING[16]
STRING[12]
BYTE
STRING[16]
WORD
WORD
WORD
BYTE
14
15
Get
Get
18
19
Get
Set
Serial Number
Language Selected
BOOL[64]
STRUCT of:
BYTE
BYTE[n]
STRUCT of:
WORD
BYTE
BYTE
STRUCT of:
BYTE
BYTE
DWORD
BYTE
20
Set
Customer-Generated Firmware
STRING[36]
30
31
Get
Get/Set
STRINGN
STRINGN
16
17
Get
Get
Date of Manufacture
Product Revision
Description
0 = English
1 = French
2 = Spanish
3 = Italian
4 = German
5 = Japanese
6 = Portuguese
7 = Mandarin Chinese
8 = Russian
9 = Dutch
1=A
2=B
Number of components (for example, main control board, I/O boards, and
so forth) in the device.
Text identifying the device with a user-supplied name.
Text describing the status of the device.
Identification of variations.
Text identifying a variation of a family device.
0x0001 = Allen-Bradley
Checksum of the Non-Volatile Storage in a device.
2 = DPI
0 = SCANport HIM
1 = ISO 8859-1 (Latin 1)
2 = ISO 8859-2 (Latin 2)
3 = ISO 8859-3 (Latin 3)
4 = ISO 8859-4 (Latin 4)
5 = ISO 8859-5 (Cyrillic)
6 = ISO 8859-6 (Arabic)
7 = ISO 8859-7 (Greek)
8 = ISO 8859-8 (Hebrew)
9 = ISO 8859-9 (Turkish)
10 = ISO 8859-10 (Nordic)
255 = ISO 10646 (Unicode)
Number of Languages
Language Codes (see Class Attribute 2)
Year
Month
Day
Major Firmware Release
Minor Firmware Release
Value between 0x00000000 and 0xFFFFFFFF
0 = Default (HIM will prompt at start up)
1 = Language was selected (no prompt)
GUID (Globally Unique Identifier) identifying customer firmware flashed
into the device.
Text describing the status of device with support for Unicode.
Text identifying the device with a user-supplied name with support for
Unicode.
197
Appendix C
EtherNet/IP Objects
35
39
128
129
130
Get
Get
Get
Get
Get
Name
Key Information
Data Type
STRUCT of:
Description
DWORD
DWORD
WORD
WORD
WORD
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE[16]
NVS CRC
SI Driver Code
Customization Code
Customization Revision Number
Customization Device Text
DWORD
WORD
WORD
WORD
STRING[32]
Rating Code
Device Serial Number
Customization Code
Customization Revision
Brand Code
Family Code
Config Code
Language Code
Major Revision
Minor Revision
Customer-Generated Firmware UUID
A 32-bit CRC of the Non-Volatile Storage in a device.
Code identifying the protocol between the device and host.
Code identifying the customized device.
Revision of the customized device.
Text identifying the customized device.
Instance Attributes
Attribute ID Access Rule
3
Get
4
Get
8
9
Get
Get
Name
Component Name
Component Firmware Revision
Data Type
STRING[32]
STRUCT of:
BYTE
BYTE
DWORD
STRINGN
Description
Name of the component
Major Revision
Minor Revision
Value between 0x00000000 and 0xFFFFFFFF
Name of the component with support for Unicode.
Class Code
Hexadecimal
0x93
Decimal
147
To access Host Config parameters, use the HOST DPI Parameter Object (Class
code 0x9F).
Instances
The number of instances depends on the number of parameters in the device. The
total number of parameters can be read in Instance 0, Attribute 0.
198
Description
Class Attributes (Drive)
Drive Parameter 1 Attributes
Drive Parameter 2 Attributes
Example
0
1
2
16384
16385
Device
Host
Adapter
DPI Port 1
DPI Port 2
DPI Port 3
DPI Port 4
DPI Port 5
DPI Port 6
DPI Port 7
DPI Port 8
DPI Port 9
(Dec.)
016383
1638417407
1740818431
1843219455
1945620479
2048021503
2150422527
2252823551
2355224575
2457625599
2560026623
Instances (Hex.)
0x00000x3FFF
0x40000x43FF
0x44000x47FF
0x48000x4BFF
0x4C000x4FFF
0x50000x53FF
0x54000x57FF
0x58000x5BFF
0x5C000x5FFF (1)
0x60000x63FF (1)
0x64000x67FF (1)
Instances (Hex.)
0x68000x6BFF (1)
0x6C000x6FFF (1)
0x70000x73FF (1)
0x74000x77FF (1)
0x78000x7BFF (1)
(Dec.)
2662427647
2764828671
2867229695
2969630719
3072031743
Device
DPI Port 10
DPI Port 11
DPI Port 12
DPI Port 13
DPI Port 14
Example
Description
(1) These instances are supported only when the adapter is used with a PowerFlex 750-Series drive.
Class Attributes
Attribute ID
0
1
Access Rule
Get
Set
Name
Number of Instances
Write Protect Password
Data Type
WORD
WORD
Set
BYTE
3
4
5
Get
Get
Get
WORD
WORD
WORD
7
8
Get
Get
Class Revision
First Parameter Processing Error
WORD
WORD
Set
Link Command
BYTE
Description
Number of parameters in the device
0 = Password disabled
n = Password
0 = No Operation
1 = Store values in active memory to NVS
2 = Load values in NVS to active memory
3 = Load default values to active memory
Checksum of all parameter values in a user set in NVS
Checksum of parameter links in a user set in NVS
First parameter available if parameters are protected by passwords.
A 0 indicates all parameters are protected.
2 = DPI
The first parameter that has been written with a value outside of its
range. A 0 indicates no errors.
0 = No Operation
1 = Clear All Parameter Links (This does not clear links to function
blocks.)
199
Appendix C
EtherNet/IP Objects
Instance Attributes
Attribute ID
6
8
9
10
Get
Get/Set
Get/Set
DPI Descriptor
DPI Parameter Value
DPI RAM Parameter Value
Data Type
STRUCT of:
BOOL[32]
CONTAINER
CONTAINER
CONTAINER
STRING[16]
STRING[4]
WORD
WORD
WORD
WORD
WORD
WORD
WORD
BYTE
BYTE
WORD
WORD
CONTAINER
WORD
WORD
WORD
INT
STRUCT of:
BOOL[32]
CONTAINER(1)
CONTAINER
CONTAINER
CONTAINER
WORD
WORD
STRING[4]
WORD
WORD
WORD
INT
BYTE[3]
BYTE
STRING[16]
BOOL[32]
Various
Various
11
Get/Set
DPI Link
BYTE[3]
12
13
Get
Get
WORD
STRUCT of:
BOOL[32]
CONTAINER
CONTAINER
CONTAINER
CONTAINER
STRING[16]
STRING[4]
STRING[16]
STRING[16]
BYTE
14
15
16
200
Access Rule
Get
Get
Get
Get
Get
Name
DPI Offline Read Full
Description
Descriptor
Offline minimum value
Offline maximum value
Offline default value
Parameter name
Offline parameter units
Online minimum parameter instance
Online maximum parameter instance
Online default parameter instance
Multiple parameter instance
Divisor parameter instance
Base parameter instance
Offset parameter instance
Formula number
Pad byte (always zero)
Help instance
Pad word (always a value of zero)
Parameter value
Multiplier
Divisor
Base
Offset
Descriptor (see page 202)
Parameter value
Minimum value
Maximum value
Default value
Next parameter
Previous parameter
Units (for example, Amp, Hz)
Multiplier (2)
Divisor (2)
Base (2)
Offset (2)
Link (source of the value) (0 = no link)
Always zero (0)
Parameter name
Descriptor (see page 202)
Parameter value in NVS. (3)
Parameter value in temporary memory. Valid only
for DPI drives.
Link (parameter or function block that is the source
of the value) (0 = no link)
ID for help text for this parameter
Descriptor (see page 202)
Parameter value
Minimum value
Maximum value
Default value
Parameter name
Units (for example, Amp, Hz)
Parameter name
Customer supplied parameter name.
0 = No error
1 = Value is less than the minimum
2 = Value is greater than the maximum
Attribute ID
18
19
20
21
22
Access Rule
Get
Get
Get
Get
Get
Name
Data Type
International DPI Offline Parameter STRUCT of:
Text
STRINGN
STRINGN
International DPI Online Parameter STRUCT of:
Text
STRINGN
STRINGN
International DPI Online Read Full STRUCT of:
BOOL[32]
CONTAINER
CONTAINER
CONTAINER
CONTAINER
WORD
WORD
WORD
WORD
WORD
INT
BYTE[3]
BYTE
BOOL[32]
STRINGN
STRINGN
DPI Extended Descriptor
DWORD
International DPI Offline Read Full STRUCT of:
BOOL
CONTAINER
CONTAINER
CONTAINER
WORD
WORD
WORD
WORD
WORD
WORD
WORD
BYTE
BYTE
WORD
WORD
CONTAINER
WORD
WORD
WORD
INT
BOOL[32]
STRINGN
STRINGN
Description
International parameter name
International offline units
International parameter name
International offline units
Descriptor
Parameter value
Online minimum value
Online maximum value
Online default value
Next
Previous
Multiplier
Divisor
Base
Offset
Link
Pad word (always zero)
Extended descriptor
International parameter name
International online parameter units
Extended descriptor (see page 203)
Descriptor
Offline minimum value
Offline maximum value
Offline default value
Online minimum parameter instance
Online maximum parameter instance
Online default parameter instance
Multiple parameter instance
Divisor parameter instance
Base parameter instance
Offset parameter instance
Formula number
Pad byte (always zero)
Help instance
Pad word (always a value of zero)
Parameter value
Multiplier
Divisor
Base
Offset
Extended DPI descriptor
International DPI parameter name
International DPI offline parameter units
(1) A CONTAINER is a 32-bit block of data that contains the data type used by a parameter value. If signed, the value is sign extended. Padding is used in the CONTAINER
to ensure that it is always 32-bits.
(2) This value is used in the formulas used to convert the parameter value between display units and internal units. See Formulas for Converting on page 204.
(3) Do not continually write parameter data to NVS. See the attention on page 105.
201
Appendix C
EtherNet/IP Objects
Descriptor Attributes
202
Bit
0
1
2
Name
Data Type (Bit 1)
Data Type (Bit 2)
Data Type (Bit 3)
Sign Type
Hidden
Not Recallable
ENUM
Writable
10
Instance
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Parameter Exists
Not Used
Formula Links
Access Level (Bit 1)
Access Level (Bit 2)
Access Level (Bit 3)
Writable ENUM
Not a Link Source
27
28
29
30
31
Always Upload/Download
Description
Right bit is least significant bit (0).
000 = BYTE used as an array of Boolean
001 = WORD used as an array of Boolean
010 = BYTE (8-bit integer)
011 = WORD (16-bit integer)
100 = DWORD (32-bit integer)
101 = TCHAR (8-bit (not unicode) or 16-bits (unicode)
110 = REAL (32-bit floating point value)
111 = Use bits 16, 17, 18
0 = Unsigned
1 = Signed
0 = Visible
1 = Hidden
0 = Parameter can sink a link
1 = Parameter cannot sink a link
0 = Recallable from NVS
1 = Not Recallable from NVS
0 = No ENUM text
1 = ENUM text
0 = Read only
1 = Read/write
0 = Writable when enabled (for example, drive running)
1 = Not writable when enabled
0 = Parameter value is not a Reference to another parameter
1 = Parameter value refers to another parameter
This parameter instance supports the Bit ENUM Mask attribute. For more
information, see the definition of the attribute.
Number of digits to the right of the decimal point.
0000 = 0
1111 = 15
Right bit is least significant bit (16).
000 = Reserved
001 = DWORD used as an array of Boolean
010 = Reserved
011 = Reserved
100 = Reserved
101 = Reserved
110 = Reserved
111 = Reserved
Used to mark parameters that are not available to network tools.
Reserved
Indicates the Formula Data is derived from other parameters.
A 3-bit field used to control access to parameter data.
Name
Indirect Mode
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Indirect Type 0
Indirect Type 1
Indirect Type 2
Indirect Type 3
Indirect Type 4
Indirect Type 5
Indirect Type 6
Indirect Type 7
Indirect Type 8
Indirect Type 9
Indirect Type 10
Indirect Type 11
Indirect Type 12
Indirect Type 13
Indirect Type 14
FP Max Decimals Bit 0
FP Max Decimals Bit 1
FP Max Decimals Bit 2
FP Max Decimals Bit 1
Extended Parameter Reference
21
22
23
Disallow Zero
24
25
Datalink Out
Datalink In
26
27
Command Parameter
Description
0 = Analog (selects entire parameters)
1 = Digital (selects individual bits within parameters)
Analog input list (Instance 0xFFFF)
Digital input list (Instance 0xFFFE)
Feedback list (Instance 0xFFFD)
Analog output list (Instance 0xFFFC)
Digital output list (Instance 0xFFFB)
Undefined (Instance 0xFFFA)
Undefined (Instance 0xFFF9)
Undefined (Instance 0xFFF8)
Undefined (Instance 0xFFF7)
Undefined (Instance 0xFFF6)
Undefined (Instance 0xFFF5)
Undefined (Instance 0xFFF4)
Undefined (Instance 0xFFF3)
Undefined (Instance 0xFFF2)
Parameter-specific list
These four bits are used on REAL parameters only. They indicate the maximum number of decimal places to
be displayed for small values. A value of 0 indicates to not limit the number of decimal places used.
203
Appendix C
EtherNet/IP Objects
Bit
28
Name
Current Value Is Default
29
30-31
Reserved
Description
This bit identifies a parameter that will not change if a Reset Defaults is commanded. For example, if a drive
contains a Language parameter that is set to German, setting defaults will leave the parameter set to
German. Likewise, if the parameter is set to French, setting defaults will leave the parameter set to French.
If the Disallow Zero bit is set, this bit must be cleared. If the Disallow Zero bit is cleared, then:
0 = Use Disabled Text parameter class attribute.
1 = Use Zero Text parameter instance attribute.
Reserved
Common Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Implemented for:
Class
Instance
Yes
No
Yes
No
Service Name
Get_Attributes_Scattered
Set_Attributes_Scattered
The table below lists the parameters for the Get_Attributes_Scattered and
Set_Attributes_Scattered object-specific service:
Name
Parameter Number
Parameter Value
Data Type
DWORD
DWORD
Description
Parameter to read or write
Parameter value to read or write (zero when reading)
Class Code
Hexadecimal
0x97
Decimal
151
Products such as PowerFlex drives use this object for faults. Adapters use this
object for events.
Services
Service Code
0x0E
0x10
204
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
The number of instances depends on the maximum number of faults or events
supported in the queue. The maximum number of faults/events can be read in
Instance 0, Attribute 2.
Description
Class Attributes (Drive)
Most Recent Drive Fault
Second Most Recent Drive Fault
Example
0
1
2
16384
16385
Device
Host
Adapter
DPI Port 1
DPI Port 2
DPI Port 3
DPI Port 4
DPI Port 5
DPI Port 6
(Dec.)
016383
1638417407
1740818431
1843219455
1945620479
2048021503
2150422527
2252823551
Instances (Hex.)
0x00000x3FFF
0x40000x43FF
0x44000x47FF
0x48000x4BFF
0x4C000x4FFF
0x50000x53FF
0x54000x57FF
0x58000x5BFF
Class Attributes
Attribute ID
1
2
Access Rule
Get
Get
Name
Class Revision
Number of Instances
Data Type
WORD
WORD
Set
BYTE
Get
WORD
Get
Get
STRUCT of:
BYTE
BYTE
WORD[n]
WORD
Get
WORD
Description
Revision of object
Maximum number of faults/events that the device
can record in its queue
0 = No Operation
1 = Clear Fault/Event
2 = Clear Fault/Event Queue
3 = Reset Device
Fault that tripped the device. For adapters, this value
is always 1 when faulted.
Number of faults/events in the queue. A 0 indicates
the fault queue is empty.
205
Appendix C
EtherNet/IP Objects
Instance Attributes
Attribute ID
0
Access Rule
Get
Name
Full/All Information
Data Type
STRUCT of WORD
STRUCT of:
BYTE
BYTE
STRING[16]
STRUCT of:
LWORD
BOOL[16]
WORD
CONTAINER[n]
STRUCT of WORD
STRUCT of:
BYTE
BYTE
STRUCT of:
LWORD
BOOL[16]
Get
Basic Information
Get
STRINGN
Description
Fault code
Fault source
DPI port
DPI Device Object
Fault text
Fault time stamp
Timer value (0 = timer not supported)
BOOL[0]: (0 = invalid data, 1 = valid data)
BOOL[1]: (0 = elapsed time, 1 = real time)
BOOL[215]: Not used
Reserved
Reserved
Fault code
Fault source
DPI port
DPI Device Object
Fault time stamp
Timer value (0 = timer not supported)
BOOL[0]: (0 = invalid data, 1 = valid data)
BOOL[1]: (0 = elapsed time, 1 = real time)
BOOL[215]: Not used
Text describing the fault with support for Unicode.
Class Code
Hexadecimal
0x98
Decimal
152
Products such as PowerFlex drives use this object for alarms or warnings.
Adapters do not support this object.
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
206
Device
Host
Example
0
1
2
Description
Class Attributes (Drive)
Most Recent Alarm
Second Most Recent Alarm
Instances (Hex.)
(Dec.)
0x00000x3FFF
016383
Only host devices can have alarms.
Class Attributes
Attribute ID
1
2
Access Rule
Get
Get
Name
Class Revision
Number of Instances
Data Type
WORD
WORD
Set
BYTE
Get
Get
STRUCT of:
BYTE
BYTE
WORD[n]
WORD
Description
Revision of object
Maximum number of alarms that the device
can record in its queue
0 = No Operation
1 = Clear Alarm
2 = Clear Alarm Queue
3 = Reset Device
Reserved
Instance Attributes
Attribute ID
0
Access Rule
Get
Name
Full/All Information
Data Type
STRUCT of WORD
STRUCT of:
BYTE
BYTE
STRING[16]
STRUCT of:
LWORD
BOOL[16]
WORD
CONTAINER[n]
STRUCT of WORD
STRUCT of:
BYTE
BYTE
STRUCT of:
LWORD
BOOL[16]
Get
Basic Information
Get
STRINGN
Description
Alarm code
Alarm source
DPI port
DPI Device Object
Alarm text
Alarm time stamp
Timer value (0 = timer not supported)
BOOL[0]: (0 = invalid data, 1 = valid data)
BOOL[1]: (0 = elapsed time, 1 = real time)
BOOL[215] Reserved
Reserved
Reserved
Alarm code
Alarm source
DPI port
DPI Device Object
Alarm time stamp
Timer value (0 = timer not supported)
BOOL[0]: (0 = invalid data, 1 = valid data)
BOOL[1]: (0 = elapsed time, 1 = real time)
BOOL[215] Reserved
Text describing the alarm with support for Unicode.
Class Code
Hexadecimal
0x99
Decimal
153
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
207
Appendix C
EtherNet/IP Objects
Instances
The number of instances depends on the maximum number of diagnostic items
in the device. The total number of diagnostic items can be read in Instance 0,
Attribute 2.
Description
Class Attributes (Drive)
Drive Diagnostic Item 1
Drive Diagnostic Item 2
Example
0
1
2
16384
16385
Device
Host
Adapter
DPI Port 1
DPI Port 2
DPI Port 3
DPI Port 4
DPI Port 5
DPI Port 6
(Dec.)
016383
1638417407
1740818431
1843219455
1945620479
2048021503
2150422527
2252823551
Instances (Hex.)
0x00000x3FFF
0x40000x43FF
0x44000x47FF
0x48000x4BFF
0x4C000x4FFF
0x50000x53FF
0x54000x57FF
0x58000x5BFF
Class Attributes
Attribute ID
1
2
3
Access Rule
Get
Get
Get
Name
Class Revision
Number of Instances
ENUM Offset
Data Type
WORD
WORD
WORD
Description
1
Number of diagnostic items in the device.
DPI ENUM object instance offset
Instance Attributes
Attribute ID
0
208
Access Rule
Get
Name
Full/All Information
Data Type
STRUCT of:
BOOL[32]
CONTAINER (1)
CONTAINER
CONTAINER
CONTAINER
WORD
WORD
STRING[4]
WORD
WORD
WORD
INT
DWORD
STRING[16]
Description
Descriptor (see page 202)
Value
Minimum value
Maximum value
Default value
Pad Word
Pad Word
Units (for example, Amp, Hz)
Multiplier (2)
Divisor (2)
Base (2)
Offset (2)
Link (source of the value) (0 = no link)
Diagnostic name text
Attribute ID
1
2
Access Rule
Get/Set
Get
Get
Name
Value
International Diagnostic Item Text
Data Type
Various
STRUCT of:
STRINGN
STRINGN
STRUCT of:
BOOL[32]
CONTAINER
CONTAINER
CONTAINER
CONTAINER
WORD
WORD
WORD
WORD
WORD
INT
DWORD
BOOL[32]
STRINGN
STRINGN
Description
Diagnostic item value
Diagnostic name text
Diagnostic units text
Descriptor
Value
Minimum
Maximum
Default
Pad Word
Pad Word
Multiplier
Divisor
Base
Offset
Pad
Extended descriptor
Diagnostic name text
Diagnostic units text
(1) A CONTAINER is a 32-bit block of data that contains the data type used by a value. If signed, the value is sign extended. Padding is used in the CONTAINER to ensure that it is
always 32-bits.
(2) This value is used in the formulas used to convert the value between display units and internal units. See Formulas for Converting on page 204.
Class Code
Hexadecimal
0x9B
Decimal
155
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
Yes
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
Instances (Hex.)
0x00000x3FFF
0x40000x43FF
(Dec.)
016383
1638417407
Device
Host
Adapter
Example
0
1
0x44000x47FF
0x48000x4BFF
0x4C000x4FFF
0x50000x53FF
0x54000x57FF
0x58000x5BFF
1740818431
1843219455
1945620479
2048021503
2150422527
2252823551
DPI Port 1
DPI Port 2
DPI Port 3
DPI Port 4
DPI Port 5
DPI Port 6
2
3
Description
Class Attributes (Drive)
Real Time Clock (Predefined) (not
always supported)
Timer 1
Timer 2
The number of instances depends on the number of timers in the device. Instance
1 is always reserved for a real-time clock although a device may not support it. The
total number of timers can be read in Instance 0, Attribute 2.
209
Appendix C
EtherNet/IP Objects
Class Attributes
Attribute ID
1
2
Access Rule
Get
Get
Name
Class Revision
Number of Instances
Data Type
WORD
WORD
3
4
Get
Set
WORD
BYTE
Get
WORD
6
7
Get
Get/Set
STRUCT
WORD
Get
STRUCT of:
INT
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
INT
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
STRUCT of:
INT
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
INT
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
210
Get/Set
Description
Revision of object
Number of timers in the object, excluding the real-time
clock that is predefined.
Instance of the first timer that is not predefined.
0 = No Operation
1 = Clear all timers (Does not clear the real-time clock or
read only timers)
Number of time zones described in the Time Zone List
attribute.
Identifies a time zone.
The ID field of the Time Zone List structure for the desired
time zone.
Standard bias
Standard month
Standard day of week
Standard week
Standard hour
Standard minute
Standard second
Daylight offset
Daylight month
Daylight day of week
Daylight week
Daylight hour
Daylight minute
Daylight second
Standard bias
Standard month
Standard day of week
Standard week
Standard hour
Standard minute
Standard second
Daylight offset
Daylight month
Daylight day of week
Daylight week
Daylight hour
Daylight minute
Daylight second
Instance Attributes
Attribute ID
0
Access Rule
Get
Name
Read Full
1
2
Get
Get/Set
Timer Text
Timer Value
Get
Timer Descriptor
Get
Data Type
STRUCT of:
STRING[16]
LWORD or
STRUCT
BOOL[16]
STRING[16]
LWORD -orSTRUCT of:
WORD
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BOOL[16]
5
6
8
9
Get
Get
Get/Set
Get
STRUCT of:
STRINGN
STRUCT
BOOL[16]
STRINGN
BOOL[32]
INT
BOOL[32]
10
Get/Set
BOOL[32]
Description
Name of the timer
Elapsed time in milliseconds unless timer is a real-time clock (see
attribute 2)
See attribute 3
Name of the timer
Elapsed time in milliseconds unless the timer is a real-time clock.
Real-Time Clock Data:
Milliseconds (0999)
Seconds (059)
Minutes (059)
Hours (023)
Days (131)
Months (1 = January, 12 = December)
Years (since 1972)
BOOL[0]: (0 = invalid data, 1 = valid data)
BOOL[1]: (0 = elapsed time, 1 = real time)
BOOL[215]: Not used
International timer text
Timer value
Timer descriptor
Name of this timer
Identifies clock status
Identifies the current number of Leap Seconds.
Identifies the optional functionality available in the devices System
Clock.
Identifies which of the clocks options are enabled.
Class Code
Hexadecimal
0xF5
Decimal
245
Services
Service Code
0x0E
0x10
Implemented for:
Class
Instance
Yes
Yes
No
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Instances
Get_Attribute_All is supported for instances. The adapter supports one instance
of the TCP/IP Interface object.
Number
0
1
Description
Class Attributes
Object Attributes
211
Appendix C
EtherNet/IP Objects
Class Attributes
Attribute ID
1
Access Rule
Get
Name
Revision
Data Type
WORD
Description
The revision of this object
Instance Attributes
Attribute ID
1
Access Rule
Get
Get
Get/Set
Get
6
8
9
10
11
212
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Name
Status of TCP/IP
Network Interface
Configuration
Capability
Configuration
Control
Physical Link Object
Data Type
DWORD
Description
DWORD
0x000000F4
DWORD
STRUCT of:
UINT
Padded EPATH
Interface
STRUCT of:
Configuration
UDINT
UDINT
UDINT
UDINT
UDINT
STRING
Host Name
STRING
TTL Value
USINT
Multicast Config
Struct of:
USINT
USINT
UINT
UDINT
SelectAcd
BOOL
LastConflictDetected Struct of:
USINT
USINT[6]
USINT[28]
2 words
20 F6 24 01 (Enet Link Object instance 1)
IP Address
Network Mask
Gateway Address
Primary DNS
Secondary DNS
Default Domain Name for not fully qualified host names
Host name when using DHCP
Time to Live value for EtherNet/IP multicast packets
Allocation Control
Reserved
Number of multicast addresses to allocate (1-4)
Multicast starting address.
Activates the use of ACD
AcdActivity
RemoteMAC
ArpPdu
Class Code
Hexadecimal
0xF6
Decimal
246
Services
The following common services will be implemented for the Ethernet Link
Object.
Service Code
0x0E
0x10
0x4C
Implemented for:
Class
Instance
Yes
Yes
No
Yes
No
Yes
Service Name
Get_Attribute_Single
Set_Attribute_Single
Get_and_Clear
Instances
The adapter supports one instance of the TCP/IP Interface object.
Number
0
1
2
Description
Class Attributes
Object Attributes Ethernet Port 1
Object Attributes Ethernet Port 2
Class Attributes
The following class attributes will be supported.
Attribute ID
1
2
3
Access Rule
Get
Get
Get
Name
Revision
Max. Instance
Number of Instances
Data Type
UINT
UINT
UINT
Value
3
2
2
Instance Attributes
Two instances of the Ethernet Link Object will be supported.
Attribute ID
1
2
3
Access Rule
Get
Get
Get
Name
Interface Speed
Interface Flags
Physical Address
Get
Interface Counters
Data Type
UDINT
DWORD
Array of 6
USINTs
STRUCT of:
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
UDINT
Description
10 or 100 megabits per second (Mbs)
See EtherNet/IP specifications
MAC address
In Octets
In Ucast packets
In NUcast packets
In Discards
In Errors
In Unknown Protos
Out Octets
Out Ucast packets
Out NUcast packets
Out Discards
Out Errors
213
Appendix C
214
EtherNet/IP Objects
Attribute ID
5
Access Rule
Get
Name
Media Counters
Get/Set
Interface Control
7
8
Get
Get
Interface Type
Interface State
Get/Set
Admin State
10
Get
Interface Label
Data Type
STRUCT of:
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
Struct of:
WORD
UINT
USINT
USINT
Description
RX = Received, TX = Transmitted
RX frames not having integral number of octets long
RX frames not passing FCS check
TX frames having one collision
TX frames having multiple collisions
Number of times of SQE test error message
TX Frames delayed first attempt by busy medium
Collisions detected later than 512 bit-times in trans.
TX frames failing due to excessive collisions
TX frames failing due to intern MAC sublayer TX error
Times of carrier sense condition loss during trans.
RX frames exceeding the maximum frame size
RX frames failing due to intern MAC sublayer RX error
Struct of:
Control Bits
Forced Interface Speed
2 = Twisted-pair (e.g., 10Base-T, 100Base-TX, 1000Base-T, etc.)
0 = Unknown interface state
1 = The interface is enabled and is ready to send and receive data
2 = The interface is disabled
3 = The interface is testing
USINT
1 = Enable the interface (default)
2 = Disable the interface.
SHORT_STRING Instance 1: LS 1
Instance 2: LS 2
Appendix
PowerFlex 70/70EC,
PowerFlex 700/700VC, and
PowerFlex 700H Drives
Logic Bits
15 14 13 12 11 10 9
1
x
x
x
x
x
x
x
0 Command
x Stop (1)
Start (1)(2)
Jog
Clear Faults
Direction
Local Control
MOP Increment
Accel Rate
Decel Rate
MOP Decrement
Description
0 = Not Stop
1 = Stop
0 = Not Start
1 = Start
0 = Not Jog (Par. 100)
1 = Jog
0 = Not Clear Faults
1 = Clear Faults
00 = No Command
01 = Forward Command
10 = Reverse Command
11 = Hold Direction Control
0 = No Local Control
1 = Local Control
0 = Not Increment
1 = Increment
00 = No Command
01 = Accel Rate 1 Command (Par. 140)
10 = Accel Rate 2 Command (Par. 141)
11 = Hold Accel Rate
00 = No Command
01 = Decel Rate 1 Command (Par. 142)
10 = Decel Rate 2 Command (Par. 143)
11 = Hold Decel Rate
000 = No Command
001 = Ref A Select (Par. 90)
010 = Ref B Select (Par. 93)
011 = Preset 3 (Par. 103)
100 = Preset 4 (Par. 104)
101 = Preset 5 (Par. 105)
110 = Preset 6 (Par. 106)
111 = Preset 7 (Par. 107)
0 = Not Decrement
1 = Decrement
(1) A 0 = Not Stop condition (logic 0) must first be present before a 1 = Start condition will start the drive. The Start command acts as a momentary Start command. A 1 will
start the drive, but returning to 0 will not stop the drive.
215
Appendix D
(2) This Start will not function if a digital input (parameters 361366) is programmed for 2-Wire Control (option 7, 8 or 9).
(3) This Reference Select will not function if a digital input (parameters 361366) is programmed for Speed Sel 1, 2 or 3 (option 15, 16 or 17). Note that Reference Select is
Exclusive Ownership see drive User Manual for more information.
x
x
x
x
x
x
x
x
0 Status
x Ready
Active
Command
Direction
Actual Direction
Accel
Decel
Alarm
Fault
At Speed
Local Control (1)
Reference
216
Description
0 = Not Ready (Par. 214)
1 = Ready
0 = Not Active (Running)
1 = Active
0 = Reverse
1 = Forward
0 = Reverse
1 = Forward
0 = Not Accelerating
1 = Accelerating
0 = Not Decelerating
1 = Decelerating
0 = No Alarm (Par. 211 & 212)
1 = Alarm
0 = No Fault (Par. 243)
1 = Fault
0 = Not At Reference
1 = At Reference
000 = Port 0 (TB)
001 = Port 1
010 = Port 2
011 = Port 3
100 = Port 4
101 = Port 5
110 = Port 6
111 = No Local
0000 = Ref A Auto (Par. 90)
0001 = Ref B Auto (Par. 93)
0010 = Preset 2 Auto
0011 = Preset 3 Auto
0100 = Preset 4 Auto
0101 = Preset 5 Auto
0110 = Preset 6 Auto
0111 = Preset 7 Auto
1000 = Term Blk Manual
1001 = DPI 1 Manual
1010 = DPI 2 Manual
1011 = DPI 3 Manual
1100 = DPI 4 Manual
1101 = DPI 5 Manual
1110 = DPI 6 Manual
1111 = Jog Ref
x
x
x
x
x
x
x
x
x
x
x
x
0 Command
x Normal Stop
Start (1)
Jog 1
Clear Fault (2)
Unipolar Direction
Description
0 = Not Normal Stop
1 = Normal Stop
0 = Not Start
1 = Start
0 = Not Jog using [Jog Speed 1] (Par. 29)
1 = Jog using [Jog Speed 1] (Par. 29)
0 = Not Clear Fault
1 = Clear Fault
00 = No Command
01 = Forward Command
10 = Reverse Command
11 = Hold Direction Control
Reserved
Jog 2
Reserved
(1) A Not Stop condition (logic bit 0 = 0, logic bit 8 = 0, and logic bit 9 = 0) must first be present before a 1 = Start condition will start the drive.
(2) To perform this command, the value must switch from 0 to 1.
217
Appendix D
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
0 Status
x Active
Running
Command
Direction
Actual Direction
Accel
Decel
Jogging
Fault
Alarm
Flash Mode
Run Ready
At Limit (1)
Tach Loss Sw
At Zero Spd
At Setpt Spd
Enable
Description
0 = Not Active
1 = Active
0 = Not Running
1 = Running
0 = Reverse
1 = Forward
0 = Reverse
1 = Forward
0 = Not Accelerating
1 = Accelerating
0 = Not Decelerating
1 = Decelerating
0 = Not Jogging
1 = Jogging
0 = No Fault (Par. 323, 324, 325)
1 = Fault
0 = No Alarm (Par. 326, 327, 328)
1 = Alarm
0 = Not in Flash Mode
1 = In Flash Mode
0 = Not Ready to Run (Par. 156)
1 = Ready to Run
0 = Not At Limit (Par. 304)
1 = At Limit
0 = Not Tach Loss Sw
1 = Tach Loss Sw
0 = Not At Zero Speed
1 = At Zero Speed
0 = Not At Setpoint Speed
1= At Setpoint Speed
0 = Not Enabled
1 = Enabled
(1) See Parameter 304 - [Limit Status] in the PowerFlex 700S drive User Manual for a description of the limit status conditions.
218
14
13
12
11
10
Status
7
0
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Description
Enabled
Running
Phasing
1 ABC Phasing
0 CBA Phasing
Phasing
Active
1 3-phase is valid
0 No valid 3-phase detected
Starting
(Accel)
Stopping
(Decel)
Alarm
1 Alarm Present
0 No Alarm Present
Fault
At Speed
Start/
Isolation
Bypass
Ready
1 Ready
0 Not Ready
Option 1
Input
1 Input Active
0 Input Inactive
Option 2
Input
1 Input Active
0 Input Inactive
219
Appendix D
14
13
12
11
10
Status
7
1
X
X
X
X
X
X
X
X
X
X
220
Description
0
Stop
1 Stop/Inhibit
0 No Action
Start
1 Start
0 No Action
Option #1
Input
1 Stop Maneuver/Inhibit
0 No Action
Clear Faults
1 Clear Faults
0 No Action
Option #2
Input
Aux Enable
Aux 1
1 Aux 1 Active
0 Aux 1 Inactive
Aux 2
1 Aux 2 Active
0 Aux 2 Inactive
Aux 3
1 Aux 3 Active
0 Aux 3 Inactive
Aux 4
1 Aux 4 Active
0 Aux 4 Inactive
Glossary
A
Adapter
Devices such as drives, controllers, and computers usually require a network
communication adapter to provide a communication interface between them and
a network such as EtherNet/IP. An adapter reads data on the network and
transmits it to the connected device. It also reads data in the device and transmits
it to the network.
The 20-COMM-ER EtherNet/IP adapter connects PowerFlex 7-Class drives and
SMC controllers to an EtherNet/IP network. Adapters are sometimes also called
cards, embedded communication options, gateways, modules, or peripherals.
221
Glossary
Data Rate
The speed at which data is transferred on the EtherNet/IP network. You can set
the adapter to a data rate of 10 Mbps Full-Duplex, 10 Mbps Half-Duplex, 100
Mbps Full-Duplex, or 100 Mbps Half-Duplex. If another device on the network
sets or auto-negotiates the data rate, you can set the adapter to automatically
detect the data rate.
Datalinks
A Datalink is a type of pointer used by PowerFlex 7-Class drives and SMC
controllers to transfer data to and from the controller. Datalinks allow specified
parameters to be read or written to without using explicit messages. When
enabled, each Datalink consumes either four bytes or eight bytes in both the
input and output image table of the controller. The drive determines the size of
Datalinks.
Device Level Ring (DLR)
A protocol that allows multiported EtherNet device to be connected in a ring
topology, enabling broken ring connection detection and network
reconfirmation to linear topology.
DLR Announce Frame
Data frame sent by the ring supervisor in a ring network to announce transition
from linear to ring or ring to linear configuration.
DLR Beacon Frame
Data frame sent by the ring supervisor in a ring network used to lost connections
that break the ring.
222
Glossary
223
Glossary
Duplex
Duplex describes the mode of communication. Full-duplex communication lets
a device exchange data in both directions at the same time. Half-duplex
communication lets a device exchange data only in one direction at a time. The
duplex used by the adapter depends on the type of duplex that other network
devices, such as switches, support.
Fault Action
A fault action determines how the adapter and connected drive act when a
communication fault (for example, a disconnected cable) occurs or when the
controller is switched out of run mode. The former uses a communication fault
action, and the latter uses an idle fault action.
Fault Configuration
When communication is disrupted (for example, a cable is disconnected), the
adapter and PowerFlex drive can respond with a user-defined fault configuration.
The user sets the data that is sent to the drive using specific fault configuration
parameters in the adapter. When a fault action parameter is set to use the fault
224
Glossary
configuration data and a fault occurs, the data from these parameters is sent as the
Logic Command, Reference, and/or Datalinks.
Gateway
A device on a network that connects an individual network to a system of
networks. When a node needs to communicate with a node on another network,
a gateway transfers the data between the two networks. You need to configure the
address for the gateway device in the adapter if you want the adapter to
communicate with devices that are not on its network.
Hardware Address
Each Ethernet device has a unique hardware address (sometimes called a MAC
address) that is 48 bits. The address appears as six digits separated by colons (for
example, xx:xx:xx:xx:xx:xx). Each digit has a value between 0 and 255 (0x00 and
0xFF). This address is assigned in the hardware and cannot be changed. It is
required to identify the device if you are using a BOOTP server.
HIM (Human Interface Module)
A device that can be used to configure and control a drive. PowerFlex 7-Class
HIMs (catalog number 20-HIM-xx) can be used to configure PowerFlex 7-Class
drives and their connected peripherals.
Hold Last
When communication is disrupted (for example, a cable is disconnected), the
adapter and PowerFlex drive can respond by holding last. Hold last results in the
drive receiving the last data received via the network connection before the
disruption. If the drive was running and using the Reference from the adapter, it
will continue to run at the same Reference.
Idle Action
An idle action determines how the adapter and connected drive act when the
controller is switched out of run mode.
I/O Data
I/O data, sometimes called implicit messages or input/output, is time-critical
data such as a Logic Command and Reference. The terms input and output are
defined from the controllers point of view. Output is produced by the controller
and consumed by the adapter. Input is produced by the adapter and consumed by
the controller.
225
Glossary
IP Addresses
A unique IP address identifies each node on an EtherNet/IP network. An IP
address consists of 32 bits that are divided into four segments of one byte each. It
appears as four decimal integers separated by periods (xxx.xxx.xxx.xxx). Each
xxx can have a decimal value from 0 to 255. For example, an IP address could be
192.168.0.1.
An IP address has two parts: a network ID and a host ID. The class of network
determines the format of the address.
0 1
0 Network ID
Class A
0 1
1 0 Network ID
Class B
Class C
0 1 2
7
1 1 0 Network ID
15
23
31
23
31
Host ID
15
Host ID
15
23
31
Host ID
The number of devices on your EtherNet/IP network will vary depending on the
number of bytes that are used for the network address. In many cases you are
given a network with a Class C address, in which the first three bytes contain the
network address (subnet mask = 255.255.255.0). This leaves 8 bits or 256
addresses on your network. Because two addresses are reserved for special uses (0
is an address for the network usually used by the router, and 255 is an address for
broadcast messages to all network devices), you have 254 addresses to use on a
Class C address block.
To ensure that each device on the Internet has a unique address, contact your
network administrator or Internet Service Provider for unique fixed IP addresses.
You can then set the unique IP address for the adapter by using a BOOTP server
or by manually configuring parameters in the adapter. The adapter reads the
values of these parameters only at powerup.
226
Glossary
Master-Slave Hierarchy
An adapter configured for a master-slave hierarchy exchanges data with the
master device. Usually, a network has one scanner which is the master device, and
all other devices (for example, drives connected to EtherNet/IP adapters) are
slave devices.
On a network with multiple scanners (called a multimaster hierarchy), each slave
device must have a scanner specified as a master.
Reference/Feedback
The Reference is used to send a setpoint (for example, speed, frequency, and
torque) to the drive. It consists of one word of output to the adapter from the
227
Glossary
network. The size of the word (either a 16-bit word or 32-bit word) is
determined by the drive.
Feedback is used to monitor the speed of the drive. It consists of one word of
input from the adapter to the network. The size of the word (either a 16-bit word
or 32-bit word) is determined by the drive.
RSLogix 5/500/5000 Software
RSLogix software is a tool for configuring and monitoring controllers to
communicate with connected devices. It is a 32-bit application that runs on
various Windows operating systems. Information about RSLogix software can be
found at http://www.software.rockwell.com/rslogix.
Scanner
A scanner is a separate module (of a multi-module controller) or a built-in
component (of a single-module controller) that provides communication with
adapters connected to a network. See also Controller.
Status Indicators
LEDs that are used to report the status of the adapter, network, and drive. They
are on the adapter and can be viewed on the front cover of the drive when the
drive is powered.
Subnet Mask
An extension to the IP addressing scheme that lets you use a single network ID
for multiple physical networks. A bit mask identifies the part of the address that
specifies the network and the part of the address that specifies the unique node
on the network. A 1 in the subnet mask indicates the bit is used to specify the
network. A 0 in the subnet mask indicates that the bit is used to specify the
node.
For example, a subnet mask on a network may appear as follows: 11111111
11111111 11111111 11000000 (255.255.255.192). This mask indicates that 26
bits are used to identify the network and 6 bits are used to identify devices on
each network. Instead of a single physical Class C network with 254 devices, this
subnet mask divides it into four networks with up to 62 devices each.
Switches
Network devices that provide virtual connections that help to control collisions
and reduce traffic on the network. They are able to reduce network congestion by
transmitting packets to an individual port only if they are destined for the
connected device. In a control application, in which real time data access is
critical, network switches may be required in place of hubs.
228
Glossary
Zero Data
When communication is disrupted (for example, a cable is disconnected), the
adapter and drive can respond with zero data. Zero data results in the drive
receiving zero as values for Logic Command, Reference, and Datalink data. If the
drive was running and using the Reference from the adapter, it will stay running
but at zero Reference.
229
Glossary
230
Index
A
adapter
applying power 24
commissioning 26
compatible products 13
components 11
configuration tools 27
connecting to the drive 20
connecting to the network 23
definition 221
features 12
firmware updating 44
grounding 22
hardware address label 29
installation 1726
IP address 29, 32
mounting on the drive 22
parameters 171179
resetting 43
specifications 169
using in a DPI External Comms Kit 167
viewing its status 44
web pages 153??
data rate
definition 222
setting 34
attentions 15
Datalinks
definition 222
in I/O image 80
using 86
B
baud rate, see data rate
bit definitions of Logic Command/Status word for
PowerFlex 70/700/700H drives 215
PowerFlex 700S drives 217
dimensions 170
DPI
connector on adapter 11
data rates 169
definition 223
Internal Interface cable 20, 21
peripheral 223
products 13, 223
cable, Ethernet 23
cables
DPI Internal Interface 20, 21
231
Index
explicit messaging
about 106
configuring for
ControlLogix controller 108
MicroLogix 1100/1400 controller 124
definition 224
performing 106
F
fault action
configuring the adapter for 41
definition 224
fault configuration
configuring the adapter for 42
definition 224
E
EDS (Electronic Data Sheet) files 224
EEPROM, see Nonvolatile Storage (NVS)
EMC Conformance 17
firmware update
definition 229
guidelines 44
Flt Cfg A1-D2 In parameters 176
Flt Cfg Logic parameter 175
Ethernet
cable 23
connector on adapter 11
gateway 225
gateway address
setting with BOOTP 29
setting with parameters 32
Gateway Cfg 1-4 parameters 172
grounding the adapter 22
H
half duplex, see duplex
hardware address
definition 225
in diagnostic item 148
on label 29
HIM (Human Interface Module)
accessing parameters with 28
definition 225
LCD model 28
LED model 28
232
Index
hold last
configuring the adapter for 41
definition 225
host IDs 226
I
I/O
about 79
configuring for
ControlLogix controller 48
MicroLogix 1100/1400 controller 68
configuring the adapter for 35
definition 225
understanding the I/O image 80
using with
ControlLogix controller 88
MicroLogix 1100/1400 controller 96
PLC-5 controller 96
SLC 500 controller 96
Logic Command/Status
bit definitions for
PowerFlex 70/700/700H drives 215
PowerFlex 700S drives 217
definition 226
in I/O image for
ControlLogix controller 80
PLC-5, SLC 500 or MicroLogix 1100 controllers 82
using 84
M
MAC address, see hardware address
manual
conventions 7
related documentation 8
website 8
Master-Slave hierarchy
configuring adapter for 36
definition 227
installation
applying power to the adapter 24
commissioning the adapter 26
connecting to the drive 20
connecting to the network 23
preparing for 18
Internal Interface cables
connecting to the adapter 21
connecting to the drive 21
illustration 21
IP Addr Cfg 1-4 parameters 172
IP address
definition/classes 226
setting with BOOTP 29
setting with parameters 32
N
NET A status indicator
troubleshooting with 145
NET B status indicator
locating 144
network cable 23
LCD HIM 28
LED HIM 28
233
Index
PowerFlex drives
compatible with adapter 13
definition 227
HIM 28
installing adapter on 20
quick start 16
Reference/Feedback
definition 227
in I/O image for
ControlLogix controller 80
PLC-5, SLC 500 or MicroLogix 1100 controllers 82
setting an adjustment 41
using 84
related documentation 8
Peer-to-Peer hierarchy
configuring adapter
to receive data 38
to transmit data 37
definition 227
S
safety precautions 15
scanner 228
ping 227
PLC-5 controller
limitations when using the I/O 68
using the I/O 96
234
Index
status indicators
definition 228
Link 145
NET A 145
NET B 144
Network 145
normal operation 24
PORT 144
troubleshooting with 144??, 145??, 145??
understanding 143
Z
zero data
configuring the adapter for 41
definition 229
T
TCP (Transmission Control Protocol) 229
TCP/IP Interface object 211
technical support 8
tools required 13
troubleshooting 143151
U
UDDT (User-Defined Data Type) 229
UDP (User Datagram Protocol) 229
W
Web Enable parameter 179
Web Features parameter 179
web pages
enabling with parameter 42
for the adapter 153??
website
BOOTP utility 221
DriveExecutive software 223
DriveExplorer software 223
DriveTools SP software 223
EDS files 224
EtherNet/IP 224
manuals 8
ODVA (Open DeviceNet Vendors Association) 224
RSLogix 5/500/5000 software 228
wiring, see cable, Ethernet
235
Index
236
U.S. Allen-Bradley Drives Technical Support - Tel: (1) 262.512.8176, Fax: (1) 262.512.2222, Email: [email protected], Online: www.ab.com/support/abdrives
www.rockwellautomation.com
Power, Control and Information Solutions Headquarters
Americas: Rockwell Automation, 1201 South Second Street, Milwaukee, WI 53204-2496 USA, Tel: (1) 414.382.2000, Fax: (1) 414.382.4444
Europe/Middle East/Africa: Rockwell Automation, Pegasus Park, De Kleetlaan 12a, 1831 Diegem, Belgium, Tel: (32) 2 663 0600, Fax: (32) 2 663 0640
Asia Pacific: Rockwell Automation, Level 14, Core F, Cyberport 3, 100 Cyberport Road, Hong Kong, Tel: (852) 2887 4788, Fax: (852) 2508 1846
Copyright 2013 Rockwell Automation, Inc. All rights reserved. Printed in USA.