InTouch Compact Edition ABCIP Configuration Guide

Invensys Systems, Inc.

Revision B Last Revision: 7/8/09

Copyright
2008-2009 Invensys Systems, Inc. All Rights Reserved. All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Invensys Systems, Inc. No copyright or patent liability is assumed with respect to the use of the information contained herein. Although every precaution has been taken in the preparation of this documentation, the publisher and the author assume no responsibility for errors or omissions. Neither is any liability assumed for damages resulting from the use of the information contained herein. The information in this documentation is subject to change without notice and does not represent a commitment on the part of Invensys Systems, Inc. The software described in this documentation is furnished under a license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of these agreements. Invensys Systems, Inc. 26561 Rancho Parkway South Lake Forest, CA 92630 U.S.A. (949) 727-3200 http://www.wonderware.com For comments or suggestions about the product documentation, send an e-mail message to productdocs@wonderware.com.

Trademarks
All terms mentioned in this documentation that are known to be trademarks or service marks have been appropriately capitalized. Invensys Systems, Inc. cannot attest to the accuracy of this information. Use of a term in this documentation should not be regarded as affecting the validity of any trademark or service mark. Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad, DT Analyst, Factelligence, FactoryFocus, FactoryOffice, FactorySuite, FactorySuite A2, InBatch, InControl, IndustrialRAD, IndustrialSQL Server, InTouch, MaintenanceSuite, MuniSuite, QI Analyst, SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager, WindowMaker, WindowViewer, Wonderware, Wonderware Factelligence, and Wonderware Logger are trademarks of Invensys plc, its subsidiaries and affiliates. All other brands may be trademarks of their respective owners.

Contents

Welcome............................................ 5
Documentation Conventions...............................................5 Technical Support ...............................................................6

Chapter 1 About the ABCIP Driver .......................... 7

About the ABCIP driver......................................................7 Device Specifications ...........................................................7 Network Specifications .......................................................8

Chapter 2 Configuring the ABCIP I/O Driver............... 9

Selecting the PLC Driver ..................................................10 Configuring Advanced Settings ........................................11 Configuring Time-out Settings ......................................11 Configuring Protocol Settings........................................12 Associating a PLC Driver with an Access Name .............14

Chapter 3 Troubleshooting the ABCIP Driver ........... 17

ABCIP Error Codes ...........................................................18 Additional Error Codes ..................................................20

InTouch Compact Edition ABCIP Configuration Guide

Contents

Appendix A ABCIP Item References .........................21

Supported PLC5 Item Names...........................................22 Supported SLC500 Item Names.......................................23 Supported ControlLogix Item Names ..............................24 Supported MicroLogix Item Names .................................26

Index ...............................................27

InTouch Compact Edition ABCIP Configuration Guide

Welcome

This guide explains how to configure the ABCIP I/O driver for InTouch Compact Edition. This guide assumes you know how to use Microsoft Windows, including navigating menus, moving between applications and moving objects on the screen. If you need help with these tasks, see the Microsoft online help. You can view this document online or you can print it, in part or entirely, by using the print feature in Adobe Acrobat Reader.

Documentation Conventions
This documentation uses the following conventions:
Convention Used for

Initial Capitals Bold

Monospace

Paths and file names. Menus, commands, dialog box names, and dialog box options. Code samples and display text.

InTouch Compact Edition ABCIP Configuration Guide

Welcome

Technical Support
Wonderware Technical Support offers a variety of support options to answer any questions on Wonderware products and their implementation. Before you contact Technical Support, refer to the relevant section(s) in this documentation for a possible solution to the problem. If you need to contact Technical Support for help, have the following information ready:

The type and version of the operating system you are using. Details of how to recreate the problem. The exact wording of the error messages you saw. Any relevant output listing from the Log Viewer or any other diagnostic applications.

Note If you are using the ITC Log Viewer, ensure that the I/O Read Blocks, I/O Write Blocks, and Protocol Analyzer are enabled.

Details of what you did to try to solve the problem(s) and your results. If known, the Wonderware Technical Support case number assigned to your problem, if this is an ongoing problem.

InTouch Compact Edition ABCIP Configuration Guide

