Sunteți pe pagina 1din 128

I/A Series System

FDSI Driver
Allen-Bradley
EtherNet/IP Driver

B0700BU
Rev E
August 30, 2012

Invensys, Foxboro, I/A Series, and the Invensys logo are trademarks of Invensys plc, its subsidiaries, and
affiliates.
All other brand names may be trademarks of their respective owners.
Copyright 20082012 Invensys Systems, Inc.
All rights reserved

SOFTWARE LICENSE AND COPYRIGHT INFORMATION


Before using the Invensys Systems, Inc. supplied software supported by this documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the software license for your system govern your obligations
and usage rights to the software described in this documentation. If any portion of
those license provisions is violated, Invensys Systems, Inc. will no longer provide you
with support services and assumes no further responsibilities for your system or its
operation.
2. All software issued by Invensys Systems, Inc. and copies of the software that you are
specifically permitted to make, are protected in accordance with Federal copyright
laws. It is illegal to make copies of any software media provided to you by
Invensys Systems, Inc. for any purpose other than those purposes mentioned in the
software license.

Contents
Figures................................................................................................................................... vii
Tables..................................................................................................................................... ix
Preface.................................................................................................................................... xi
Who This Document Is For ..................................................................................................... xi
What You Should Know .......................................................................................................... xi
Revision Information ............................................................................................................... xi
Reference Documents ............................................................................................................. xii
I/A Series Documents ......................................................................................................... xii
AB EtherNet/IP Device Documents ................................................................................... xii
Glossary of Terms .................................................................................................................. xiii
1. Introduction ...................................................................................................................... 1
Example Configurations Supported .......................................................................................... 2
Options Supported ..................................................................................................................
Multiple Device Support ....................................................................................................
Long Tag Name Support Using Device Configuration Files ...............................................
Configurable Device Scan Rate ..........................................................................................

11
11
11
11

Performance ............................................................................................................................ 11
Limitations .............................................................................................................................. 11
FDSI Loading Guidelines ........................................................................................................ 12
Loading Guidelines when Using Tag Length Other Than 12-Character Tag Names .......... 13
2. Installation ...................................................................................................................... 15
I/A Series Hardware ................................................................................................................ 15
Allen-Bradley Hardware ..........................................................................................................
Additional Notes ................................................................................................................
Software .............................................................................................................................
Quick Start Sequence of Operations ...................................................................................

15
15
15
17

3. Configuration.................................................................................................................. 19
Overview ................................................................................................................................. 19
Port Configuration File .......................................................................................................... 19
FBM General Properties Tab ............................................................................................. 19
FBM Advanced Properties Tab .......................................................................................... 20
Device Configuration File ....................................................................................................... 21
iii

B0700BU Rev E

Contents

General Tab Configuration ............................................................................................... 21


Groups Tab Configuration ................................................................................................ 23
Points Tab Configuration ................................................................................................... 23
Configuring I/A Series Control Blocks .................................................................................... 24
Configuring an ECB200 or ECB202 Block ........................................................................ 26
Device Configuration ..............................................................................................................
Configuring DVNAME ................................................................................................
Configuring DVOPTS ..................................................................................................
Device Scan Rate Selection .................................................................................................

27
28
28
29

Configuring DCI Blocks .........................................................................................................


DCI Blocks and Default Data Types ..................................................................................
Support of Arrays ..........................................................................................................
IIN/IINR ......................................................................................................................
IOUT ............................................................................................................................
RIN/RINR ....................................................................................................................
ROUT ..........................................................................................................................
BIN/BINR ....................................................................................................................
BOUT ...........................................................................................................................
PAKIN/PAKINR ..........................................................................................................
Word Mirroring Option with PAKIN blocks ................................................................
PAKOUT ......................................................................................................................

29
31
31
33
33
34
35
35
36
36
37
38

4. ControlLogix Configuration............................................................................................ 39
Heartbeat Message Support ................................................................................................
Time Synchronization of ControlLogix with I/A Series ......................................................
Accessing the Redundant ControlLogix System Status .......................................................
Accessing the MAC Address of the ControlLogix System ..................................................
Accessing the ControlLogix Battery Status .........................................................................

39
40
41
42
43

5. Principles of Operation ................................................................................................... 45


Overview ................................................................................................................................. 45
FDSI FBM Operation ............................................................................................................. 45
Redundant FBM Operation .................................................................................................... 46
Length of Tag Name and Performance ............................................................................... 47
Redundancy Failover .......................................................................................................... 47
6. Error Reporting ............................................................................................................... 49
Device Fail Timer ................................................................................................................... 49
Device Communication Status/Error Data ..............................................................................
Good Messages Sent ...........................................................................................................
Good Messages Received ....................................................................................................
Response Timeouts Counter ..............................................................................................
Worst Case Response Timeout Counter .............................................................................
Reset Counters ...................................................................................................................

iv

49
49
50
50
50
51

Contents

B0700BU Rev E

7. FoxView Software Diagnostic Process Displays............................................................. 53


Display File and Database Generation ..................................................................................... 53
FBM Status .............................................................................................................................
Simplex Configuration ..................................................................................................
Redundant Configuration .............................................................................................
Device Status ......................................................................................................................
Simplex ControlLogix ...................................................................................................
Redundant ControlLogix ...............................................................................................
Device Diagnostics ............................................................................................................
Redundant FBM Configuration ....................................................................................

53
54
54
56
56
58
60
61

Configuration of DCI Blocks for Diagnostic Displays .............................................................


FBM Status (FS.fdf) ...........................................................................................................
Simplex Configuration ..................................................................................................
Redundant Configuration .............................................................................................
Device Status .....................................................................................................................
Simplex Configuration ..................................................................................................
Redundant Configuration .............................................................................................
Device Diagnostics .............................................................................................................
Simplex Configuration ..................................................................................................
Redundant Configuration .............................................................................................

61
61
61
62
62
62
62
63
63
63

EIP.bat Operational Overview ................................................................................................ 63


Adding Devices to Existing Configurations ........................................................................ 65
Organization of FoxView Diagnostic Display Files .............................................................. 66
FS.fdf ................................................................................................................................. 66
DS_DEV.fdf and DD_DEV.fdf ......................................................................................... 67
Appendix A. EtherNet/IP Message Formats Used with ControlLogix ................................. 69
Multi Request Service for Reading or Writing Multiple Points ...............................................
ControlLogix Read Message Format ...................................................................................
ControlLogix Write Message Format .................................................................................
ControlLogix Read/Write Result Message Format ..............................................................

69
69
69
70

Appendix B. ControlLogix Configuration ........................................................................... 73


ControlLogix IP Address Configuration ..................................................................................
Configuring IP Address for the ENBT module ..................................................................
Setting the IP Address ..................................................................................................
Enabling/Disabling BOOTP and DHCP ......................................................................
Configuring Two ENBT Modules in the Same Chassis ......................................................
Configuring IP Address for the EN2T Module ..................................................................
Configuring Two EN2T Modules in the Same Chassis ......................................................

73
73
74
74
75
76
76

ControlLogix Point Tag Name and Database Configuration ...................................................


Configuring Drivers ...........................................................................................................
Verifying Communication between RSLogix PC and ControlLogix ...................................
Communicating with the Device from RSLogix PC ...........................................................
Creating and Downloading a New Database ......................................................................

76
77
80
81
86
v

B0700BU Rev E

Contents

Online Operations ............................................................................................................. 94


Configuring a Large Number of Points .............................................................................. 96
Appendix C. ControlLogix Redundancy System.................................................................. 99
Overview ............................................................................................................................ 99
Ethernet Switchover ........................................................................................................... 99
Configuring Same IP Address to the EN2T Modules ....................................................... 100
Appendix D. Driver Performance Data ............................................................................. 103
Performance Data for a Single Device with Various Tag Lengths .......................................... 103
Performance Data for Multiple Devices with Various Tag Lengths ....................................... 104
Appendix E. FDSI Sizing Spreadsheet Instructions ........................................................... 107
Requirements ........................................................................................................................ 107
Overview ............................................................................................................................... 107
Enable Macros ...................................................................................................................... 108
Enter Configuration Data ..................................................................................................... 110
View Results .......................................................................................................................... 111

vi

Figures
1-1.
1-2.
1-3.

Non-Redundant FBM Interfacing with a Single ControlLogix Device .......................... 2


Non-Redundant FBM Interfacing with Multiple ControlLogix Devices ....................... 3
Redundant FBMs Interfacing with a Single ControlLogix (Multiple ENBTs)
Device using External Interlink between Ethernet Switches .......................................... 4
1-4. Redundant FBMs Interfacing with Multiple ControlLogix (Multiple ENBTs) Devices
Using External Interlink between Ethernet Switches ..................................................... 5
1-5. Redundant FBMs Interfacing with a Single ControlLogix (Single ENBT) Device
using External Interlink with a Single Switch ................................................................ 6
1-6. Redundant FBMs Interfacing with a Single Redundant ControlLogix Device using
ENBT Modules with External Interlink Between Ethernet Switches ............................. 7
1-7. Redundant FBMs Interfacing with a Multiple Redundant ControlLogix Devices Using
ENBT Modules with External Interlink Between Ethernet Switches ............................. 8
1-8. Redundant FBMs Interfacing with a Single Redundant ControlLogix Device using
EN2T Modules with External Interlink Between Ethernet Switches ............................. 9
1-9. Redundant FBMs Interfacing with a Multiple Redundant ControlLogix Devices Using
EN2T Modules with External Interlink Between Ethernet Switches ........................... 10
2-1. Sequence of Operations ............................................................................................... 17
3-1. FBM General Properties Tab for the Configuration .................................................... 20
3-2. Ethernet Port FBM Advanced Properties Tab ............................................................. 21
3-3. General Tab Page FDSI Configurator Device Configuration File ......................... 22
3-4. Groups Tab Page ........................................................................................................ 23
3-5. Points Tab Page .......................................................................................................... 24
3-6. The I/A Series Control Database (Non-Redundant) .................................................... 25
3-7. The I/A Series Control Database (Redundant) ............................................................ 25
3-8. PAKCIN to ControlLogix Data Correspondence with WM Option ........................ 37
4-1. Rungs Required for Time Synchronization ................................................................. 40
4-2. Rungs Required to Access Redundant ControlLogix System Status ............................. 42
4-3. Rung Required for Accessing the Battery Status .......................................................... 43
7-1. FBM Status Under Simplex Configuration (FS.fdf) .................................................... 54
7-2. FBM Status Under Redundant Configuration (FS.fdf) ............................................... 55
7-3. Device Status Under Simplex Configuration (DS_DEV.fdf) ....................................... 56
7-4. Device Status Under Redundant Configuration (DS_DEV.fdf) .................................. 58
7-5. Device Diagnostics Under Simplex Configuration (DD_DEV.fdf) ............................. 60
7-6. Device Diagnostics Under Redundant Configuration (DD_DEV.fdf) ........................ 61
B-1. EN2T Module - Top View ......................................................................................... 76
B-2. RSLinx Lite Dialog Box .............................................................................................. 77
B-3. Configure Drivers Dialog Box ..................................................................................... 77
B-4. Add New RSLinx Driver Dialog Box .......................................................................... 78
B-5. Configure Driver [Driver Type] Dialog Box ............................................................... 79
B-6. Configure Drivers Dialog Box ..................................................................................... 80
B-7. RSLinx Lite - RSWho ................................................................................................. 81
B-8. Who Active Dialog Box .............................................................................................. 82
B-9. Enter New or Select Existing File Dialog Box ............................................................. 83
B-10. Create Project File and Upload ................................................................................... 84
vii

B0700BU Rev E

B-11.
B-12.
B-13.
B-14.
B-15.
B-16.
B-17.
B-18.
B-19.
B-20.
B-21.
B-22.
B-23.
B-24.
B-25.
E-1.
E-2.
E-3.

viii

Figures

Uploading Controller Tags ......................................................................................... 85


Controller Tags - Data Points ..................................................................................... 86
New Controller Dialog Box ........................................................................................ 87
New Module Selection ................................................................................................ 88
Select Module Type Dialog Box .................................................................................. 89
Module Properties Dialog Box .................................................................................... 90
Creating New Tag ....................................................................................................... 91
New Tag Dialog Box ................................................................................................... 92
Who Active Dialog Box .............................................................................................. 93
Download Dialog Box ................................................................................................. 93
Controller in Online State ........................................................................................... 94
Module in Run Mode ................................................................................................. 95
Creating New Tag ....................................................................................................... 95
Configured New Tag .................................................................................................. 96
Selecting to Export ...................................................................................................... 97
Excel Security Warning ............................................................................................. 108
Microsoft Office Security Options Dialog Box .......................................................... 109
Sizing Spreadsheet Overview ..................................................................................... 110

Tables
1-1.
1-2.
3-1.
3-2.
3-3.
3-4.
3-5.
3-6.
3-7.
D-1.
D-2.

Performance Data for Simplex FBM232 ..................................................................... 12


Performance Data for Redundant FBM233 ................................................................ 13
ECB200 Configuration (Non-Redundant) .................................................................. 26
ECB202 Configuration (Redundant) .......................................................................... 26
ECB201 Configuration ............................................................................................... 27
Data Type Mnemonics Used in PNT_NO ................................................................. 30
DCI Block Types vs. AB-ControlLogix Data Types .................................................... 30
Fields Supported In Timer, Counter and Control Data Types .................................... 31
DCI Block vs. Default Data Types .............................................................................. 31
Performance Data for a Single Device with Various Tag Lengths, Simplex FBM232
and Redundant FBM233 ......................................................................................... 103
Performance Data for Multiple Devices with Various Tag Lengths ........................... 104

ix

B0700BU Rev E

Tables

Preface
This document describes the I/A Series System Field Device System Integrator Allen-Bradley
EtherNet/IP driver utilizing FBMs 232 and 233.

Who This Document Is For


This document is intended for the use of process control engineers and operators, instrument and
maintenance engineers and other qualified and authorized personnel involved in setting up, configuring and maintaining I/A Series system equipment to provide EtherNet/IP communications
capability.

What You Should Know


Basic information not covered in this document is covered in detail in the Field Device System
Integrators (FBM230/231/232/233) Users Guide (B0700AH). You should be familiar with the
I/A Series system, and with the DIN Rail Mounted Subsystem Users Guide (B0400FA). Detailed
information relating to the various I /A Series software and hardware elements is found in the reference documents listed below. You should also be generally aware of TCP/IP communication.

Revision Information
For this revision of the document (B0700BU-E), the following change has been made:
Global
Added information about using 1756-EN2T EtherNet/IP module.
Chapter 1 Introduction
Updated configurations shown in Figure 1-1 through Figure 1-5.
Update figure names for Figure 1-6 and Figure 1-7.
Added Figure 1-8 and Figure 1-9.
Chapter 2 Installation
Updated Allen-Bradley Hardware on page 15.
Chapter 3 "Configuration"
Changed Figure 3-6 and Figure 3-7 on page 25 to read SFILID.
Updated Device response time in Table 3-3 on page 27.
Updated Configuring DVOPTS on page 28.

Updated section Support of Arrays on page 31 for TIMER, COUNTER and


CONTROL array types.

Updated data types in Table 3-5 DCI Block Types vs. AB-ControlLogix Data Types
on page 30.

xi

B0700BU Rev E

Preface

Added IIN to Table 3-6 Fields Supported In Timer, Counter and Control Data
Types on page 31.
Updated the following sections for redundant DCI block support: IIN on page 33,
RIN on page 34, BIN on page 35, and PAKIN on page 36.
After sections RIN and ROUT on page 35, added a note for NAN support
information.
Chapter 7 FoxView Software Diagnostic Process Displays
Updated the following Device Status information for Simplex ControlLogix on
page 56 and Redundant ControlLogix on page 58:
RUN / PROGRAM / TEST MODE.
Appendix B ControlLogix Configuration
Added Configuring IP Address for the EN2T Module on page 76 and Configuring
Two EN2T Modules in the Same Chassis on page 76.
Appendix C ControlLogix Redundancy System
Added Configuring Same IP Address to the EN2T Modules on page 100.
Appendix E FDSI Sizing Spreadsheet Instructions
Added this appendix.

Reference Documents
The following documents provide additional and related information:

I/A Series Documents


You should be familiar with the following I/A Series documents:
Field Device System Integrators (FBM230/231/232/233) Users Guide (B0700AH,
Revision D or higher)
DIN Rail Mounted Subsystem Users Guide (B0400FA)
FBM232 Field Device System Integrator Module, 10/100Mbps Ethernet, Single (PSS
21H-2Z32 B4)
FBM233 Field Device System Integrator Module, 10/100 Mbps Ethernet, Redundant
(PSS 21H-2Z34 B4).
Most of these documents are available on the I/A Series Electronic Documentation CD-ROM or
DVD (K0173TQ or K0173WT) provided by the Foxboro business unit of Invensys Process Systems (IPS). The latest revisions may also be available through the IPS Global Customer Support
at
http://support.ips.invensys.com.

AB EtherNet/IP Device Documents


For additional information, refer to the following Allen-Bradley documentation:
Allen-Bradley ControlLogix Redundancy System
(Publication 1756-UM535_-en-p - October 2009)

xii

Allen-Bradley ControlLogix Controllers User Manual


(Publication 1756-UM001F- EN-P- May 2005)

Preface

B0700BU Rev E

Allen-Bradley Logix5000 Data Access - Reference Manual


(Publication 1756-RM005A-EN-E March 2000)
Allen-Bradley ControlLogix Redundancy System
(Publication 1756-UM523E-EN-P- May 2005)

Glossary of Terms
The following terminology, used throughout this document, relates to the FBM232/233 and
associated software.
AB

Rockwell Allen-Bradley

Alias

An alias is a short simple name that can be used in the I/A Series DCI
Block for a ControlLogix I/O point that has a long tag name. The alias
can be used to specify the tag when you configure DCI blocks. Using the
EtherNet/IP driver aliasing feature requires that you create and use a
device configuration file.

Backup Module

The FBM233 that is physically inserted into the base plate in the position
of backup module (the right-hand side of a valid pair of slot positions).

CIP

The Common Industrial Protocol (CIP) is a class of open protocols which


includes EtherNet/IP, DeviceNet and ControlNet.

EtherNet/IP

CIP on Ethernet over TCP/IP

Control Station/
Control Processor

This is any I/A Series module or workstation that effects process control
via the I/A Series Ethernet Control network. An example is the Field Control Processor 270 (FCP270). The control station/processor controls process variables using algorithms contained in functional control blocks
configured by on-site process engineers to implement the desired control
strategies.

DIN Rail
Mounted
Subsystem

The DIN rail mounted subsystem provides a high speed communication


interface between the host control processor (for example, an I/A Series
control station) and field I/O sensors and actuators. DIN rail mounted
devices, which include FBMs, FCMs, and supporting cables and connectors, mount on a baseplate which, in turn, mounts on a DIN rail. The
DIN rail mounted subsystem is described in detail in DIN Rail Mounted
Subsystem Users Guide (B0400FA).

DHCP

The Dynamic Host Configuration Protocol provides a method of assigning dynamic IP addresses to devices on a network; that is, assigning IP
addresses that are not fixed. With DHCP enabled, the FBM may have a
different IP address every time it connects to the network.

DCI

Distributed Control Interface (DCI) control blocks are I/A Series control
blocks that support connectivity of I/A Series control stations to various
bus-resident devices via a general purpose interface. These control blocks

xiii

B0700BU Rev E

Preface

are used in conjunction with the FBM232/233 to interface digital field


device I/O communications with the I/A Series control station.

xiv

ECB

An equipment control block is created for each FBM and external field
device, and provides communications with that FBM or external field
device.

FBM

Fieldbus Modules provide the interface between process sensors/actuators


and the Fieldbus in a standard I/A Series system. The FBM232 and 233
are examples of the many types of FBMs offered as part of the I/A Series
system.

FCM

The Fieldbus Communications Module is an interface which allows the


FBM232/233 (and other I/A Series DIN rail mounted modules) to communicate with the control station via the I/A Series 100 Mbps Ethernet
Fieldbus. It converts the 10 Mbps or 100 Mbps Ethernet signals used by
the control station to 2 Mbps signals used by the FBM232/233, and vice
versa.

FCS Configuration
Tools

The Foxboro Control Software (FCS) Configuration Tools are software


packages that allow users to to configure control strategies. FCS Configuration Tools can be used to create and configure I/A Series control blocks,
DCI control blocks, and ECBs. Other control configuration tools include
FoxCAE, ICC and IACC.

Fieldbus

With regard to the I/A Series system, this term applies in general to two
specific buses: the I/A Series system 100 Mbps Ethernet Control network
and the I/A Series system 2 Mbps Module Fieldbus.

FoxCAE
Software

Computer-Aided Engineering software is an application used to configure


control strategies. FoxCAE can be used to create and configure I/A Series
control blocks, DCI control blocks, and equipment control blocks
(ECBs). Other control configuration tools include FCS Configuration
Tools, IACC and ICC.

Group

A Group is a logical collection of I/O points (data points) that are all
scanned in a single message to the device. The driver takes care of dividing
the I/O point to groups by default. Using device configuration files the
user can specify the grouping of I/O points.

IACC

I/A Series Configuration Component (IACC) is a software package used


to configure control strategies. IACC can be used to create and configure
I/A Series control blocks, DCI control blocks, and ECBs. Other control
configuration tools include FCS Configuration Tools, ICC and FoxCAE.

ICC

Integrated Control Configurator (ICC) is a software package used to configure control strategies. ICC can be used to create and configure
I/A Series control blocks, DCI control blocks, and ECBs. Other control
configuration tools include FCS Configuration Tools, IACC and FoxCAE.

Preface

B0700BU Rev E

Letterbug

This is an identifier for I/A Series control devices, particularly for Fieldbus
Modules (FBMs).

Main Module

The FBM233 that is physically inserted into the base plate in the position
of main module (the left-hand side of a valid pair of slot positions).

Master

The FBM233 module of the pair that is communicating with the CP.
Either module of the pair can be the Master module as indicated by a status indicator on the front of the module.

Modular Baseplate

The modular baseplate provides mounting for DIN rail mounted modules. Its 2, 4, or 8 mounting positions can accommodate FBMs, FCMs,
and FCP270s. The modular baseplates also provide the necessary connectors for dc power, time strobe, the I/A Series Fieldbus Module, and termination cables.

Tag Name

A symbolic name given to a variable on ControlLogix PLC which can be


accessed as an I/O point by the FDSI.

Parameter

A named element in the data structure of a device function block, ECB, or


I/A Series control block.

Tracker

The FBM233 module of the pair that is tracking the master module communication with the field device(s). Either module of the pair can be the
Tracker module as indicated by a status indicator on the front of the
module.

xv

B0700BU Rev E

xvi

Preface

1. Introduction
This chapter provides an introduction to the Allen-Bradley EtherNet/IP driver for Field Device
System Integrators (FDSI) and describes the FDSI to ControlLogix interface configurations
supported.
Currently the driver supports interfacing with ControlLogix controllers only.
EtherNet/IP is the application protocol used for this interface, where IP stands for Industrial
protocol. EtherNet/IP is part of a class of protocols named CIP (Common Industrial Protocol). It
is an open protocol published and maintained by the ODVA organization. It runs on top of
TCP/IP or UDP/IP.
This driver enables interfacing the FDSI with Allen-Bradley ControlLogix PLC in Native mode.
Native mode means accessing data in ControlLogix PLC using tag names. A tag name is an
ASCII string name assigned to a variable in ControlLogix PLC. A user first configures data points
in ControlLogix using tag names and then uses the I/A Series system to access the ControlLogix
data points using those tag names for PNT_NO parameters of DCI blocks.
You can download the EtherNet/IP driver into FDSI FBMs 232 and 233, thus enabling the
I/A Series system to interface to ControlLogix using Logix5000 CIP commands. Communication
at application layer level is with the Logix5000 controller (processor) card in a ControlLogix chassis. This implementation uses explicit unconnected CIP messaging over TCP/IP for unscheduled data acquisition.
The driver uses the following Logix5000 CIP service command listed in the Allen-Bradley
Logix5000 Data Access Reference Manual to interface with ControlLogix: multi request service
for reading or writing multiple points.
This document explains the procedure to install and configure the downloadable AB EtherNet/IP
driver on a FBM232/233. The driver is contained in the file EthernetIP.ziph and is responsible
for receiving the point values from ControlLogix as well as sending I/A Series point values.
NOTE

All references to AB Ethernet IP devices in this document refer to ControlLogix


Controllers.

B0700BU Rev E

1. Introduction

Example Configurations Supported


A typical non-redundant FBM/non-redundant ControlLogix network configuration for the
FBM232 is shown in Figure 1-1 and Figure 1-2.

* The CP can also be a ZCP communicating to the FBM through the FCM
# EN2T module can be used in place of ENBT module
Figure 1-1. Non-Redundant FBM Interfacing with a Single ControlLogix Device

1. Introduction

B0700BU Rev E

* The CP can also be a ZCP communicating to the FBM through the FCM
# EN2T module can be used in place of ENBT module
Figure 1-2. Non-Redundant FBM Interfacing with Multiple ControlLogix Devices

B0700BU Rev E

1. Introduction

Typical redundant FBM/non-redundant ControlLogix network configurations for the FBM233


are shown in Figure 1-3, Figure 1-4, and Figure 1-5.

* The CP can also be a ZCP communicating to the FBM through the FCM
# EN2T modules can be used in place of ENBT modules
Figure 1-3. Redundant FBMs Interfacing with a Single ControlLogix (Multiple ENBTs)
Device using External Interlink between Ethernet Switches

1. Introduction

B0700BU Rev E

* The CP can also be a ZCP communicating to the FBM through the FCM
# EN2T modules can be used in place of ENBT modules
Figure 1-4. Redundant FBMs Interfacing with Multiple ControlLogix (Multiple ENBTs) Devices
Using External Interlink between Ethernet Switches

B0700BU Rev E

1. Introduction

* The CP can also be a ZCP communicating to the FBM through the FCM
# EN2T module can be used in place of ENBT module
Figure 1-5. Redundant FBMs Interfacing with a Single ControlLogix (Single ENBT) Device
using External Interlink with a Single Switch

1. Introduction

B0700BU Rev E

Typical redundant FBM/redundant ControlLogix network configurations for the FBM233 are
shown in Figure 1-6, Figure 1-7, Figure 1-8, and Figure 1-9.

* The CP can also be a ZCP communicating to the FBM through the FCM
Figure 1-6. Redundant FBMs Interfacing with a Single Redundant ControlLogix Device using
ENBT Modules with External Interlink Between Ethernet Switches

B0700BU Rev E

1. Introduction

* The CP can also be a ZCP communicating to the FBM through the FCM
Figure 1-7. Redundant FBMs Interfacing with a Multiple Redundant ControlLogix Devices Using
ENBT Modules with External Interlink Between Ethernet Switches

1. Introduction

B0700BU Rev E

* The CP can also be a ZCP communicating to the FBM through the FCM
Figure 1-8. Redundant FBMs Interfacing with a Single Redundant ControlLogix Device using
EN2T Modules with External Interlink Between Ethernet Switches

B0700BU Rev E

1. Introduction

* The CP can also be a ZCP communicating to the FBM through the FCM
Figure 1-9. Redundant FBMs Interfacing with a Multiple Redundant ControlLogix Devices Using
EN2T Modules with External Interlink Between Ethernet Switches

10

1. Introduction

B0700BU Rev E

Options Supported
Multiple Device Support
The driver supports multiple devices. Connecting multiple devices to a FBM232/FBM233
requires the use of Ethernet Hubs or Ethernet Switches. Up to 64 ControlLogix devices can be
connected, subject to performance limitations of FDSI. Refer to FDSI Loading Guidelines on
page 12 for performance data with multiple devices with various loading conditions.

Long Tag Name Support Using Device Configuration Files


By default the driver supports tag names up to 29 characters long where as the maximum size of a
tag name allowed in ControlLogix is 40 characters. The driver provides the option to support tag
names up to 40 characters through the use of device configuration files. Refer to the section titled
Port and Device Configuration Files in Field Device System Integrators (FBM230/231/232/233)
Users Guide (B0700AH) for detailed information.

Configurable Device Scan Rate


By default, the FDSI polls the configured I/O points in the ControlLogix at a rate of 1 second.
You can override the default scan rate through the DVOPTS parameter of device ECB.

Performance
The EtherNet/IP driver sends scan messages with the Tag name, data type, and certain overhead
bytes for each point. The driver performance depends on various factors such as length of each
point tag name, number of points, number of devices, and the Device Scan Rate selected for
each device. These various factors determine the FBMs CPU usage which should not exceed 60%
for FDSI FBM233 and 75% for FDSI FBM232.
Refer to Field Device System Integrators (FBM230/231/232/233) Users Guide (B0700AH) for configuring DCI blocks to determine FBM CPU usage.

Limitations
The driver can access ControlLogix tags scoped as controller tags. Program scoped tags cannot
be accessed. This is a limitation from ControlLogix.
Up to 64 ControlLogix devices can be configured to communicate to one FBM232 (non-redundant) or a pair of FBM233s (redundant) on the Ethernet, subject to the performance limitations
of the FBMs. Up to 64 redundant ControlLogix devices can be configured to communicate to a
pair of FBM233s.
FDSI FBMs 232 and 233 can handle up to 2,000 I/O points. See Field Device System Integrators
(FBM230/231/232/233) Users Guide (B0700AH) for more detail on the number of points supported by the FBM.
The driver provides an option to synchronize I/A Series time with ControlLogix PLCs, but the
accuracy of synchronization is less than a second. This is a limitation in the ControlLogix Controller. To use the redundant FBM configuration, the FBMs must be configured for a non DHCP
network.

11

B0700BU Rev E

1. Introduction

FDSI Loading Guidelines