Chapter 1
About the ABCIP Driver

This section explains the concepts of the ABCIP driver and identifies all hardware and software components required to implement communication between InTouch Compact Edition and compatible PLCs.

About the ABCIP driver

The ABCIP driver enables communication between InTouch Compact Edition and compatible target devices that include Allen-Bradley ControlLogix, FlexLogix, CompactLogix, and MicroLogix PLCs. The ABCIP driver communicates with PLCs using the Allen-Bradley Common Industrial Protocol (CIP).

Device Specifications
To establish communication with the ABCIP driver, your target PLC must meet the following specifications: Manufacturer: Allen Bradley/Rockwell Compatible equipment: ControlLogix 5000 Family with 1756-ENET or 1756-ENBT module installed

InTouch Compact Edition ABCIP Configuration Guide

Chapter 1 About the ABCIP Driver

Network Specifications
To establish communication with the ABCIP driver, your device network must meet the following specifications:

Device communication port:

For ControlLogix 5000 Family, Ethernet port on the 1756-ENET module For MicroLogix 1100, Ethernet Channel (Channel 1)

Physical protocol: Ethernet Logic protocol: CIP over Ethernet TCP/IP Device run-time software: None Specific PC board: Ethernet port Cable wiring scheme: Regular Ethernet cable

InTouch Compact Edition ABCIP Configuration Guide

Chapter 2
Configuring the ABCIP I/O Driver

This section explains how to configure the ABCIP driver by completing the following tasks:

Select the PLC driver Configure other PLC-specific settings Configure advanced settings Associate an InTouch Access Name with the configured driver

You configure the ABCIP driver from the Driver Configuration dialog box. In a managed InTouch Compact Edition application, you access this dialog box from the WindowMaker Special, InTouch Compact Edition application, IO Driver Configuration menu. For more information about configuring connection settings, see the documentation of your PLC hardware manufacturer.
Note For each driver, you can configure only one set of driver parameters.

InTouch Compact Edition ABCIP Configuration Guide

10

Chapter 2 Configuring the ABCIP I/O Driver

Selecting the PLC Driver

Before you configure the ABCIP driver, you need to select it in the Driver Configuration dialog box. You can select more than one PLC driver to configure. All selected PLC drivers can be associated with InTouch Access Names.
To select the PLC driver 1

In WindowMaker on the Special menu, point to InTouch Compact Edition application, and then click IO Driver Configuration. The Driver Configuration dialog box appears.

PLC Driver Selection

Connection Settings

Driver-specific Settings

Advanced Settings InTouch Access Names

Driver Name and Station Address

From the list in the left pane, select the check box next to the ABCIP driver. The selected PLC driver appears in the Mapping I/O Driver list in the Mapping Details area of the Driver Configuration dialog box. You can associate it with an InTouch Access Name. For more information refer to Associating a PLC Driver with an Access Name on page 14

You can now configure connection settings, advanced settings, and other PLC-specific settings on the right pane of the dialog box.

InTouch Compact Edition ABCIP Configuration Guide

Configuring Advanced Settings

11

Configuring Advanced Settings

This section explains how to configure the following advanced settings for an ABCIP driver:

Time-out settings Protocol settings Buffer Length settings

Depending on the PLC driver you select, one or more of these settings might be disabled.
Note For more information about configuring advanced settings, see the documentation of your PLC hardware manufacturer.

Configuring Time-out Settings

You can configure the following time-out settings:

Start Message End Message

To configure time-out settings 1 2

In the Driver Specific Configuration dialog box, select the driver you want to configure. Click Advanced. The Advanced Settings dialog box appears.

In the Timeout area, assign values to the following settings: Start Message - Time-out period in milliseconds for the message to start. End Message - Time-out period in milliseconds for the message to end. Click OK.

InTouch Compact Edition ABCIP Configuration Guide

12

Chapter 2 Configuring the ABCIP I/O Driver

Configuring Protocol Settings

You can configure the number of attempts to retry a communication command after a previous failure. This setting specifies how many times the driver attempts to execute the same communication command before reporting a communication error.
To configure Protocol retry setting 1 2