This section describes loading guidelines to use while interfacing to single and multiple ControlLogix devices.
The loading of a simplex FDSI FBM232 or a redundant FDSI FBM233 is limited either by the
FDSI CPU usage or by the number of points the FDSI can access from the device and process
during the device scan rate period. For scan rates smaller than 1 second, the performance is limited by the latter. FDSI CPU usage can be found using the diagnostic DCI block
CPU_USAGE described in Field Device System Integrators (FBM230/231/232/233) Users Guide
(B0700AH). The CPU_USAGE is dependent on several factors: device scan rate, number of DCI
blocks per device, number of devices, length of tag names used, and the CP BPC. The CPU usage
must not exceed 75% for FDSI FBM232; it must not exceed 60% for FDSI FBM233.
A sizing spreadsheet is provided on the driver CD. That spreadsheet can be used to find the maximum number of points that can be processed by an FBM232 or FBM233 redundant pair for a
chosen number of devices and device scan rate. The spreadsheet is applicable for configurations
where all tags are of length 12. It allows the user to select any number of devices from 1 to 64
and any scan rate. The spreadsheet can be used to calculate the number of FBMs required for
interfacing to one or more ControlLogix devices.
Loading guidelines and performance for other configurations are presented below. All the performance data presented in this section meets the two criteria listed above, namely, less than maximum FDSI CPU usage requirement and the ability to completely process all the points in the
device scan period.
Table 1-1 below shows the performance data (maximum number of points in an FDSI) for the
simplex FBM232 with CP BPC= 0.5 seconds, device scan rate with1 and 1.5 seconds, with a typical tag length of 10 characters.
Table 1-1. Performance Data for Simplex FBM232

Number of
Devices
1
2
3

12

Number of
Points
500
800
900

CPU Usage %
Scan Rate @ 1 Sec
27
50
56

Scan Rate @ 1.5 Sec


22
42
46

1. Introduction

B0700BU Rev E

Table 1-2 below shows the performance data (maximum number of points in an FDSI) for the
redundant FBM233 with CP BPC=0.5 seconds, various device scan rates from 0.2 seconds to 5
seconds, and 1 to 5 devices with tag length of 12 characters. For instance, at a device scan rate of
0.5 seconds, you can interface to 3 devices and access 450 points total from the three devices.
Table 1-2. Performance Data for Redundant FBM233

Scan Rate (in Seconds)


0.2
0.5
1
2
3
4
5

1 Device
80
200
400
780
1150
1500
1800

2 Devices
120
300
600
1000
1340
1740
1940

3 Devices
180
450
600
990
1350
1590
1740

4 Devices
240
520
600
820
1080
1480
1610

5 Devices
250
500
525
850
1075
1200
1600

NOTE

The recommended block period to use for a given scan rate is twice the device scan
rate as the FDSI scans are asynchronous to CP block execution cycles.
For example, consider the case with two devices: Device A with 50 points to be
accessed and updated in the CP every 1 second and Device B with 200 points to be
accessed and updated in the CP every 2 seconds.
For Device A, choose a device scan rate of 0.5 seconds and block execution period
of 1 second for all DCI blocks under the device. For Device B, choose a device scan
rate of 1 second and block execution period of 2 seconds for all DCI blocks under
the device. The block execution period of a DCI block is set through the period
parameter of the block.

Loading Guidelines when Using Tag Length Other Than 12Character Tag Names
Performance data for a single device with tag lengths of 8, 12, 14, 30, 32, and 40 characters is presented in Appendix D Driver Performance Data.
Performance data for interfacing to multiple devices with tag lengths of 8, 14, 32, and 40 characters is also presented in Appendix D Driver Performance Data.

13

B0700BU Rev E

14

1. Introduction

2. Installation
This chapter provides FDSI hardware and software, and Allen-Bradley device installation
instructions.
General FDSI hardware and software installation instructions are given in Field Device System
Integrators (FBM230/231/232/233) Users Guide (B0700AH). B0700AH contains a section titled
Quick Start Example, which outlines a typical sequence for installing and configuring an
I/A Series system and associated field equipment and also provides a quick-start flow chart. Procedures to install the FDSIs and Allen-Bradley EtherNet/IP driver in this document correspond to
the quick-start flow chart and quick-start procedures given in B0700AH. When performing an
installation, keep the quick-start flow chart and procedures handy for reference.

I/A Series Hardware


You need an FBM232 or FBM233s, and an available 200 Series FBM baseplate slot(s) in which to
install the module(s). For complete installation instructions for the FBM232/233s, refer to Field
Device System Integrators (FBM230/231/232/233) Users Guide (B0700AH). Installation of FDSI
hardware corresponds to Steps 1 and 2 in the quick-start flow chart.

Allen-Bradley Hardware
You need an Allen-Bradley ControlLogix controller with either an 1756-ENBT EtherNet/IP
module or an 1756-EN2T EtherNet/IP module. Refer to Allen-Bradley ControlLogix Controllers
User Manual (Publication 1756-UM001F- EN-P) to install, configure, and operate a ControlLogix system. Appendix A EtherNet/IP Message Formats Used with ControlLogix summarizes
the procedures to configure ControlLogix PLCs for the various configurations supported by the
driver.

Additional Notes
An Ethernet switch or hub is required in the FBM232 to ControlLogix Interface to enable connection of a PC running RSLogix software to configure and/or monitor ControlLogix while it is
connected to the FBM.
A link between the Ethernet switches connected to the FBMs is needed to support redundant
FBM operation as shown in redundant figures (Figure 1-3 and Figure 1-4). That link enables the
tracker FBM to get point updates from the master FBM.

Software
Refer to Section 2 in Field Device System Integrators (FBM230/231/232/233) Users Guide
(B0700AH) for complete software installation instructions. Software installation is covered in
Step 3 in the quick-start flow chart.
Software requirements include the following:
AB EtherNet/IP Driver for FDSI CD-ROM (K0174CP)

FDSI Configurator CD-ROM (K0173WZ).


15

B0700BU Rev E

2. Installation

The FDSI AB EtherNet/IP Driver software is distributed on a CD-ROM. Insert the disc into the
host workstations CD-ROM drive. The installation should start automatically. If it does not,
click Start > Run then type E:\setup.exe.
There are no installation options to pick during the install. Click Next at each dialog box; and
click Finish at the end of the installation.
The following FDSI AB EtherNet/IP Driver files are installed in d:\usr\fox\sp\files\devices:
EthernetIp.ziph This file is the downloadable FDSI EtherNet/IP driver
EthernetIp_Rev.txt This file contains the version information on driver file.
In addition to the driver files, there are also other files installed:
EIPClx_NonRedun.XML Example non-redundant port configuration XML file
EIPClx_Redun.XML Example redundant port configuration XML file
CLXDeviceExample.XML Example device configuration XML file
ExampleClXCFG.ACD- Example ControlLogix configuration file
B0700BU.pdf This user document is installed in d:\usr\help.
Sample display files (.fdf ) and their corresponding I/A Series block database files
(.dat) are also installed. There are three display files for simplex and three for redundant configuration. The *.dat files are iccDrvrTask script files that can be used to
install diagnostic DCI blocks associated with the displays. Refer to Chapter 7 FoxView Software Diagnostic Process Displays for more details.
The simplex files are installed in d:\usr\fox\sp\files\devices\EIP\Simplex. The redundant files are installed in d:\usr\fox\sp\files\devices\EIP\Redundant

16

2. Installation

B0700BU Rev E

Quick Start Sequence of Operations


Figure 2-1 shows the configuration and download sequence of operations.

Figure 2-1.

Sequence of Operations

17

B0700BU Rev E

18

2. Installation

3. Configuration
This chapter describes how to configure I/A Series control and the FDSI driver.

Overview
Following are the I/A Series Control and FDSI Driver Configuration steps:
1. Create, configure, and save a port configuration file.
2. Create, configure, and save the device configuration file if required.
3. Configure I/A Series control blocks:
a. Configure an ECB200/ECB202.
b. Configure a device ECB201 for each AB ControlLogix device.
4. Configure DCI blocks for Data Point Connections.
The quick start flow chart from Field Device System Integrators FBM230/231/232/233) Users
Guide (B0700AH) is shown in Figure 2-1.
These steps are described in the following subsections.

Port Configuration File


For the FBM232/FBM233, the FDSI Port Configurator defines the IP addresses of the FBM
ports. Using the Port Configurator, enter each ports IP address (one IP address in the case of an
FBM232 or two IP addresses in the case of the FBM233). Refer to the section titled Port and
Device Configuration Files in Field Device System Integrators FBM230/231/232/233) Users Guide
(B0700AH) for detailed procedures to configure FDSI Ethernet port IP addresses.
The following sections describe the settings for the port configuration file created for redundant
configuration with FBM233.

FBM General Properties Tab


Figure 3-1 shows the FBM General Properties tab for the port configuration required to support
FBM233. Only private networks with no DHCP addresses are supported by the driver.

19

B0700BU Rev E

3. Configuration

Figure 3-1. FBM General Properties Tab for the Configuration

FBM Advanced Properties Tab


Figure 3-2 shows the settings supported by the driver. The default redundancy algorithm where
both the master and tracker scan the device is not supported. The Redundancy Algorithm
option Ext_Ilink is the only supported setting.
In the example shown, the Redundancy Algorithm edit box contains the algorithm string
Ext_Ilink+UR=1000 which enables the operation of the External Interlink redundancy scheme.
See Chapter 6 FDSI Module Redundancy in the Field Device System Integrators
(FBM230/231/232/2B33) Users Guide (B0700AH) for more information.
After saving the port configuration file, the file must be manually copied to the
d:\usr\fox\sp\files\devices directory of the I/A Series host workstation.

20

3. Configuration

B0700BU Rev E

Figure 3-2. Ethernet Port FBM Advanced Properties Tab

Device Configuration File


A device configuration file must be created or edited when the option +XML is chosen with the
DVOPTS parameter in the device ECB201 block. The device configuration file is supported to
allow a user to specify a ControlLogix tag name size greater than 32 characters. The tag name size
supported without a device configuration file is limited to 29 characters if the data type is specified. Refer to Device Configuration on page 27 for information on configuring the DVOPTS
parameter in the ECB201.
Device configuration files facilitate scanning of different groups of points at different rates. A few
important points for which you need frequent updates can be put in a group with a fast scan rate
while the other groups of points can be scanned at a slower scan rate.

General Tab Configuration


Figure 3-3 shows the General Tab page of FDSI Configurator for device configuration file. For
general instructions on creating and modifying a new or existing device configuration file using
the FDSI Configurator, refer to the section titled Port and Device Configuration Files in Field
Device System Integrators (FBM230/231/232/233) Users Guide (B0700AH).
21

B0700BU Rev E

3. Configuration

Figure 3-3. General Tab Page FDSI Configurator Device Configuration File

NOTE

The fields in the heartbeat section are not used by the driver.
Refer to Chapter 4 ControlLogix Configuration for heartbeat configuration.

22

3. Configuration

B0700BU Rev E

Groups Tab Configuration


Figure 3-4 shows the Groups Tab page. It contains the information defined by the Device Configurator. Add groups using unique group names and optionally their Scan Rates.

Figure 3-4. Groups Tab Page

With the configuration in Figure 3-4, the group INTGROUP is scanned at a periodic rate of
2000 ms, the group SINTGROUP at a rate of 1000 ms, and the group DINTGROUP at the rate
of 3000 ms.
The default scan rate, 1 second, is used if the scan rate is not configured in the Device Configuration file.

Points Tab Configuration


Figure 3-5 shows the Points Tab page. Add points using a unique PNT_NO for each point, its
Address (tag name in ControlLogix), and the Group to which this point belongs. Select the Block
Type and Data Type for the point. The other parameters like Miscellaneous and Special Parameters that are left bank are not supported by this driver.

23

B0700BU Rev E

3. Configuration

Figure 3-5. Points Tab Page

As shown in Figure 3-5, the alias name of a point is entered in PNT_NO and the actual tag name
of the point in the device is entered in Address. Note that the data type of the block is specified in
the PNT_NO parameter. Note that the PNT_NO parameter is the same as the NAME parameter in Figure 3-5. The PNT_NO parameter for each of the corresponding DCI blocks should
match the PNT_NO parameter in the device configuration file.
After saving the device configuration file, you must manually copy the file to the
d:\usr\fox\sp\files\devices directory of the I/A Series host workstation. The device configuration
filename is specified in the ECB201 parameter FILEID.

Configuring I/A Series Control Blocks


The blocks to be configured and their relationship are shown in Figure 3-6 for FBM232 and in
Figure 3-7 for FBM233. This illustrates the configuration of three points in an AB ControlLogix
PLC connected to an FBM232/233 with default options.
Figure 3-6 corresponds to the hardware configuration of Figure 1-1.

24

3. Configuration

B0700BU Rev E

Figure 3-6. The I/A Series Control Database (Non-Redundant)

Figure 3-7 corresponds to the hardware configuration of Figure 1-3.

Figure 3-7. The I/A Series Control Database (Redundant)

25

B0700BU Rev E

3. Configuration

Configuring an ECB200 or ECB202 Block


The EtherNet/IP driver requires a port ECB (ECB200 or ECB202) with the I/A Series standard
naming convention of 6 characters, with the last 2 characters representing the baseplate number
and numerical position; for example, for the first baseplate (0): 01 through 08 when non-redundant or alphabetical position 0A through 0D when redundant. See the section titled Letterbug
Assignments in the Field Device System Integrators FBM230/231/232/233) Users Guide
(B0700AH).
The ECB200/202 parameters are configured as shown below:
Table 3-1. ECB200 Configuration (Non-Redundant)

Parameter

Value

NAME

SLOT05

TYPE
DEV_ID

ECB200
SLOT05

HWTYPE
SWTYPE
PORTEX
FILEID

232
232
1
ETHERNET.XML

SFILID

ETHERNETIP.ZIPH

Description
Contains the name used by the CP to access this
ECB.
Defines a non-redundant FBM
6-character ID: first 4 character same as the
FCM100Et. For the FCP270, the last 2 are baseplate positions (01 through 08).
232 for non-redundant Ethernet FBM
Same as HWTYPE
For FBM232/233
Set FILEID to the filename of the port configuration XML file.
Set the SFILID to the name of the downloadable
driver, ETHERNETIP.ZIPH

Table 3-2. ECB202 Configuration (Redundant)

Parameter

26

Value

NAME

SLOT0B

TYPE
DEV_ID

ECB202
SLOT0B

HWTYPE
SWTYPE
PORTEX
FILEID

233
233
1
ETHERNET.XML

SFILID

ETHERNETIP.ZIPH

Description
Contains the name used by the CP to access this
ECB.
Defines a redundant FBM
6-character ID: first 4 character same as the
FCM100Et. For the FCP270, the last 2 are baseplate pair positions (0A through 0D).
233 for redundant Ethernet FBM
Same as HWTYPE
For FBM232/FBM233
Set FILEID to the filename of the port configuration XML file.
Set the SFILID to the name of the downloadable
driver ETHERNETIP.ZIPH.

3. Configuration

B0700BU Rev E

Device Configuration
The FDSI EtherNet/IP driver requires one device ECB (ECB201) for each ControlLogix Device
to be interfaced. Refer to the Section Control Block Configuration Information in Field Device
System Integrators FBM230/231/232/233) Users Guide (B0700AH) for detailed instructions to
configure an ECB201 block. A sample configuration of the device ECB201 block is shown below.
Table 3-3. ECB201 Configuration

Parameter

Value

NAME
TYPE
DEV_ID
HWTYPE
SWTYPE
PARENT
DVNAME

*
ECB201
*
232/233
232/233
*
*

DVOPTS

PORTNO

Description
The name of the block
Type of the block
The device ID
Defines a non-redundant/redundant Ethernet FBM
Same as HWTYPE
Compound Name: Block Name of parent ECB200
IP address or IP addresses of ControlLogix
Refer to Configuring DVNAME on page 28.

Driver Name: EIP


PLC Type: CLX
(Driver Name and the PLC Type should be separated
by /. Example: EIP/CLX)
Device Scan Rate: To specify a scan rate, add +@X,
where the value of X is in tenths of a second (default
value is 10 which corresponds to 1 second). X can be
one or any higher number. The scan rate selected
depends on a number of factors. See Device Scan Rate
Selection on page 29.
Device response time: To specify how long the driver
waits for a response to a command before retrying add
"+TO=X", where the value of X is in tenths of a second
(default value is 10 which corresponds to 1 second)
Device Configuration file support: To enable the driver
for supporting device configuration file, add +XML
(by default the driver does not support the device configuration file)
Slot number: To specify the slot number of the ControlLogix processor card add +SN= m, where m is the
physical slot number in the chassis (default is Slot 0)
Time synchronization of I/A Series with ControlLogix:
To enable this function add +TS.
Refer to Configuring DVOPTS on page 28.
Default for FBM232/233

27

B0700BU Rev E

3. Configuration

Table 3-3. ECB201 Configuration (Continued)

Parameter
FILEID

Value
<filename>.XML
(For example, CLXDev.XML)

Description
Device configuration file name needs to be specified if
option +XML is chosen in DVOPTS.

Configuring DVNAME
Case: Simplex configuration (Figure 1-1)

Configure the IP address of the ControlLogix Ethernet port.


For example: 192.168.1.150
Case: Redundant with two 1756-ENBT Ethernet modules (Figure 1-3)

Specify the IP addresses of the two 1756-ENBT modules in DVNAME separated by a semicolon.
For example: 192.168.1.20;192.168.1.21
Where:
MainIpAddress = 192.168.1.20
BackupIpAddress = 192.168.1.21
MainIpAddress is the IP address of the ControlLogix Ethernet port connected to the main FBM
and BackupIpAddress is the IP address of the ControlLogix Ethernet port connected to the backup
FBM.
Case: Redundant using the 1757-SRMs (Figure 1-6)

Configure the IP addresses of the primary controller only.


For example: 192.168.1.160
For the hardware configuration shown in Figure 1-6, you only need to configure one IP address
and that is the address of the Primary Controller as shown in the example. The Master FBM and
the Tracker FBM both communicate with the Primary Controller. Do NOT configure both the
Primary and Secondary Controller IP addresses. Doing so causes the redundant functionality to
work improperly.

Configuring DVOPTS
The following is an example setting of the DVOPTS parameter:
DVOPTS= EIP/CLX+@10+TO=20+XML+SN=2+TS
This syntax indicates that the driver name is EIP, the device is ControlLogix, the scan message
period is 1000 ms, the response timeout is 2000 ms, a device configuration file is used, and the
ControlLogix processor card (Logix 55xxx or Logix 56xxxx) is located at slot 2 of the ControlLogix chassis.
To use the TS option, configure the ControlLogix as described in Chapter 4 ControlLogix
Configuration.
The TS feature allows the ControlLogix to be time synchronized with the I/A Series system with
an accuracy of one second. The driver checks the ControlLogix time at an interval of 30 minutes
and sets the new time if required.

28

3. Configuration

B0700BU Rev E

NOTE

The scan rate and time-out options are in units of tenths of a second.

Device Scan Rate Selection


The scan rate selected depends on a number of factors such as number of points, tag name length
of each point, and number of devices. Use the following table as reference for selecting the scan
rate when using one device. The device scan rate in the table is specified in seconds. An entry in
the table needs to be multiplied by ten to arrive at the Device Scan Rate value to enter in the
ECB201 DVOPTS parameter.

Tag Name Length


(in Characters)

100 pts

500 pts

1000 pts

1500 pts

2000 pts

8
12
14
30
40

0.2
0.25
0.3
0.5
0.6

1
1.25
1.5
2.5
3

2
2.75
3
5
6

3
4
4.5
7.5
9

4
5.5
6
10
12

Configuring DCI Blocks


After configuring the ECB200/ECB202 and ECB201, configure the required DCI blocks to
access the point information from the ControlLogix device.
The driver supports the following predefined data types in ControlLogix:
BOOL
BOOLEAN ARRAY
SINT (8 bit integer)
INT (16 bit integer)
DINT (32 bit integer)
REAL (32 bit float)
TIMER (32 bit integer units of milliseconds)
COUNTER (32 bit integer)
CONTROL (32 bit integer)
Array (single dimensional)
NOTE

ControlLogix data type User defined data type (UDT) is not supported by the
driver. A workaround is to use the aliasing feature in ControlLogix to map each element in a UDT type data to a new tag which can be accessed as a simple data type
by the driver.

29

B0700BU Rev E

3. Configuration

Data type mnemonics used for specifying the type in PNT_NO parameter of the DCI block are
listed in the table below.
Table 3-4. Data Type Mnemonics Used in PNT_NO

Data Type

Mnemonic

8 bit signed integer


16 bit signed integer
16 bit unsigned integer
32 bit signed integer
32 bit unsigned integer

S1
S2
U2
S4
U4

The various configuration options available in the DCI blocks to support the above data types are
listed in Table 3-5. An entry of * indicates support and # indicates support of Word Mirroring.
Refer Word Mirroring Option with PAKIN blocks on page 37 for more information on Word
Mirroring.
The XML file referred to in the block configurations below is the optional device configuration
file.
Table 3-5. DCI Block Types vs. AB-ControlLogix Data Types
Data Types in
ControlLogix
Bool

Control Block
BIN

BOUT

IIN

IOUT

RIN

ROUT

Boolean Array

PAKIN

PAKOUT

*#

SINT (signed 8 bit)

* X:S1

* X:S1

INT (signed 16 bit)

* X:S2
X:U2

* X:S2
X:U2

*
X:U2

*
X:U2

DINT (signed 32 bit)

*
#
X:S4
X:U4

*
X:S4
X:U4

REAL (32 bit)

Timer (32 bit)

* X.Y

* X.Y

* X.Y

Counter (32 bit)

* X.Y

* X.Y

* X.Y

Control (32 bit)

* X.Y

* X.Y

* X.Y

Array
(one dimensional)

NOTE

In Table 3-5, X: is the tag name and Y: is the field as defined in Table 3-6 below.

30

3. Configuration

B0700BU Rev E

Table 3-6. Fields Supported In Timer, Counter and Control Data Types

Fields
Data
Timer
Counter
Control

With PAKIN and IIN


Blocks
CTL
CTL
CTL

PRE
PRE
LEN

ACC
ACC
POS

With BIN Block


EN
CU
EN

TT
CD
EU

DN
DN
DN

FS
OV
EM

LS
UN
ER

OV

ER

UL

IN

FD

DCI Blocks and Default Data Types


The table below lists the default data type assigned for a block when data type specification is
omitted from the PNT_NO parameter.
Table 3-7. DCI Block vs. Default Data Types

DCI Block
IIN, IOUT
PAKIN, PAKOUT

Default Data Type


S4 (32 bit signed integer)
Boolean Array

Support of Arrays
Access of single dimensional array data in ControlLogix is supported by the driver.
The supported data types of the elements within the array are:
SINT (8 bit integer)
INT (16 bit integer)
DINT (32 bit integer)
REAL (32 bit float)
Boolean Array (32 bit binary)
Timer Array
Counter Array
Control Array
To access the array data type in ControlLogix, each element of the array needs to be mapped to a
single DCI block. The format of PNT_NO parameter to access an array element is:
array tag name[index].field - For Timer, Counter and Control arrays
where field is Field as defined in Table 3-6. The index is zero based.
For example, to access the fields EN and PRE of the array Timer1[10], use the following format
for PNT_NO of BIN, PKINGP of PAKIN blocks.
Timer1[0].EN
Timer1[1].EN
.
.
.

31

B0700BU Rev E

3. Configuration

Timer1[9].EN for PNT_NO of BIN blocks


Timer1[0].PRE
Timer1[1].PRE
.
.
Timer1[9].PRE for PKINGP of PAKIN blocks

array tag name[index]:data Type


where data Type is optional. If data type is omitted the default data type of the block is used. If
only the array name is entered, the first element of the array is accessed. The index is zero based.
For example, to access the elements of the array SintArray[50] where the data type of the elements
is signed 8 bit integer, use the following format for PNT_NO of IIN or IOUT blocks.
SintArray[0]:S1
SintArray[1]:S1
.
.
SintArray[49]:S1

NOTE

Boolean Arrays are organized differently from other arrays in ControlLogix.


Boolean Array Tags in the ControlLogix device can only be created with array lengths in multiples
of 32. The entries in these arrays cannot be accessed by BIN/BOUT blocks. They are instead
accessed as groups of 32 bits using PAKIN or PKOUT blocks. For example if you configure a tag
BoolArray1 with size 64, to access bits BoolArray1[0] to BoolArray1[31] using PAKIN, the
PKINGP parameter of the block should be set to BoolArray1[0]; to access bits BoolArray1[32] to
BoolArray1[63] using PAKIN, the PKINGP parameter of the block should be set to
BoolArray1[1]. Similarly, PAKOUT can be used to access the Boolean Arrays using the
PKCOGP parameter.

32

3. Configuration

B0700BU Rev E

IIN/IINR
Integer input or redundant integer input blocks hold integer values received from the ControlLogix device.
Parameter

Value

Description

NAME
TYPE

*
IIN(R)

IOM_ID

PNT_NO (IIN)

Name of the point


Defines the block as a single (IIN) Integer input
block or redundant (IINR) Integer input block
Provides a complete path to the parent ECB201
block.
Format:Tagname:Data type

II1_PT (IINR)
II2_PT (IINR)
II3_PT (IINR)

Tag name: As specified in the Device


(If data type is specified, the tag name can be no
longer than 29 characters)
Data type: S1, U2, S2, S4.
32 bit signed integer is assumed if no data
type is specified
If device configuration file is used:
As specified in the "Point Name" of the Device
Configuration file.
(If Point name is found in XML file, then Data
type and Tag name mentioned in the address
field of the corresponding point will be used)

IOUT
Integer output blocks hold integer values sent to the ControlLogix device.
Parameter
NAME
TYPE
IOM_ID

Value
*
IOUT
*

Description
Name of the point
Defines the block as an Integer output block
Provides a complete path to the parent ECB201
block

33

B0700BU Rev E

3. Configuration

Parameter

Value
*

Description
Tag name (Point name) as specified in the device.
32-bit signed integer is assumed if no data type is
specified following the tag name.
Other allowed formats are:
Tag name:dataType
Where:
dataType can be S1, U2, S2, S4
S4 is the default data type
If data type is specified, the tag name can be
no longer than 29 characters
If value matches a value specified in XML file,
then address field from corresponding point
in XML file is used as the tag name

RIN/RINR
Real input Redundant Real Input blocks hold real values received from the ControlLogix device.
Parameter

Value

NAME
TYPE

*
RIN(R)

IOM_ID

PNT_NO (RIN)

RI1_PT (RINR)
RI2_PT (RINR)
RI3_PT (RINR)

Description
Name of the point
Defines the block as a single (RIN) or redundant
(RINR) Real input block
Provides a complete path to the parent ECB201
block
Tag name as specified in the Device.
Default 32 bit float assumed.
If device configuration file is used:
As specified in the "Point name" of the Device
Configuration file.
(If point name is found in XML file, then Tag
name mentioned in the address field of the corresponding point will be used)

34

3. Configuration

B0700BU Rev E

ROUT
Real output blocks hold real values sent to the ControlLogix device.
Parameter

Value

NAME
TYPE
IOM_ID

*
ROUT
*

PNT_NO

Description
Name of the point
Defines the block as a Real output block
Provides a complete path to the parent ECB201
block
Tag name as specified in the device.
32-bit float assumed
If value matches a value specified in XML file,
then address field from corresponding point in
XML file is used as the tag name

NOTE

RIN/ ROUT block is marked as bad when the value read from ControlLogix is
NAN (Not A Number) value.

BIN/BINR
Boolean input or redundant Boolean Input blocks hold Boolean values received from the ControlLogix device. A BIN or BINR block can be mapped to a ControlLogix tag(s) with data type
Boolean or Binary Fields of Timer, Counter, and Control tags. If no data type is specified in the
PNT_NO parameter, the tag is expected to be of type Boolean Tag.
Parameter

Value

NAME
TYPE

*
BIN(R)

IOM_ID

PNT_NO (BIN)

BI1_PT (BINR)
BI2_PT (BINR)
BI3_PT (BINR)

Description
Name of the point
Defines the block as a single (BIN) or redundant
(BINR) Boolean input block
Provides a complete path to the parent ECB201
block
Tag name as specified in the Device.
If device configuration file is used:
As specified in the "Point name" of the Device
Configuration file.
(If point name is found in XML file, then Tag
name mentioned in the address field of the corresponding point will be used.)

35

B0700BU Rev E

3. Configuration

BOUT
Boolean output blocks hold Boolean values sent to the ControlLogix device.
Parameter

Value

NAME
TYPE
IOM_ID

*
BOUT
*

PNT_NO

Description
Name of the point
Defines the block as a Boolean output block
Provides a complete path to the parent ECB201
block
Point name as specified in the device.
If value matches a value specified in XML file, then
address field from corresponding point in XML file
is used as the tag name

PAKIN/PAKINR
Packed input or redundant packed input blocks hold packed binary values received from the ControlLogix device. A PAKIN or PAKINR block can be mapped to a ControlLogix tag(s) with data
type Boolean Array or DINT. If no data type is specified in the PNT_NO parameter ,the tag is
expected to be of type Boolean Array.
Parameter

Value

NAME
TYPE

*
PAKIN(R)

IOM_ID

PNT_NO (PAKIN)

PKI1_PT (PAKINR)
PKI2_PT (PAKINR)
PKI3_PT (PAKINR)

Description
Name of the point
Defines the block as a single (PAKIN) or
redundant (PAKINR) pack input block
Provides a complete path to the parent
ECB201 block
Tag name as specified in the Device.
32-bit packed binary is assumed if no data
type is specified following the tag name
Other allowed formats are
Tag name:dataType
Where data type can be U4, S4
U4 is the default data type. Use S4 if the
data type of point in device is DINT.
If data type is specified, the tag name can be
no longer than 29 characters
If value matches a value specified in XML
file, then address field from corresponding
point in XML file is used as the tag name.

36

3. Configuration

B0700BU Rev E

Word Mirroring Option with PAKIN blocks


The word mirroring is supported with the PAKIN blocks mapped to Dint (signed 32 bit) or
Boolean Array Tags. The option : WMafter the tag-name at PKINGP parameter of the PAKIN
block mirrors the upper word (bits 1 to 16) and the lower word (bits 17 to 32) as shown in the
table below.

PAKCN

PAKIN

DINT

15

15

14

14

13

13

12

12

11

11

10

10

10

11

12

13

14

15

16

17

31

15

18

30

14

19

29

13

20

28

12

21

27

11

22

26

10

23

25

24

24

25

23

26

22

27

21

28

20

29

19

30

18

31

17

32

16

PLC - 1

PLC - 2

Figure 3-8. PAKCIN to ControlLogix Data Correspondence with WM Option

One of the uses of this option is for the migration of the legacy systems using MCIN with
IOMOPT=1. Refer to the Allen Bradley Integrator 30 to FDSI Migration (DI700BS) document for
further detail.

37

B0700BU Rev E

3. Configuration

Below are some examples of PKIN_GP parameters with : WM option.


DintTag1:S4: WM
DintTag2:U4: WM
BoolArray: WM

for use with a DINT data type in ControlLogix