In the Driver Specific Configuration dialog box, select the driver you want to configure. Click Advanced. The Advanced Settings dialog box appears.

3 4

In the Protocol area, enter the number of retry attempts in the Retries box. Click OK.

InTouch Compact Edition ABCIP Configuration Guide

Configuring Advanced Settings

13

Configuring Buffer Length Settings

You can configure the following Buffer Length settings:

Transmission Buffer (Tx) Length Reception Buffer (Rx) Length

The Buffer Length settings determine the number of bytes allocated from memory as a temporary buffer. The driver stores data in the temporary buffer while communicating with the PLC.
To configure Buffer Length settings 1 2

In the Driver Specific Configuration dialog box, select the driver you want to configure. Click Advanced. The Advanced Settings dialog box appears.

In the Buffer Length (Bytes) area, assign values to the following settings: Tx Buffer - Transmission buffer size in bytes.
Rx Buffer - Reception buffer size in bytes.

Click OK.

InTouch Compact Edition ABCIP Configuration Guide

14

Chapter 2 Configuring the ABCIP I/O Driver

Associating a PLC Driver with an Access Name

After configuring the ABCIP driver, you need to associate it with an existing InTouch Access Name. For more information about creating an InTouch Access Name, see the InTouch HMI Data Management Guide. When you associate a PLC driver with an Access Name, you need to specify a Station Address. The Station Address is used by the ABCIP driver to specify slave network addresses of PLCs. The Station Address must comply with the following syntax based on the type of network:
Ethernet Network

Specify the Station Address using the following syntax:

For ControlLogix <IP Address>:<Slot Number> Where:

<Family>: If you do not specify this parameter, the default family is a ControlLogix 5000 device. Otherwise, you can specify 1100 for a MicroLogix 1100 device. <IP Address>: The IP address assigned to the ABCIP PLC on the network. <Slot Number> A sequential number beginning with 0 assigned to each slot in a ControlLogix chassis.

For example - 10.168.23.77:1 or 1100:192.168.1.53:1 For others <Family>:<IP Address>:<Slot Number>

InTouch Compact Edition ABCIP Configuration Guide

Associating a PLC Driver with an Access Name

15

Data Highway Plus Network

Specify the station address using the following syntax: <Family>:<IP_Address>:<Backplane>:<Slot>: <Channel>:<Remote Node> Where:

<Family>: The model family of the ABCIP PLC. Use one of the following: 1 or 5000 - ControlLogix 5000 2 or 500 - SLC500 4 or 1100 Micrologix 1100 3 or 5 - PLC5 <IP Address>: The IP address of the of the ControlLogix PLC (or more specifically, its 1756-ENET module) that acts as a device. <Backplane>: Always 1. <Slot>: The slot number of the ControlLogix PLC where the 1756-DHRIO module is installed. <Channel>: The DH+ channel (A or B) to which the remote node is connected. <Remote Node>: DH+ address of the remote node (in decimal).

Note For more information about configuring the station address, see the documentation of your PLC hardware manufacturer.

InTouch Compact Edition ABCIP Configuration Guide

16

Chapter 2 Configuring the ABCIP I/O Driver

To associate a PLC driver with an Access Name 1

Open the Driver Configuration dialog box. Access Name you want to associate with the PLC driver.

2 In the Access Name Mapping area, locate the InTouch

Note If no Access Names appear in the list, you need to define an Access Name from the InTouch HMI. 3 4 5

Select the Access Name. In the Mapping I/O Driver list, select the configured driver. In the Station Address box, type the station address. When you move the mouse pointer over the Station Address box, a tooltip shows the required syntax for a station address.

Click OK.

InTouch Compact Edition ABCIP Configuration Guide

17

Chapter 3
Troubleshooting the ABCIP Driver

You can detect communication errors between an InTouch Compact Edition application and the PLC by using the following item names:
Item name Purpose

$Sys$ReadStatus $Sys$WriteStatus $Sys$ReadCompleted

$Sys$WriteCompleted

Receives the error code for a failed read operation from the PLC. Receives the error code for a failed write operation to the PLC. Indicates if the read operation from the PLC completes (TRUE) or not (FALSE). Indicates if the write operation to the PLC completes (TRUE) or not (FALSE).

Note You can associate only one InTouch tag with each item name. To troubleshoot communication problems 1

In WindowMaker, configure a set of I/O tags to associate with the error item names: An I/O discrete tag to point at the item name $Sys$ReadCompleted.

An I/O discrete tag to point at the item name $Sys$WriteCompleted. An I/O integer tag to point at the item name $Sys$ReadStatus.

InTouch Compact Edition ABCIP Configuration Guide

18

Chapter 3 Troubleshooting the ABCIP Driver

An I/O integer tag to point at the item name $Sys$WriteStatus.

Configure animation display links for the I/O tags, such as: Fill color animations for the I/O tags associated with the $Sys$ReadCompleted and $Sys$WriteCompleted items.

Analog value display links for the I/O tags associated with the $Sys$ReadStatus and $Sys$WriteStatus items.

At run time, if a read or write error occurs between the InTouch Compact Edition and the PLC, the fill color animation indicates a problem. The value next to the fill color animation shows the error code.

ABCIP Error Codes

The ABCIP error codes are shown in the following table. The table also includes typical problems associated with an error code and possible solutions.
Error Code Description Possible Causes Procedure to Solve

-60 -15

0 11

25

Configure the STATION with the correct PLC IP address. A timeout The CPU or network card Configure the STATION field occurred while was found through its IP in the Driver Communication waiting to start a address. The connection parameters with the correct message. was made, but the PLC Ethernet IP address/Slot did not respond due to an Number. incorrect SLOT number. OK Correct configuration and None. communication. Invalid read The Item I/O address Using ITCWin, enable the command does not exist on the PLC. Protocol Analyzer and check whether the tag name that is displayed is valid. Invalid backplane No parameter is Configure the STATION configured after the IP ADDRESS field according to the following syntax: address when routing through the backplane to <Family>:<IP>:<Slot>:<back a PLC5 or 500. plane>:<Channel>:<Remote Node Address>.

Connection error Wrong PLC IP address

InTouch Compact Edition ABCIP Configuration Guide

ABCIP Error Codes

19

Error Code Description

Possible Causes

Procedure to Solve

26

Invalid slot

No parameter is configured after the IP address when routing through the backplane to a PLC5 or 500.

27

Invalid channel

Configure the STATION ADDRESS field according to the following syntax: <Family>:<IP>:<Slot>:<back plane>:<Channel>:<Remote Node Address>. No parameter is Configure the STATION configured after the IP ADDRESS field according to address when routing the following syntax: through the backplane to <Family>:<IP>:<Slot>:<back a PLC5 or 500. plane>:<Channel>:<Remote Node Address>. The DH+ address is not configured after the IP address when routing through the backplane to Slot:Channel.

28

Invalid remote node address

32 38

Invalid comand Invalid Sub_Element Invalid writing Sub_Element Invalid BCD

39

40

43

Invalid octet

45

Comunication error

1004

A timeout occurred while waiting to start a message.

Configure the STATION ADDRESS field according to the following syntax: <Family>:<IP>:<Slot>:<back plane>:<Channel>:<Remote Node Address>. When you read/write an Configure the correct item I/O invalid PLC I/O address. address. I/O address field is not Configure the correct item I/O supported by the PLC file address according to the file address. and field rules. I/O address field not Configure the item I/O supported by the PLC address according to the file File address. and field rules. On ML1100, load the Configure the value in BCD decimal value 10 on the format in case you want to N7:0. Try to read the communicate the PLC using decimal value using the BCD format. BCD format. The input and output Configure the item I/O addresses for PLC5 must address according to the octal be in octal format. syntax for PLC5 I/O. When the status of the None. communication is different from 0, for families ControlLogix, PLC5, SLC. Incorrect PLC IP address. Configure the STATION with the correct PLC IP address.

InTouch Compact Edition ABCIP Configuration Guide

20

Chapter 3 Troubleshooting the ABCIP Driver

Additional Error Codes

The ABCIP additional error codes are shown in the following table.
Error Code Description