for use with a unsigned 32-bit data type in ControlLogix
for use with Boolean Array data type

PAKOUT
Packed output block holds packed binary values to be written to the ControlLogix device. A PAKOUT block can be mapped to a ControlLogix tag with data type Boolean Array or DINT. If no
data type is specified in PNT_NO parameter the tag is expected to be of type Boolean Array.
Parameter

Value

NAME
TYPE
IOM_ID

*
PAKOUT
*

PKCOGP

Description
Name of the point
Defines the block as a pack output block
Provides a complete path to the parent
ECB201 block
Tag name (Point name) as specified in the
device.
32-bit boolean array is assumed if no data
type is specified following the tag name.
Other allowed formats are
Tag name: dataType
Where
dataType can be U2, U4, S4
Use S4 or U4 if the data type of point
in device is DINT; and U2 if the data
type is INT
If data type is specified, the tag name
can be no longer than 29 characters
If value matches a value specified in
XML file, then address field from corresponding point in XML file is used as
the tag name

PAKOUT Block Limitations

When using a PAKOUT block, the controller (CP270) requires exclusive control of the
ControlLogix PLC bits associated with the PAKOUT registers. If a value is set by any source
other than the I/A Series system, I/A Series control software will overwrite the value the next time
a write occurs.
! CAUTION
Unexpected results occur if you allow anything other than I/A Series software to
modify bits and registers in a PLC associated with an I/A Series PAKOUT block.

38

4. ControlLogix Configuration
This chapter describes the additional configuration required to support the following
functionality in the FDSI to ControlLogix interface, in addition to the standard ControlLogix
configuration.

Heartbeat Message Support


The driver sends out a heartbeat message to read the device time from ControlLogix to confirm
the link status when a device fails or if no points are configured.
Also, in redundant configuration, the tracker module sends out a heartbeat message to read the
device time from ControlLogix to confirm the link status. For this you need to configure the tag
DEV_TIME in ControlLogix as detailed below. Note that the driver does not require a DCI
block to be configured with this tag name.
Tag name

Data Type

Ladder Logic Needed

Purpose

DEV_TIME

DINT[7]

A GSV instruction with


Class Name: WALLCLOCKTIME
Attribute Name: DateTime
Dest: dev_time[0]

The FDSI driver reads this


tag to check the status of the
link to ControlLogix.

39

B0700BU Rev E

4. ControlLogix Configuration

Time Synchronization of ControlLogix with I/A Series


If the device option TS is configured in DVOPTS parameter of the device ECB201 block, the
FDSI driver will synchronize ControlLogix time with I/A Series time using the tags described
below. Note that the driver does not require any DCI blocks to be configured for any of these
tags.
Tag name

Data
Type

Ladder Logic Instructions


Needed

DEV_TIME

DINT[7]

A GSV instruction with


Class Name: WALLCLOCKTIME
Attribute Name: DateTime
Dest: dev_time[0]

The FDSI driver reads the DEV_TIME tag to


get the current ControlLogix time.

TSYNC_TAG

DINT[7]

As shown in Figure 4-1, on its own


rung, create one SSV instruction
with Class Name: WALLCLOCKTIME
Attribute Name: DateTime
Dest: TSYNC_TAG

The FDSI driver writes the time values to


TSYNC_TAG.

TSYNC_FLG

BOOL

As shown in Figure 4-1, on the same


rung as the SSV instruction (but positioned before it), create a single XIC
using the tag name TSYNC_FLG.
Below this rung, create another rung
with a single OU instruction using
the TSYNC_FLG tag name.

The TSYNC_FLG XIC instruction is always


false until the FDSI writes true. After the
FDSI driver sets the time values in
TSYNC_TAG, it writes true to
TSYNC_FLG. This causes the XIC instruction to allow the SSV to execute which sets
the time. The TSYNC_FLG must be cleared
to prevent the SSV from continuously executing. The Output Unlatch (OU) on the next
rung clears the TSYNC_FLG.

Purpose

A snapshot of the rungs that need to be created at the ControlLogix device for the time synchronization is shown in Figure 4-1below.

Figure 4-1. Rungs Required for Time Synchronization

40

4. ControlLogix Configuration

B0700BU Rev E

Accessing the Redundant ControlLogix System Status


For the hardware configuration shown in Figure 1-6 with redundant FBMs interfaced to redundant ControlLogix PLCs, the status of the redundant ControlLogix system can be monitored by
the I/A Series system. This is accomplished by configuring tags in ControlLogix that correspond
to its redundancy object attributes, updating the ladder logic program using GSV instructions
to update those tags, and configuring corresponding DCI blocks with the same tag names. The
complete list of redundancy object attributes is described in Appendix C of Allen-Bradley ControlLogix Redundancy System (Publication 1756-UM523E-EN-P). Some of the attributes and their
significance are described in the table below.
The data type of a DCI block that maps to a ControlLogix redundancy object must be selected
using Table 3-5, DCI Block Types vs. AB-ControlLogix Data Types on page 30. For instance, if
the data type of device tag is INT, the data type qualifier in PNT_NO of the IIN DCI block is
S2. An error in using the correct data type will result in the corresponding point remaining in
OOS state.
Some of the redundant ControlLogix attributes and their significance are listed in the table below.

Attribute

Data Type

Significance

ChassisRedundancy State

Integer

The status of the entire system

QualificationInProgress

Integer

PhysicalChassisID

Integer

A number that indicates if the secondary is synchronized or not


Identifies the chassis (A or B) which is
primary

A snapshot of the rungs that need to be created at the ControlLogix device is shown in Figure 4-2.

41

B0700BU Rev E

4. ControlLogix Configuration

Figure 4-2. Rungs Required to Access Redundant ControlLogix System Status

Accessing the MAC Address of the ControlLogix System


To get the MAC Address of the ControlLogix device connected to FDSI, create a STRIN block as
shown in table below.
Parameter

Value

NAME
TYPE
IOM_ID

*
STRIN
*

PNT_NO

MACADDRESS

Description
Name of the point
Defines the block as an String input block
Provides a complete path to the parent
ECB201 block
If device configuration file is used, the
Address field should be set with the value
MACADDRESS

As this block will be used for the diagnostic display purpose, we suggest you to create this block
under the DIAG_DISP compound and set the point name as MAC.

42

4. ControlLogix Configuration

B0700BU Rev E

Accessing the ControlLogix Battery Status


To get the battery status of the ControlLogix device connected to FDSI, create a rung as shown in
table below.

Tag name
MinorFaultBits

Data Type
Integer

Ladder Logic Instructions


Needed
A GSV instruction with
Class Name: FAULTLOG
Attribute Name: MinorFaultBits
Dest: MinorFaultBits

Purpose
The FDSI driver reads the
MinorFaultBits tag to get
the current battery status.
This is used in the device status display. Refer to
Chapter 7 FoxView Software Diagnostic Process Displaysfor more information.

A snapshot of the rung that needs to be created at the ControlLogix device is shown in Figure 4-3.

Figure 4-3. Rung Required for Accessing the Battery Status

43

B0700BU Rev E

44

4. ControlLogix Configuration

5. Principles of Operation
This chapter describes the I/A Series System interfacing to AB EtherNet/IP devices via the
EtherNet/IP driver.

Overview
This chapter provides an overview of the operation of the EtherNet/IP driver used for interfacing
an I/A Series system to AB EtherNet/IP devices.
After you configure the appropriate DCI blocks and ECBs using a control configurator such as
ICC, make sure that all ECBs are ONLINE and NOT FAILED (white) in SMDH, and enable
device communication from SMDH, the FDSI starts sending scan messages to the device. The
FDSI waits for responses from the device, processes the responses, and updates the I/O points in
the control processor (CP). The FBM runs as a TCP client and establishes a connection with the
server in the device before sending request messages.
Please refer to Appendix A EtherNet/IP Message Formats Used with ControlLogix for descriptions of the EtherNet/IP message format for all messages between the AB EtherNet/IP devices and
the FDSI.
In the redundancy case, each FBM233 communicates independently with the device via its communication connection. When the FBM running as master fails because it loses communication
with at least one device, it checks the status of the tracker FBM. If the tracker FBMs status is
good, the master FBM requests a role switch, causing the tracker to become the new master, and
the master to become the new tracker. Refer to Redundancy Failover on page 47 for additional
information on role switching in the redundant configuration.

FDSI FBM Operation


You must know two important procedures performed from the SMDH equipment change displays in order to make an FDSI FBM operational: Software Download and Data Base Download.
On the equipment change displays these picks are labeled EEPROM/SOFT DOWNLOAD and
DB DOWNLOAD respectively.
When an FDSI FBM is shipped from the factory, it is preprogrammed with the latest and proper
IOM23x file, but it does not have a driver. You must download the driver file (EthernetIP.ziph)
into the FBM. You can download the driver file as follows:
Set the ECB200 (or ECB202) ONLINE. This action enables other equipment change
actions such as Soft Download and DB Download. Upon performing this action, the
red LED located on the FBM faceplate turns off.

Pick the EEPROM/SOFT DOWNLOAD button, then the SOFT_DOWNLOAD


button to load the EthernetIp.ziph file into the FBM.

When the Soft Download is active, the SMDH Equipment Information display for
the FBM indicates Download Active on page 2 for redundant FBMs (233) and page 3
for single FBMs (232). Any existing port configuration XML files are deleted during a
Soft Download operation. After the EthernetIp.ziph file is successfully downloaded,
45

B0700BU Rev E

5. Principles of Operation

the FBM reboots automatically. During the reboot, the FBM appears FAILED and
the host CP is red (failed state) in SMDH.
Once the Soft Download is complete (the FBM is ONLINE - NOT FAILED), which
can take 2 minutes, perform a DB Download to install the port configuration XML
file. During this operation the FBM equipment information page should indicate
DCI NOT READY.

When the DB Download completes, the equipment information page indicates DCI
READY, and the FBM changes color on the display. In most instances, the FBM is
yellow because the ECB201s are not active yet.
For more details on SMDH equipment change actions, and equipment information pages, refer
to the Maintenance chapter in Field Device System Integrators (FBM230/231/232/233) Users
Guide (B0700AH).

Redundant FBM Operation


The above section, FDSI FBM Operation, applies to both FDSI FBM types (FBM232 and
233). Behavioral differences caused by redundant FBMs are in the area of FBM module status in
the SMDH Equipment Information display details. Another area of difference is the data transfers
between the CP and the FBMs and between the paired FBMs themselves.
As described above, the FBMs require a Software Download when the EtherNet/IP driver is to be
loaded or reloaded. When a pair of redundant modules (FBM231/233) is present on a baseplate,
the Software Download Equipment Change Action takes place first on one module then the
other. Each module reboots automatically during the Software Download.
Subsequently, you must perform the DB Download action to install the port configuration file.
The download takes place on the Master FBM. Subsequently, the Master automatically educates the Tracker FBM. In other words, the Master sends the port configuration XML file and
all the DCI block configuration information across to the Tracker via the interlink (internal) that
exists between the two modules.
The EtherNet/IP driver supports the redundancy configuration with external interlink option
only. Refer to the Field Device System Integrators (FBM230/231/232/233) Users Guide (B0700AH)
for a detailed description of this type of redundancy.
While a redundant pair is in operation, the Master FBM is in full communication with the host
CP. Data that is received from an EtherNet/IP device is made available to the CPs PIO scans on
the Master FBM only. CP outputs occur through the Master FBM to the devices. During this
time, the driver in the Tracker FBM is performing infrequent communication to the same devices
as the Master, to verify the connection status; that is, only the Master does reads from and writes
to the devices. The tracker uses the heartbeat command described in Chapter 4 ControlLogix
Configuration for communication with the devices. The tracker does not provide any input data
to the CP. However the tracker periodically communicates with the master through the external
interlink between the connected Ethernet switches and keeps up to date with the input point
updates so that it can take on the role of a master for bumpless switchover when needed. When a
role switch takes place (see Redundancy Failover on page 47), the Tracker FBM is in position to
take over as the new Master because it already has all the required configuration information
including current input/output data values and it is communicating with the same EtherNet/IP
devices.

46

5. Principles of Operation

B0700BU Rev E

Length of Tag Name and Performance


The EtherNet/IP protocol requires the driver to send scan messages that contain tag name and
point data type and other overhead of about 10 bytes for each point. Also AB EtherNet/IP devices
have a limit of 450 bytes for the length of a message. The number of scan messages required to
scan all the points specified by the DCI blocks configured depends on the number of points and
the length of tag names. Hence for high performance short tag names are recommended.
To achieve high performance with fast point updates, use the aliasing feature in ControlLogix to
alias points with long tag names to short tag names, and then access the points from I/A Series
using the short tag names.

Redundancy Failover
The EtherNet/IP driver supports the external interlink configuration. In this configuration,
only the master FBM sends the scan and write messages to the device(s). The tracker sends simple
queries (heartbeat messages) to monitor the status of its links to the device(s). When the Master
FBM fails to communicate with a device, it checks the status of the Tracker module. If the Tracker
is able to communicate with all the devices, the EtherNet/IP driver initiates a role switch, where
the Master becomes the Tracker and the Tracker becomes the new Master. If the present Trackers
device communication error condition clears up, and the new Master encounters a failure on one
of its devices, the EtherNet/IP driver initiates a role switch again.
A user can force a role switch via the SMDH equipment change action, even if the Tracker has a
failed device. If a role switch is forced by SMDH and the Tracker has one failed device but the
Master has none, the role switch does occur; however, the EtherNet/IP Master driver internally
senses that the new Tracker has no failed devices and initiates a second role switch, so that the
FBM with no failed devices becomes the Master again.
When a role switch occurs due to a failed device on one FBM, and the condition subsequently
clears up so that the device is communicating properly again, an automatic role switch does not
occur. If user wants the current Tracker module to become the Master, user must force a role
switch via SMDH or perform an SMDH RESET change action on the current Master module.
During normal operations and assuming the Main (left) FBM is the Master, page 3 of the
ECB201s Equipment Information display indicates Main Port Active, Dual Ported. When a
device fails on the Master FBM, SMDH changes the ECB colors from White to Yellow. Page 2 of
the Equip Info displays System Error and page 3 indicates:
Main Port Failed
Bkup Port Active (indicates that the backup FBM is Master)
Dual Ported.
The System Alarm log indicates: Role Switch due to Driver Request.
If both FBMs experience a failure that would cause an ECB201 to fail simultaneously, page 3 of
the ECB201 Equipment Information display shows:
Main Port Failed
Bkup Port Failed
Bkup Port Active (indicates that the backup FBM is Master)
Dual Ported.

47

B0700BU Rev E

48

5. Principles of Operation

6. Error Reporting
This chapter presents information regarding device status in regard to communications.

Device Fail Timer


Once a device is added and device communications are enabled from SMDH, the device status is
marked good. The status is set to fail under the following conditions:
The driver sends out a command to ControlLogix and waits until the timeout expires. If no reply
is received within the timeout time, two retries are attempted. If no reply is received, the device
is marked failed and the all the points associated with the device are marked OOS (out of service).
When a device is in the failed condition, the driver sends heartbeat messages to the device every
second.
The user can set the response timeout value greater or equal to the default time-out value in the
DVOPTS field of the ECB201.

Device Communication Status/Error Data


Diagnostic counter blocks can be created to monitor the operational status of the EtherNet/IP
driver communication with a ControlLogix device. These counter blocks are:
Number of good messages sent
Number of successful messages received
Number of response timeouts
Reset Counters
These counter blocks can be configured as follows:

Good Messages Sent


The number of good messages sent to a specific device may be monitored.
Block definition is as follows:
Parameter

Value

TYPE
IOM_ID

IIN
*

PNT_NO

Description
Defines the block as an integer input block
Provides a complete path to the parent ECB201
device block
FBM232: $MSGS_SENT
FBM233: $M_MSGS_SENT
$B_MSGS_SENT

49

B0700BU Rev E

6. Error Reporting

Good Messages Received


The number of good messages received from a specific device may be monitored.
Block definition is as follows:
Parameter

Value

TYPE
IOM_ID

IIN
*

PNT_NO

Description
Defines the block as an integer input block
Provides a complete path to the parent ECB201
device block
FBM232: $MSGS_RCVD
FBM233: $M_MSGS_RCVD
$B_MSGS_RCVD

Response Timeouts Counter


The number of response timeouts (no reply is received when a scan message is sent) on a specific
device may be monitored. The value displayed in this block updates ONLY for the current master
FBM with FBM233s. In other words, when the Main FBM runs as a Master, blocks with $M in
PNT_NO update where as when the Backup FBM runs as Master, blocks with $B in
PNT_NO update. The block is configured as shown below.
Parameter

Value

TYPE
IOM_ID

IIN
*

PNT_NO

Description
Defines the block as an integer input block
Provides a complete path to the parent ECB201
device block
FBM232: $RESP_TIMEOUTS
FBM233: $M_RESP_TIMEOUTS
$B_RESP_TIMEOUTS
Prefix $M corresponds to timeouts on the
Main FBM, while the prefix $B corresponds
to timeouts on the Backup FBM.

Worst Case Response Timeout Counter


The worst-case response timeout (the highest time taken by the device to respond for a command)
on a specific device may be monitored. The value displayed in this block updates ONLY for the
current master FBM with FBM233s. In other words, when the Main FBM runs as a master,
blocks with $M in PNT_NO update where as when the Backup FBM runs as master, blocks
with $B in PNT_NO update. The block is configured as shown below.
NOTE

The value in this block (represented in milliseconds) is only accurate if the response
time is less than the configured timeout value.

50

6. Error Reporting

B0700BU Rev E

Parameter

Value

TYPE
IOM_ID

IIN
*

PNT_NO

Description
Defines the block as an integer input block
Provides a complete path to the parent ECB201
device block
FBM232: $WORST_RESP_TIME
FBM233: $M_WORST_RESP_TIME
$B_WORST_RESP_TIME
Prefix $M corresponds to timeouts on the
Main FBM, while the prefix $B corresponds
to timeouts on the Backup FBM.

Reset Counters
All counter blocks are reset to 0 when the value in this block toggles.
Parameter

Value

TYPE
IOM_ID

BOUT
*

PNT_NO

Description
Defines the block as a Boolean output block
Provides a complete path to the parent ECB201
block
$RESET_CNTRS

51

B0700BU Rev E

52

6. Error Reporting

7. FoxView Software Diagnostic


Process Displays
This chapter presents information regarding the available diagnostic display files.
In addition to FBM diagnostics, these displays also provide most of the device status information
that is shown in RSLogix 5000. The FDSI EIP Driver provides detailed ControlLogix specific
diagnostic information through the use of DCI blocks mapped to diagnostics related tags in the
ControlLogix Controllers.

Display File and Database Generation


All of the diagnostic display files referred to in this chapter can be generated automatically by
using the EIP.bat utility installed in d:\usr\fox\sp\files\devices\EIP. This batch script file uses predefined .fdf and .dat template files to create all of the diagnostic files and the requisite DCI data
blocks described in this chapter.
The information presented in this chapter is automatically handled by the EIP script file but is
included in case some customizations may be required.
The display files in the sections below are listed by their template names. However, when the files
are generated by EIP.bat, the file names will be prefixed by the Device Name. For example,
Figure 7-3 below shows DS_DEV.fdf - the Simplex device status display. Using DEV1 as an
example ECB name, the same display file is named DS_DEV1.fdf instead of DS_DEV.fdf.

FBM Status
This display shows the FBM diagnostic information. The diagnostic information in this display is
mapped to the FBM diagnostic blocks, MEM Load, CPU Usage and the IP Address described in
Field Device System Integrators (FBM230/231/232/233) Users Guide (B0700AH).

53

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Simplex Configuration

Figure 7-1. FBM Status Under Simplex Configuration (FS.fdf)

FDSI
LETTERBUG

Displays the current letterbug assigned to the FBM

MEM LOAD

Displays the current memory load of the FBM

CPU USAGE

Displays the current CPU usage of the FBM

IP ADDRESS

Displays the current IP address of the FBM. In the parenthesis it shows if


it is fixed IP or DHCP enabled (Fixed / DHCP).
For each ECB201 configured, a corresponding button at the bottom of the display is enabled. A
click on the enabled button takes you to its respective device diagnostics (DD_DEV.fdf ) display.

Redundant Configuration
Under redundant configuration the above information is shown for both MAIN and BACKUP
FBMs as displayed below.

54

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Figure 7-2. FBM Status Under Redundant Configuration (FS.fdf)

55

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Device Status
This display shows the device (ControlLogix) status. The following information is displayed for a
non-redundant ControlLogix device.

Simplex ControlLogix

Figure 7-3. Device Status Under Simplex Configuration (DS_DEV.fdf)

56

FDSI
LETTERBUG

Displays the current letterbug assigned to the FBM

PRODUCT REV

The current product revision of the device is displayed in decimal.

SERIAL
NUMBER

Serial number of the device is displayed in hexadecimal. The serial number is assigned when the device is built.

DEVICE STATUS

Displays the current device status (RUN / PROGRAM / TEST MODE)

LOGIX STATUS

Key switch in (RUN / PROGRAM / REMOTE)

7. FoxView Software Diagnostic Process Displays

FAULT STATUS

Displays the current device fault status. One of the following message is
displayed.
Recoverable Min Fault:
Unrecoverable Min fault:
Recoverable Maj Fault:
Unrecoverable Maj fault:
No Fault:

MAC ADDRESS

B0700BU Rev E

Recoverable minor fault


Unrecoverable minor fault
Recoverable major fault
Unrecoverable major fault
There are no faults

Displays the MAC address of the ControlLogix Ethernet port.

FBM-Dev Comm
Displays the current communication status (GOOD / FAILED)
Status
Graphics:
The RUN LED on the graphic indicates the device status. (Green RUN, Black PROGRAM).
The battery LED on the graphic indicates the actual battery status of the device. (Red Faulty,
Green Good)
The key position on the graphic matches the actual key position of the device.
For each ECB201 configured, a corresponding button at the bottom of the display is enabled. A
click on the enabled button takes you to its respective device diagnostics (DD_DEV.fdf ) display.
There are two buttons present at the top-right corner.
FS:
DD:

Takes you to the FBM Status display (FS.fdf )


Takes you to Device Diagnostic display (DD_DEV.fdf ) of the current device.

57

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Redundant ControlLogix
The information presented in this display is read from primary ControlLogix.

Figure 7-4. Device Status Under Redundant Configuration (DS_DEV.fdf)

FDSI
LETTERBUG

Displays the current letterbug assigned to the FBM

PRODUCT REV

The current product revision of the device is displayed in decimal.

SERIAL
NUMBER

Serial number of the device is displayed in hexadecimal. The serial number is assigned when the device is built.

DEVICE STATUS

Displays the current device status (RUN / PROGRAM / TEST MODE)

LOGIX STATUS

Key switch in (RUN / PROGRAM / REMOTE)

FAULT STATUS

Displays the current device fault status. One of the following message is
displayed.
Recoverable Min Fault:
Unrecoverable Min fault:
Recoverable Maj Fault:
Unrecoverable Maj fault:
No Fault:

58

Recoverable minor fault


Unrecoverable minor fault
Recoverable major fault
Unrecoverable major fault
There are no faults

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

MAC ADDRESS

Shows the MAC address of the primary ControlLogix Ethernet port.

PHY CHASSIS ID

Displays the ID of the primary chassis. Either the Chassis-A or Chassis-B


is displayed.

% QUALIFIED

Shows the status of the synchronization (qualification) process between


the primary and secondary ControlLogix chassis. The details are given
below:
Display Value
-1
1 - 99
100

CHASSIS STATE

Meaning
Synchronization (qualification) is not in progress
The percent of synchronization (qualification)
that is complete.
Synchronization (qualification) is complete

Displays the primary chassis state. One of the following message is


displayed.
Primary With Disq Secondary
Primary With Sync Secondary
Primary with No Secondary
Undetermined

Primary with disqualified secondary


Primary with synchronized
secondary
Primary without any secondary
Current state can not be determined

FBM-Dev Comm
Displays the current communication status (GOOD / FAILED).
Status
Graphics:
The RUN LED on the graphic indicates the device status. (Green RUN, Black PROGRAM).
The battery LED on the graphic indicates the actual battery status of the device. (Red Faulty,
Green Good)
The key position on the graphic matches the actual key position of the device.
For each ECB201 configured, a corresponding button at the bottom of the display is enabled. A
click on the enabled button takes you to its respective device diagnostics (DD_DEV.fdf ) display.
There are two buttons present in the top-right corner.
FS:
DD:

Takes you to the FBM Status display (FS.fdf )


Takes you to Device Diagnostic display (DD_DEV.fdf ) of the current device.

59

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Device Diagnostics
This display shows the number of messages sent and received as well as any response timeouts
with the FDSI FBM232 to device communication.

Figure 7-5. Device Diagnostics Under Simplex Configuration (DD_DEV.fdf)

GOOD MSGS
SENT

Number of good messages sent from FBM to the device

GOOD MSGS
RCVD

Number of good messages received from the device

RESPONSE
TIMEOUTS

Number of timeouts occurred

FBM CLX
COMM STATUS

Displays the current communication status (GOOD / FAILED)


For each ECB201 configured, a corresponding button at the bottom of
the display is enabled. A click on the enabled button takes you to its
respective device diagnostics (DD_DEV.fdf ) display.
There are two buttons present in the topright corner:
FS:
DD:

60

Takes you to the FBM Status display (FS.fdf )


Takes you to Device Diagnostic display (DD_DEV.fdf )
of the current device.

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Redundant FBM Configuration


Under redundant configuration the above information will be shown for both MAIN and
BACKUP FBMs as displayed below.
Only the diagnostic status of the FBM in master role only is updated. For example, if the Main is
master the diagnostic information of the Main is updated while of the backup is not.

Figure 7-6. Device Diagnostics Under Redundant Configuration (DD_DEV.fdf)

Configuration of DCI Blocks for Diagnostic Displays


FBM Status (FS.fdf)
All of the blocks listed in this section are created under the compounds FCM107_DSP and
SLOT0B_DSP as described above.

Simplex Configuration
Display Text
MEM LOAD
CPU USAGE
IP ADDRESS

Block Type
IIN
IIN
STRIN

PNT_NO
$FBM0_MEM_LOAD
$FBM0_CPU_USAGE
$FBM0_IPADDRESS

BLOCK NAME
MEMLOAD
CPUUSAGE
IPADDR

61

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

Redundant Configuration
Display Text

Block Type

MEM LOAD

RIN

CPU USAGE

RIN

IP ADDRESS

STRIN

Block Name
M_MEMLOAD
B_MEMLOAD
M_CPUUSAGE
B_CPUUSAGE
M_IPADDR
B_IPADDR

PNT_NO
$FBMM_MEM_LOAD
$FBMB_MEM_LOAD
$FBMM_CPU_USAGE
$FBMB_CPU_USAGE
$FBMM_IPADDRESS
$FBMB_IPADDRESS

Device Status
Per the examples above, all of the blocks listed in this section are created under the compound
name DEV1_DSP.

Simplex Configuration
Display Text

Block Type

Block Name

PNT_NO

PRODUCT REV
SERIAL NUMBER
DEVICE STATUS
LOGIX STATUS
FAULT STATUS
Graphics: KEY
Graphics: RUN LED
Graphics: Battery LED

RIN
IIN
IIN

PRODUCTREV
SERIALNUMBER
STATUS

PRODUCTREV
SERIALNO
MODE:S2

IIN

MINORFAULT

MINORFAULTBITS

MAC ADDRESS

STRIN

MACADDRESS

MACADDRESS

For the battery status, you must configure the ControlLogix as described in Chapter 4 ControlLogix Configuration.

Redundant Configuration
Display Text

Block Type

Block Name

PNT_NO

PRODUCT REV
SERIAL NUMBER
DEVICE STATUS
LOGIX STATUS
FAULT STATUS
Graphics: KEY
Graphics: RUN LED
Graphics: Battery LED

RIN
IIN
IIN

PRODUCTREV
SERIALNUMBER
STATUS

PRODUCTREV
SERIALNO
MODE:S2

IIN

MINORFAULT

MINORFAULTBITS

MAC ADDRESS

STRIN

MACADDRESS

MACADDRESS

62

7. FoxView Software Diagnostic Process Displays

Display Text
PHY CHASSIS ID
% QUALIFIED
CHASSIS STATE

B0700BU Rev E

Block Type
IIN
IIN
IIN

Block Name
CHASSISID
QUALPROG
CHAS_R_ST

PNT_NO
CHASSIS_ID:S2
QUAL_INPROGRESS:S2
CHASSIS_REDSTATE:S2

For the redundant configuration and battery status you must configure the ControlLogix as
described in Chapter 4 ControlLogix Configuration.

Device Diagnostics
Per the examples above, All of the blocks listed in this section are created under the compound
name DEV1_CTR.

Simplex Configuration
Display Text
GOOD MSGS SENT
GOOD MSGS RCVD
RESPONSE TIMEOUTS

Block Type
IIN
IIN
IIN

BLOCK NAME
MSG_SNT
MSG_RCD
RSP_TO

PNT_NO
$MSGS_SENT
$MSGS_RCVD
$RESP_TIMEOUTS

Redundant Configuration
Display Text

Block Type

GOOD MSGS SENT

IIN

GOOD MSGS RCVD

IIN

RESPONSE TIMEOUTS

IIN

BLOCK NAME
MMSG_SNT
BMSG_SNT
MMSG_RCD
BMSG_RCD
MRSP_TO
BRSP_TO

PNT_NO
$M_MSGS_SENT
$B_MSGS_SENT
$M_MSGS_RCVD
$B_MSGS_RCVD
$M_RESP_TIMEOUTS
$B_RESP_TIMEOUTS

EIP.bat Operational Overview


As stated at the beginning of this chapter, the DCI blocks for the displays are created by the
EIP.bat utility. When EIP.bat runs, it creates compounds based on the ECB200/202 name and the
device ECB201 names. Within these compounds are the blocks required for the displays.
For the sake of example, assume that:
A simplex ECB200 is named FCM107 and has one device named PLC155. The compounds are
named as shown:
FCM107_DSP
PLC155_DSP
PLC155_CTR

63

B0700BU Rev E

7. FoxView Software Diagnostic Process Displays