3 7 8 9 10 22 23 24 30 31 33 35 36 41 44

Invalid comand Invalid block size Invalid write Error answer block size Failed to allocate memory Invalid type Error in send _RR_data function Invalid IP Unsupported or invalid item Unsupported or invalid item Blank station Error Micrologix request Error getting local host Invalid format Invalid message ID

InTouch Compact Edition ABCIP Configuration Guide

21

Appendix A
ABCIP Item References

This section lists the item names supported by the ABCIP driver. This driver only supports item names from the PLC5, SLC500, ControlLoxic, and MicroLogix families of Allen-Bradley PLCs. If an OUT OF RANGE item is used in an InTouch Compact Edition application, then the quality for that item is shown as 0 or BAD. It is also possible that the quality of one or more valid items goes to 0 or BAD due to an OUT OF RANGE item being used. Invalid item values (with/without suffixes) can return unpredictable results. You should ensure that valid values are written for each data type. For example, 0 to 65535 is the valid value range for 'word' type of data. The ABCIP driver supports float values with 4 bytes with up to 7 digits. Therefore, the valid range for float values is 3.4E +/- 38 (7 digits). Values outside this range result in an invalid value written to the tag. Furthermore, values with more than 7 digits of precision are rounded at the seventh digit. The ABCIP driver can poke any output items when it is communicating with PLC5, SLC500, and MicroLogix1000 PLCs. The timer, counter, and control file types are read-only when specified without a dotfield value. For example, T4:1, C5:2, and R6:3.

InTouch Compact Edition ABCIP Configuration Guide

22

Appendix A ABCIP Item References

Supported PLC5 Item Names

Default File# Supported by InTouch Compact Edition

File Type

.Fields

O I S B T C R N F A D ST PD

Output Input Status Binary Timer Counter Control Integer Floating point ASCII BCD ASCII string PID

0 1 2 3 4 5 6 7 8 None None None None .LEN .ADRF .ADRE .BIAS .CA .CL .CT .DB .DO .DVDB .DVN .DVNA .DVP .DVPA .EN .ERR .EWD .INI .KD .KI .KP .MAXI .MAXO .MAXS .MINI .MINO .MINS .MO .OLH .OLL .OUT .PE .PV .PVDB .PVH .PVHA .PVL .PVLA .PVT .SO .SP .SPOR .SWM .TIE .UDP .DN .ER .FS .LS .OV .PRE .SA .TIM .EN .ST .DN .ER .CO .EW .NR .RW .TO .RLEN .DLEN .FILE .ELEM .PRE .ACC .EN .TT .DN .PRE .ACC .CU .CD .DN .OV .UN .LEN .POS .EN .EU .DN .EM .ER .UL .IN .FD

Yes Yes (Read-only) Yes Yes Yes Yes Yes Yes Yes No No No No

SC BT

SFC status Block transfer (Read-only)

None None

No No

Note The output and input file types work only when the format is <FileType>:<Slot Number>.<Octet Number>/[Bit]

InTouch Compact Edition ABCIP Configuration Guide

Supported SLC500 Item Names

23

Supported SLC500 Item Names

Default File# Supported by InTouch Compact Edition

File Type

.Fields

O I S B T C R N F A ST

Output Input Status Binary Timer Counter Control Integer Floating point ASCII ASCII string*

0 1 2 3 4 5 6 7 8 None None .PRE .ACC .EN .TT .DN .PRE .ACC .CU .CD .DN .OV .UN .UA .LEN .POS .EN .DN .ER .UL .IN .FD

Yes Yes (Read-only) Yes Yes Yes Yes Yes Yes Yes No No

Note The output and input file types work only when the format is <FileType>:<Slot Number>.<Octet Number>/[Bit].

InTouch Compact Edition ABCIP Configuration Guide

24

Appendix A ABCIP Item References

Supported ControlLogix Item Names

The ABCIP driver does not support DBCS, only ANSI characters for ControlLogix. The syntax of the item to communicate with ControlLogix on the Panel must include <DataType>, where <DataType> can be BOOL, SINT, INT, DINT, REAL and STRING. If an item is not prefixed by data type, then it will show quality as Bad.
Supported by InTouch Compact Edition