Also consider a redundant ECB202 is named SLOT0B and there is one device named DEV1.
The compounds are named as shown:
SLOT0B_DSP
DEV1_DSP
DEV1_CTR
In the event of multiple device ECB201s, each compound is named accordingly. For instance if
two devices were created with the names PLC155 and PLC156, the corresponding compound
names are PLC155_DSP; PLC155_CTR and PLC156_DSP; PLC156_CTR.
EIP.bat is located in d:\usr\fox\sp\files\devices\EIP. EIP.bat is an interactive command
window application and must be invoked from a command window. The following is an example
of an interactive session configuring a redundant FBM with one device per the example names
above:
1. Select 1 for Simplex FDSI or 2 for Redundant FDSI:2
2. Enter the LETTERBUG of CP (for example HPSFC1):FCP270
3. Enter the LETTERBUG of FDSI (for example - SLOT03):SLOT0B (if ECB is not present
under STATION_ECB compound then provide COMPOUND:BLOCKNAME, for
example MYCOMP:SLOT0B)
NOTE

Iccdrvr.tsk output appears while the SLOT0B compound and blocks are being
added to the CP database.
4. Enter the number of Child ECB201s for this FDSI:1
5. Enter the Name of the 1 Child ECB (ECB 201):DEV1 (if ECB is not present under
STATION_ECB compound then provide COMPOUND:BLOCKNAME, for example
MYCOMP:DEV1)
6. *Select 3 for Simplex CLX configuration or 4 for Redundant CLX configuration:4
NOTE

Iccdrvr.tsk output appears while the DEV1 compound and blocks are being added
to the CP database.
7. Converting the files
8. Please Wait....Processing - DEV1
9. Please Wait...Doing @ Button 1
10. Process completed
11. Press any key to continue . . .
The lines above are numbered for the purposes of explanation. The text in italics is input command prompts and status messages from EIP.bat. The text in bold is the user input. Lines 5
through 9 including the iccdrvr.tsk output will repeat for each device as is specified in line 4. If
three devices are specified in line 4, EIP.bat will display lines 5 through 9 three times.

64

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

EIP.bat must modify display button linkages on the displays as they are made. This activity is
reflected in line 9. In this example, there is only one device so only one Button output line is
displayed. If three devices were specified, then three Button output lines would be displayed.
After a user response is made at line 6, the diagnostic block compounds are created in the specified CP and the required display files are created from templates and stored in d:\usr\menus with
the display linkages already configured for the blocks. The organization of the displays is shown in
the next section titled Organization of FoxView Diagnostic Display Files on page 66.
NOTE

*Line 6 above prompts the user to indicate if the displays are for a simplex or redundant device. For the redundant configurations shown in Figure 1-3, Figure 1-4, and
Figure 1-5, the value should be 3 for simplex. For the redundant configurations
shown in Figure 1-6 and Figure 1-7 (using the 1757 SRM modules) a value of 4
for redundant should be used.
The EIP script file does not check the validity of the data being entered. The user must enter the
proper device names, letterbugs, and simplex/redundant options for the displays to work properly.
EIP.bat saves the iccdrvr.tsk block configuration files in the form of fbm_name.dat and
device_name.dat. These .dat files are flat text files and may be edited as necessary and re-run
with iccdrvr.tsk from a command window on drive D:. These files are located in
d:\usr\fox\sp\files\devices\EIP\fbm_name\ and
d:\usr\fox\sp\files\devices\EIP\fbm_name\device_name\.
For example, using the above command window session:
d:\usr\fox\sp\files\devices\EIP\SLOT0B\SLOT0B.dat
d:\usr\fox\sp\files\devices\EIP\SLOT0B\DEV1\DEV1_DISP.dat
d:\usr\fox\sp\files\devices\EIP\SLOT0B\DEV1\DEV1_CTR.dat

! CAUTION
Any control configuration sessions that are open with the FDSI host CP must be
closed prior to running the EIP.bat utility.

Adding Devices to Existing Configurations


It may be necessary to add one or more devices to an existing configuration. To add the additional
diagnostic displays, it is not necessary to delete the existing FBM and device diagnostic block
compounds or existing diagnostic displays. However, you must run EIP.bat like it was the very
first time, entering all of the same information except that there are now more devices and lines 5
through 9 above are displayed for each device. However, this time when EIP.bat executes, the
iccdrvr.tsk output will consist of duplicate (but harmless) compound and block error messages
until the compounds for the new devices are loaded into the CP. The existing diagnostic display
files are recreated and stored in the proper directories and the new device displays are stored in the
proper directories.

65

B0700BU Rev E

7. FoxView Software Diagnostic Process Displays

Organization of FoxView Diagnostic Display Files


When the EIP.bat utility is executed, it stores the display files within a directory structure as
shown in the figures below.
The organization is the same for both redundant and simplex configuration.

FS.fdf
Under the D:\opt\menus directory of the AW, EIP.bat creates a directory using the FBM name. In
the example below, two directories have been created because two FBMs are in use: FCM107 and
SLOT0B. The FBM Status files FS.fdf are stored in these directories automatically by EIP.bat.

66

7. FoxView Software Diagnostic Process Displays

B0700BU Rev E

DS_DEV.fdf and DD_DEV.fdf


EIP.bat also creates subdirectories based on the device ECB201 names. In the example below,
PLC155 is the selected device name under the D:\opt\menus\FCM107 directory on the AW.
EIP.bat automatically stored the Device Status and Device Diagnostic display files DS_DEV.fdf
and DD_DEV.fdf files under this directory.
Depending on the number of devices you have, EIP.bat creates that many number of device directories and stores their respective DS_DEV.fdf and DD_DEV.fdf files under those directories. An
example of this is seen below under SLOT0B, where DEV1 and DEV2 have been created.
Though not shown, each of these directories contain their respective DS and DD.fdf files.

Given the examples above, in FoxView software, the display menu picks appear as shown below.
Each EIP FBM is displayed under the Disp menu and each display pick contains the hierarchy as
shown here.

67

B0700BU Rev E

68

7. FoxView Software Diagnostic Process Displays

Appendix A. EtherNet/IP Message


Formats Used with ControlLogix
This appendix describes the various read/write message formats required by ControlLogix.

Multi Request Service for Reading or Writing Multiple


Points
The EtherNet/IP driver uses the following Logix5000 CIP service commands listed in Allen-Bradley Logix5000 Data Access - Reference Manual (Publication 1756-RM005A-EN-E) to interface
with ControlLogix devices.
The following are the application layer message formats.

ControlLogix Read Message Format


The message contents are structured as follows:

The tag information sections are structured as follows:

The Tag Offset and Num Elements parameters are relevant only when specifying items
located within an array.

ControlLogix Write Message Format


The message contents are structured as follows:

The tag information sections are structured as follows:

The Tag Offset and Num Elements parameters are relevant only when specifying items
located within an array.
69

B0700BU Rev E

Appendix A. EtherNet/IP Message Formats Used with

Data Type:
0xC1 Boolean
0xC2 8-bit signed integer
0xC3 16-bit signed integer
0xC4 32-bit signed integer
0xCA Float
0xD3 32-bit collection

ControlLogix Read/Write Result Message Format


The format of the result message data is as follows:

Cmd Status: Overall status for entire command. If non-zero, then a failure occurred on one or
more of the tags read or written.
Tag Location: OFFSET FROM CURRENT POSITION where data is located. These offset locations are in a FIXED position.
Tag Data is structured as follows:

Service Code:
0xCC read Logix tag reply.
0xCD write Logix tag reply.
General Status:
0x04 The tag does not exist.
0x05 The tag could not be found.
0x06 The amount of data requested would not fit into the response buffer. Partial data
transfer has occurred.
0x0A An error has occurred trying to process one of the attributes.
0x13 Not enough command data / parameters were supplied in the command to execute the service requested.
0x1C An insufficient number of attributes were provided compared to the attribute
count.
0x00 Success!!
Extended Status:
0x05, 0x21 You have tried to access beyond the end of the data object.
0x07, 0x21 The abbreviated type does not match the data type of the data object.
0x04, 0x21 The beginning offset was beyond the end of the template.
70

Appendix A. EtherNet/IP Message Formats Used with ControlLogix

B0700BU Rev E

Data Type:
0xC1 Boolean
0xC2 8-bit signed integer
0xC3 16-bit signed integer
0xC4 32-bit signed integer
0xCA Float
0xD3 32-bit collection

71

B0700BU Rev E

72

Appendix A. EtherNet/IP Message Formats Used with

Appendix B. ControlLogix
Configuration
This appendix provides information regarding the configuration of the ControlLogix IP address
and the ControlLogix point tag name and database.

ControlLogix IP Address Configuration


Configuring IP Address for the ENBT module
The ENBT module comes from the factory in the BOOTP mode. To configure the IP address
for the ENBT module you have to use the BOOTP-DHCP Server program which installs along
with the RSLogix 5000 software.
1. To start the BOOTP-DHCP Server, from the windows Start menu, select All
Programs > Rockwell Software > BOOTP-DHCP Server > BOOTP-DHCP Server.

2. In the Network Settings dialog box, enter the Subnet Mask and Gateway details of
your system where the BOOTP application is running.

The Network Settings dialog box starts automatically if the settings were not already entered.
You can also start the dialog box by selecting the Tools > Network Settings menu option.

73

B0700BU Rev E

Appendix B. ControlLogix Configuration

NOTE

The ControlLogix device and the BOOTP station should be in the same network.

Setting the IP Address


The application captures the MAC address of the ControlLogix device and displays it in the
application window.
1. Double-click on the entry corresponding to the MAC address of the ControlLogix.
The New Entry dialog box appears.
2. Set the IP address in the IP Address field and click OK.

Enabling/Disabling BOOTP and DHCP


To get the IP address from the DHCP server, you can select the Enable the DHCP option.
If you do not want the BOOTP or DHCP and just want to assign an IP address for the local network, first click the Disable BOOTP/DHCP option and then assign the required IP address.

74

Appendix B. ControlLogix Configuration

B0700BU Rev E

NOTE

Any change you make takes effect only after rebooting the ENBT module (powering off and then powering back on).

Configuring Two ENBT Modules in the Same Chassis


When you have two ENBT modules in the same chassis, to configure the IP addresses, you should
have two separate setups.

75

B0700BU Rev E

Appendix B. ControlLogix Configuration

Configuring IP Address for the EN2T Module


The EN2T module is shipped from the factory in the BOOTP/DHCP mode with its rotary
switches (switches are physical parts on the module) set to 888. Figure B-1 shows the rotary
switches on EN2T module. The switches are located on top of the module.

Figure B-1. EN2T Module - Top View

The EN2T module IP address can be set using rotary switches. This module comes from the factory with its IP address set to 192.168.1.xxx (where xxx represents the switch settings). Set the
valid number (001 to 254) for the last portion of the IP address using the rotary switches. At
power up, the module reads the rotary switches to determine if they are set to a valid number for
the last portion of the IP address. If the settings are a valid number (for example, the switches are
set to positions 1, 4, 8), the following conditions result:
IP address = 192.168.1.148 (where 148 is from switch settings)
Subnet mask = 255.255.255.0
Gateway address = 0.0.0.0
The module does not have a host name assigned, nor does it use any Domain Name
System.
NOTE

It is recommended to set rotary switches to valid number before installing the


module.

Configuring Two EN2T Modules in the Same Chassis


To configure IP addresses of two EN2T modules in the same chassis, set the rotary switches of the
modules with different valid numbers before powering up the modules.

ControlLogix Point Tag Name and Database


Configuration
To configure the ControlLogix device, you need Allen-Bradley RSLogix 5000 software. The snapshots and other information given below were taken using The RSLogix 5000, Version 13.03.00.
The procedure or the figures shown here may differ if you have any other version of the RSLogix
software.

76

Appendix B. ControlLogix Configuration

B0700BU Rev E

Configuring Drivers
RSLinx software from AB is used for this step. The RSLogix 5000 installs RSLinx in the system.
Start the RSLinx application and follow the steps below
1. Click the Communication > Configure Drivers menu option of the RSLinx Lite
application.

Figure B-2. RSLinx Lite Dialog Box

This opens the Configure Drivers dialog box.


2. Choose Ethernet devices from the Available Driver Types list box and click Add New.

Figure B-3. Configure Drivers Dialog Box

77

B0700BU Rev E

Appendix B. ControlLogix Configuration

3. Accept the default name and click OK.

Figure B-4. Add New RSLinx Driver Dialog Box

78

Appendix B. ControlLogix Configuration

B0700BU Rev E

4. Enter the IP address of the ControlLogix device you want to communicate with in the
Host Name field and click OK.

Figure B-5. Configure Driver [Driver Type] Dialog Box

79

B0700BU Rev E

Appendix B. ControlLogix Configuration

The final configuration should appear as shown in Figure B-6:

Figure B-6. Configure Drivers Dialog Box

Verifying Communication between RSLogix PC and ControlLogix


Open the RSWho window by clicking Communications > RSWho menu option.
In the tree view on the left side of the window, you should see the entry of the
AB_ETH-1, Ethernet. Expand the tree to check all your channels and controller(s).

80

Appendix B. ControlLogix Configuration

B0700BU Rev E

Figure B-7. RSLinx Lite - RSWho

Communicating with the Device from RSLogix PC


1. Start the RSLogix 5000 application, and open the RSWho dialog box by clicking the
Communications > RSWho menu option.
2. Select the processor card and click Upload.
This uploads the existing database from the ControlLogix device to your local system.

81

B0700BU Rev E

Appendix B. ControlLogix Configuration

Figure B-8. Who Active Dialog Box

After few seconds the Connected to Upload dialog box appears.

82

Appendix B. ControlLogix Configuration

B0700BU Rev E

3. Click Select File and store the device configuration database (.acd file) at the desired
location by clicking Select.

Figure B-9. Enter New or Select Existing File Dialog Box

4. If prompted, click Yes to create the project file and upload.

83

B0700BU Rev E

Appendix B. ControlLogix Configuration

Figure B-10. Create Project File and Upload

Depending on the size of the existing database, uploading may take some time.

84

Appendix B. ControlLogix Configuration

B0700BU Rev E

Figure B-11. Uploading Controller Tags

85

B0700BU Rev E

Appendix B. ControlLogix Configuration

5. From the tree view on the left side of the window, double-click the Controller Tags
option available under Controller xxx directory. The existing data points appear in
the right side of the view panel.

Figure B-12. Controller Tags - Data Points

Creating and Downloading a New Database


1. From the New Controller dialog box, click File > New.
2. Select the appropriate controller type, name your database, and select the correct chassis type and slot number.
3. Browse to where you want to save the file and click OK.

86

Appendix B. ControlLogix Configuration

B0700BU Rev E

Figure B-13. New Controller Dialog Box

87

B0700BU Rev E

Appendix B. ControlLogix Configuration

4. To configure the module, right-click on the I/O Configuration directory and click
New Module.

Figure B-14. New Module Selection

5. From the Vendor list box select Allen-Bradley.

88

Appendix B. ControlLogix Configuration

B0700BU Rev E

6. From the module list, select the 1756-ENET/A 1756 Ethernet Communication
Interface module and click OK. This opens the Module Properties dialog box.

Figure B-15. Select Module Type Dialog Box

89

B0700BU Rev E

Appendix B. ControlLogix Configuration

7. Name the module and enter its IP address. Accept the other default values and click
Finish.

Figure B-16. Module Properties Dialog Box

8. To configure the Tag, right-click on the Controller Tags option available under
the Controller xxx directory.

90

Appendix B. ControlLogix Configuration

B0700BU Rev E

9. Click New Tag from the popup menu. The New Tag dialog box opens.

Figure B-17. Creating New Tag

10. Enter the required name, choose the available data type by clicking Configure, leave
the Scope and Style with their default values, and click OK.
To enter new tag(s) you must follow the above steps.

91

B0700BU Rev E

Appendix B. ControlLogix Configuration

Figure B-18. New Tag Dialog Box

11. Click the Communication > Who Active menu option.

92

Appendix B. ControlLogix Configuration

B0700BU Rev E

12. From the WhoActive dialog box, select the proper controller, click Set Project
Path, and then click Download.

Figure B-19. Who Active Dialog Box

13. Click Download in the Download dialog box to complete the download process.

Figure B-20. Download Dialog Box

This also brings the device to the online state as shown below, with RSLogix Communicating with the ControlLogix which is in Program mode.

93

B0700BU Rev E

Appendix B. ControlLogix Configuration

Figure B-21. Controller in Online State

Online Operations
To configure or change the IP address, operate the module in the Program mode.
1. Open the Module Properties dialog box by double-clicking your I/O card ([1]1756enet/a Unit245) option available under the I/O Configuration directory.
2. Click the Port Configuration tab.
3. If the Enable BootP option is checked, uncheck it and set the required configuration.
4. Once you are done, check the Enable BootP option and click OK.
5. Now take the module to the Run mode.

94

Appendix B. ControlLogix Configuration

B0700BU Rev E

Figure B-22. Module in Run Mode

To configure or change the Tag, keep the module in the program mode.
1. From the tree view on the left side of the window, right-click on the Controller
Tags option under the Controller xxx directory.
2. Click the New Tag option from the popup menu. The New Tag dialog box opens.

Figure B-23. Creating New Tag

95

B0700BU Rev E

Appendix B. ControlLogix Configuration

3. Enter the required name, choose the available data type by clicking Configure, leave
the Scope and Style with their default values, and click OK.
To enter a new tag, you must follow the steps above.
Once you are done, take the device to the Run mode.

Figure B-24. Configured New Tag

Configuring a Large Number of Points


To configure a large database, first configure a small number of points in RSLogix 5000 and
export it as a .csv file. Next, open the .csv file in Excel software and make changes in the spreadsheet using the Excel edit functions. Lastly, export the edited .csv file to RSLogix 5000 file and
download to the device.

96

Appendix B. ControlLogix Configuration

B0700BU Rev E

Figure B-25. Selecting to Export

97

B0700BU Rev E

98

Appendix B. ControlLogix Configuration

Appendix C. ControlLogix
Redundancy System
This appendix describes the controlLogix redundancy system which requires no additional
programming.

Overview
The ControlLogix redundancy system uses an identical pair of ControlLogix chassis to keep the
machine or process running if a problem occurs with a controller. When a failure occurs in any of
the components of the primary chassis, control switches to the secondary chassis.
A switchover occurs for any of the following conditions in the Primary chassis:
Loss of power
Major fault of the controller
Removal, insertion, or failure of any module in the primary chassis
Break or disconnection of a ControlNet tap or Ethernet cable
Command from the Primary controller
Command from RSLinx software.
Redundancy requires no additional programming. It uses 1757-SRM modules to maintain communications between the pair of redundant chassis. In a redundant system, the following terms
describe the relationship between the two redundant chassis:
Term
Primary Controller
Primary Chassis
Secondary Controller

Secondary Chassis
Switchover

Description
The controller that is currently controlling the machine or
process.
The chassis that contains the primary controller or controllers.
The controller that is standing by to take control of the machine
or process. A secondary controller always resides in a different but
identical chassis from the primary controller.
The chassis that contains the secondary controller or controllers.
Transfer of control from the primary controller to the secondary
controller. After a switchover, the controller that takes control
becomes the primary controller. Its partner controller (the controller that was previously the primary controller) becomes the
secondary controller.

Ethernet Switchover
If there is a failure that causes a redundancy system to switchover, the EtherNet/IP networks automatically swap IP addresses. You must set both EtherNet/IP modules to the same IP address.

99

B0700BU Rev E

Appendix C. ControlLogix Redundancy System

The details are shown below. Note that though the Ethernet ports of both chassis are configured
to the same IP address when the two are connected as a redundant system, whichever chassis takes
up the role of the Primary system uses the IP address configured, whereas the other chassis taking
the secondary role uses the IP address configured plus one for its Ethernet port. When there is a
switchover, the secondary chassis takes up the primary role and uses the IP address configured.
Both the FBM233 modules communicate with the Primary Chassis Ethernet port. See the figure
below.

EtherNet/IP Network

Configuring Same IP Address to the EN2T Modules


For redundancy at ControlLogix, the EN2T modules are used along with 1756-RM redundancy
modules to maintain communications between the pair of redundant chassis. To configure the
same IP address to both the EN2T modules, proceed as follows:
1. Set the same IP address for both the EN2T modules by using rotary switches - see
Figure B-1 on page 76. (On top of the EN2T module, set the last portion of IP
address same for both the cards.)

100

Appendix C. ControlLogix Redundancy System

B0700BU Rev E

2. Install the EN2T modules along with RM modules in the redundant ControlLogix
chassis. Connect the interlink cable between the RM modules for redundancy. Make
sure the power supply and LAN cables are disconnected.
3. Power on one ControlLogix and connect the LAN cable to EN2T module.
4. When Primary ControlLogix ready, power on the second ControlLogix and wait until
the IP address is assigned as configured plus one (+ 1) for its Ethernet port. Now connect the LAN cable for the second EN2T module.
At the time of switchover, the secondary chassis takes up the primary role and uses the IP address
configured.

101

B0700BU Rev E

102

Appendix C. ControlLogix Redundancy System

Appendix D. Driver Performance


Data
This appendix provides the performance data for a single device under simplex FDSI FBM232
and redundant FDSI FBM233.

Performance Data for a Single Device with Various


Tag Lengths
Table D-1 below shows performance data for a single device with various tag lengths under simplex FDSI FBM232 and redundant FDSI FBM233. For the configurations in the table, the driver
is able to access the points and update the CP within the scan rate and with FDSI CPU usage less
than the maximum recommended.
Table D-1. Performance Data for a Single Device with Various Tag Lengths, Simplex FBM232
and Redundant FBM233

Tag Length
8
8
8
8
8
8
12
12
12
12
12
12
12
14
14
14
14
14
14
30
30

Scan Rate (in Seconds)


0.2
0.5
1
2
3
4
0.2
0.5
1
2
3
4
5
0.2
0.5
1
2
3
4
0.2
0.5

Number of Points
100
250
500
1000
1500
2000
80
200
400
780
1150
1500
2000
70
170
340
680
1020
1360
40
120
103

B0700BU Rev E

Appendix D. Driver Performance Data

Table D-1. Performance Data for a Single Device with Various Tag Lengths, Simplex FBM232
and Redundant FBM233 (Continued)

Tag Length
30
30
30
30
32
32
32
32
32
32
40
40
40
40
40
40

Scan Rate (in Seconds)


1
2
3
4
0.2
0.5
1
2
3
4
0.2
0.5
1
2
3
4

Number of Points
210
410
610
820
50
120
230
430
640
860
32
80
152
328
496
640

Performance Data for Multiple Devices with Various


Tag Lengths
Table D-2 below shows the maximum number of points that can be scanned for the various possible configurations for 2 and 3 devices. For low scan rates, the number of points is limited by the
protocol, whereas for higher scan rates, the performance is limited by FDSI CPU usage.
Table D-2. Performance Data for Multiple Devices with Various Tag Lengths
CPU Usage (%)

Time taken to
Process (Seconds)

Tag
Length

Number of
Devices

Scan Rate
(Seconds)

Number of
Points

Main

Backup

Lowest
Time

Highest
Time

0.2

150

26

21

0.197

0.275

0.5

380

37

23

0.511

0.58

700

57

26

0.888

0.963

1100

56

26

1.376

1.453

1400

57

32

1.755

1.945

1700

55

26

2.222

2.255

0.2

180

26

18

0.195

0.264

0.5

450

42

25

0.483

0.525

690

57

30

0.766

0.735

1050

55

27

1.045

1.104

1380

55

35

1.059

1.137

104

Appendix D. Driver Performance Data

B0700BU Rev E

Table D-2. Performance Data for Multiple Devices with Various Tag Lengths (Continued)
CPU Usage (%)

Time taken to
Process (Seconds)

Tag
Length

Number of
Devices

Scan Rate
(Seconds)

Number of
Points

Main

Backup

Lowest
Time

Highest
Time

1700

55

32

1.315

1.406

14

0.2

100

17

16

0.198

0.213

14

0.5

250

33

22

0.544

0.584

14

450

46

25

1.002

1.098

14

950

48

28

2.123

14

1350

53

26

2.978

3.043

14

1700

57

26

4.099

4.31

14

0.2

120

28

19

0.188

0.208

14

0.5

330

44

29

0.486

0.579

14

510

56

28

0.8

0.881

14

840

56

32

1.43

1.521

14

1170

57

31

1.776

1.953

14

1500

57

31

2.047

2.33

32

0.2

80

41

17

0.177

0.209

32

0.5

200

49

18

0.47

0.51

32

400

52

20

1.04

32

720

55

25

1.8

1.9

32

980

55

33

2.46

2.62

32

1160

55

35

3.04

3.09

32

0.2

90

45

21

0.16

0.21

32

0.5

210

49

26

0.47

0.5

32

420

54

29

1.03

1.12

32

720

54

28

1.7

1.82

32

960

55

32

2.2

2.3

32

1170

55

34

2.7

2.8

40

0.2

64

48

20

0.19

0.2

40

0.5

136

52

30

0.48

0.52

40

288

45

27

0.9

1.05

40

528

55

28

1.97

2.02

40

544

54

29

1.96

2.07

40

560

52

30

1.8

2.07

40

576

55

32

2.2

40

768

55

26

2.7

2.9

40

976

56

34

3.3

3.5

40

0.2

66

47

26

0.17

0.21

40

0.5

168

52

24

0.49

0.517

40

336

54

29

0.993

1.06

40

624

54

32

1.8

40

792

56

33

2.05

2.3

40

1008

55

38

2.6

2.79

105

B0700BU Rev E

106

Appendix D. Driver Performance Data

Appendix E. FDSI Sizing


Spreadsheet Instructions
This appendix provides the instructions for using the FDSI Sizing Spreadsheet.
The FDSI Sizing spreadsheet for the FDSI Ethernet/IP driver can be used to assist in the proper
loading and configuration of the driver. The spreadsheet calculates the load based on the number
of points to be read, the number of points to be written, the scan rate and CP BPC. This will help
ensure that the configured number of points can be fully processed within the configured scan
cycle.

Requirements
The FDSI Sizing spreadsheet for the FDSI Ethernet/IP driver requires Microsoft Excel 2007 or
later.

Overview
The following steps provide an overview of the tasks necessary to use the sizing spreadsheet:
1. Open the file FDSI_Sizing_EIP.xlsm in Microsoft Excel 2007 or later.
2. Enable Macros (page 108).
3. Enter Configuration Data (page 110).
4. View Results (page 111).
The following sections provide the details for each step.

107

B0700BU Rev E

Appendix E. FDSI Sizing Spreadsheet Instructions

Enable Macros
The macros in the spreadsheet must be enabled to calculate the load properly. Proceed as follows:
1. After opening the file, click the Options button next to the security warning as
shown in Figure E-1.

Figure E-1. Excel Security Warning

108

Appendix E. FDSI Sizing Spreadsheet Instructions

B0700BU Rev E

2. The Microsoft Office Security Options dialog box appears as shown in Figure E-1.
Select Enable this content and then click OK.

Figure E-2. Microsoft Office Security Options Dialog Box

The option to enable macros is only provided when the file is initially opened. If macros were not
initially enabled, you can save the file (to preserve your edits) and then re-open the spreadsheet
and follow the instructions for enabling macros.

109

B0700BU Rev E

Appendix E. FDSI Sizing Spreadsheet Instructions

Enter Configuration Data


This section explains the data that required to be added into the spreadsheet.

Figure E-3. Sizing Spreadsheet Overview

On the Summary sheet, fill in the yellow-highlighted configuration parameter cells (as shown
by the area annotated as 1 in Figure E-3). The following information is required:
CP BPC - The basic processing cycle (BPC) of the control processor. This is configured as part of the I/A Series System Definition.
Configured driver scan rate - This is the driver scan rate which is configured as part of
the driver's device options.
Device response time - The device response time is unique to your configuration. The
most accurate value can only be obtained by measuring actual performance using a
sniffer tool.
Writes Percentage - This is the expected percentage of the maximum writes for a given
scan period. If set to 100%, the loading calculations will be based on the maximum
number of writes possible. Lower percentage values may be used based on knowledge
of the control process characteristics and the frequency of outputs.
The remaining configuration data must be entered into the Inputs and Outputs sheets (which
can be accessed by the bottom tabs as shown by the area annotated 2 in Figure E-3).
On the Inputs sheet, enter all the input points. The critical information is the Block type and
the Tag name (in PNT_NO) field. For the tag name, use the same address syntax as recommended for the DCI block PNT_NO parameter. The sizing spreadsheet will use this data to
determine the number of scan groups needed to read all the points.
110

Appendix E. FDSI Sizing Spreadsheet Instructions

B0700BU Rev E

On Outputs sheet, enter all output points. The critical information is the block type, the Tag
name (in PNT_NO field), Period, and Phase. For the tag name, use the same address syntax as
recommended for the DCI block PNT_NO parameter. Use the period and phase numbers as
defined for CP block configuration. The spreadsheet does not check for the validity of the tag
names, the period and the phase values entered.
For Period and Phase, it is acceptable to use the upstream source blocks Period and Phase if it is
slower than the DCI output block. The sizing spreadsheet uses the data to determine the number
of scan groups needed to read all the points as well as the maximum number of output requests
during each scan period.
While determining the number of scan groups, the spreadsheet considers the tags in the order in
which they were entered in the Inputs and Outputs sheets.

View Results
In the Summary sheet, click the Recalculate button in the Loading section (as shown by the
area annotated as 3 in Figure E-3). Click this button anytime the entries in the Inputs or
Outputs sheet have been modified.
The loading results provide the percent time for scans (read requests) and the percent time for
writes. These percentages are relative to the scan rate. The total loading should be kept at, or
below, 85% to allow for minor delays or communication spikes. These loading results are worst
case estimates based on the data provided.
Additionally, the loading results will indicate the suggested minimum number of FDSI modules
needed to accommodate all the points (assuming each FDSI is configured with the same scan
time).
If the loading results indicate that the total loading is greater than 85%, then some corrective
action needs to be taken to reduce the total loading. The following is a list of some suggested
methods for reducing the total loading:
Reduce block count by removing any unnecessary DCI blocks. This is especially effective when reducing the number of DCI output blocks.
Increase device scan time.
Modify output block period and phase. Larger block periods will reduce the frequency
of outputs. Distributing block phases will reduce peaks in the output for a better balanced communication flow.

Increase the number of FDSI modules. Distribute blocks over multiple FDSI
modules.
The References sheet displays the distribution of output points over each scan period. The
phase totals and the scan counts provide feedback as to the affect of changing the DCI output
block period and phase. Reducing the maximum scan count will result in a lower total loading
percentage.

111

Invensys Operations Management


5601 Granite Parkway Suite 1000
Plano, TX 75024
United States of America
http://www.iom.invensys.com

Global Customer Support


Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your
local Invensys representative.
Website: http://support.ips.invensys.com