Reference

Syntax

Program tag Module tag Entire tag Member of structure tag Array element Two-dimensi onal array element Three-dimen sional array element Block reads/ writes of one-dimensio nal arrays (supported types: BOOLS, SINTS, INTS, DINTS, REALS)

<DataType>:Program:<Program_Name>.<Tag_Name> <Location>:<slot_#>:<Data_ Type><Member_Name>.<SubMember_Name>.[<bit_#>] <DataType>:<Tag_Name> <DataType>:<Tag_Name>.<Member_Name> <DataType>:<Tag_Name>[<element_X>] <DataType>:<Tag_Name>[<element_X>,<element_Y>]

Yes No Yes Yes Yes Yes

<DataType>:<Tag_Name>[<element_X>,<element_Y>, <element_Z>] <Tag_Name>[<element_X>],L<number_of_items_#>

Yes

No

InTouch Compact Edition ABCIP Configuration Guide

Supported ControlLogix Item Names

25

Reference

Syntax

Supported by InTouch Compact Edition

String tag

<DataType>:<String_Tag_Name>[.DATA[[<element_#> ] ]][,SC<string_length_#>] <DataType>:<String_Tag_Name>[.DATA[[<element_#> ] ]][,SP<string_length_#>] <DataType>:<String_Tag_Name>[.DATA[[<element_#> ] ]][,SS<string_length_#>]

Yes

String tag array

<DataType>:<String_Tag_Name>[<element_X>][.DATA [[<element_#>]]][,SC<string_length_#>] <DataType>:<String_Tag_Name>[<element_X>][.DATA [[<element_#>]]][,SP<string_length_#>] <DataType>:<String_Tag_Name>[<element_X>][.DATA [[<element_#>]]][,SS<string_length_#>]

Yes

Bit within integer

<DataType>:<Tag_Name or Member_Name>.<bit_#>

Yes

InTouch Compact Edition ABCIP Configuration Guide

26

Appendix A ABCIP Item References

Supported MicroLogix Item Names

Default File # Supported by InTouch Compact Edition

Identifier

File Type

.Fields

O I S B T C R N F A D L ST PD

Output Input Status Binary Timer Counter Control Integer Floating point ASCII BCD Long ASCII string PID

0 1 2 3 4 5 6 7 8 None None None None None

N/A N/A N/A N/A .PRE .ACC .EN .TT .DN .PRE .ACC .CU .CD .DN .OV .UN .LEN .POS .EN .EU .DN .EM .ER .UL .IN .FD N/A N/A N/A

Yes Yes (Read-only) Yes Yes Yes Yes Yes Yes Yes No No

N/A .LEN .TM .AM .CM .OL .RG .SC .TF .DA .DB .UL .LL .SP .PV .DN .EN .SPS .KC .TI .TD .MAXS .MINS .ZCD .CVH .CVL .LUT .SPV .CVP .IA .RBL .LBN .RBN .CHN .NOD .MTO .NB .TFT .TFN .ELE .SEL .TO .CO .EN .RN .EW .DN .ER .ST .DN .ER .FS .LS .OV .PRE .SA .TIM .EN .ST .DN .ER .CO .EW .NR .RW .TO .RLEN .DLEN .FILE .ELEM

No No No

MG

Message

None

No

SC BT

SFC status Block transfer ( Read-only)

None None

No No

InTouch Compact Edition ABCIP Configuration Guide

27

Index

A
ABCIP driver CompactLogix 7 ControlLogix 7, 8 Device Specifications 7 FlexLogix 7 MicroLogix 7, 8 network specifications 8 Access Name 14

P
PLC driver associating a PLC driver 14 selecting the PLC driver 10 Protocol settings 11

T
Technical Support 6 Time-out settings 11 troubleshooting communication problems 17 configure animation display 18

B
Buffer Length settings 11

D
documentation conventions 5

I
Item References ControlLogix 24 MicroLogix 26 PLC5 22 SLC500 23

InTouch Compact Edition ABCIP Configuration Guide

28

Index

InTouch Compact Edition ABCIP Configuration Guide