ProSoft Technology PLX3x Series User Manual

Download

PLX3x Series

Multi-Protocol Gateways

January 25, 2018

USER MANUAL

Your Feedback Please

We always want you to feel that you made the right decision to use our products. If you have suggestions, comments, compliments or complaints about our products, documentation, or support, please write or call us.

How to Contact Us

ProSoft Technology, Inc.

+1 (661) 716-5100 +1 (661) 716-5101 (Fax) www.prosoft-technology.com support@prosoft-technology.com

PLX3x Series User Manual Rev 1.0.0

January 25, 2018

ProSoft Technology®, is a registered copyright of ProSoft Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products and services of, their respective owners.

In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments. User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided at our website: http://www.prosoft-technology.com

Content Disclaimer

This documentation is not intended as a substitute for and is not to be used for determining suitability or reliability of these products for specific user applications. It is the duty of any such user or integrator to perform the appropriate and complete risk analysis, evaluation and testing of the products with respect to the relevant specific application or use thereof. Neither ProSoft Technology nor any of its affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein. Information in this document including illustrations, specifications and dimensions may contain technical inaccuracies or typographical errors. ProSoft Technology makes no warranty or representation as to its accuracy and assumes no liability for and reserves the right to correct such inaccuracies or errors at any time without notice. If you have any suggestions for improvements or amendments or have found errors in this publication, please notify us.

No part of this document may be reproduced in any form or by any means, electronic or mechanical, including photocopying, without express written permission of ProSoft Technology. All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer should perform repairs to components. When devices are used for applications with technical safety requirements, the relevant instructions must be followed. Failure to use ProSoft Technology software or approved software with our hardware products may result in injury, harm, or improper operating results. Failure to observe this information can result in injury or equipment damage.

Printed documentation is available for purchase. Contact ProSoft Technology for pricing and availability. North America: +1 (661) 716-5100

Asia Pacific: +603.7724.2080 Europe, Middle East, Africa: +33 (0) 5.3436.87.20 Latin America: +1.281.298.9109

ATEX Zone 2

CB Safety

CE Mark

RoHS

UL/cUL Class 1 Div 2

Important Installation Instructions

Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b) of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following warnings must be heeded:

WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR CLASS I, DIV. 2;

WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE REPLACING OR WIRING MODULES

WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.

THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.

Agency Approvals and Certifications

PLX3x Series ♦ Multi-Protocol Gateways Contents User Manual

Contents

Your Feedback Please ........................................................................................................................ 2

How to Contact Us .............................................................................................................................. 2

Content Disclaimer .............................................................................................................................. 2

Important Installation Instructions ....................................................................................................... 3

Agency Approvals and Certifications .................................................................................................. 3

1 Start Here 9

1.1 Overview.................................................................................................................... 9

1.2 System Requirements ............................................................................................. 10

1.3 Package Contents ................................................................................................... 10

1.4 Mounting the Gateway on a DIN-rail ....................................................................... 11

1.5 Jumper Settings ...................................................................................................... 12

1.6 SD Card ................................................................................................................... 13

1.7 Connecting Power to the Unit ................................................................................. 13

1.8 Installing ProSoft Configuration Builder Software ................................................... 14

2 Using ProSoft Configuration Builder 15

2.1 Connecting the PC to the Gateway ......................................................................... 15

2.2 Setting a Temporary IP Address in the Gateway .................................................... 15

2.3 Setting Up the Project ............................................................................................. 19

2.4 Disabling Gateway Ports ......................................................................................... 20

2.5 Configuring Gateway Parameters ........................................................................... 23

2.5.1 Renaming PCB Objects .......................................................................................... 23

2.5.2 Printing a Configuration File .................................................................................... 23

2.6 Configuring the Ethernet Port .................................................................................. 23

2.7 Mapping Data in Module Memory ........................................................................... 24

2.7.1 From Address .......................................................................................................... 26

2.7.2 To Address .............................................................................................................. 26

2.7.3 Register Count ........................................................................................................ 26

2.7.4 Swap Code .............................................................................................................. 26

2.7.5 Delay Preset ............................................................................................................ 26

2.8 Downloading the Project to the Gateway ................................................................ 27

2.9 Uploading the Project from the Gateway ................................................................ 29

3 Diagnostics and Troubleshooting 31

3.1 LED Indicators ......................................................................................................... 31

3.1.1 Main Gateway LEDs ................................................................................................ 32

3.1.2 Ethernet Port LEDs ................................................................................................. 33

3.1.3 Serial Port LEDs (for Gateways with Serial Ports) .................................................. 33

3.2 Using Diagnostics in ProSoft Configuration Builder ................................................ 33

3.2.1 Diagnostics Menu .................................................................................................... 36

3.2.2 Capturing a Diagnostic Session to a Log File ......................................................... 37

3.2.3 Using the Data Analyzer (Serial Protocols Only) .................................................... 38

3.2.4 Warm Boot / Cold Boot ............................................................................................ 39

3.3 Gateway Status Data in Upper Memory .................................................................. 40

3.3.1 General Gateway Status Data in Upper Memory .................................................... 40

ProSoft Technology, Inc. Page 5 of 215 January 25, 2018

Contents PLX3x Series ♦ Multi-Protocol Gateways User Manual

3.3.2 Protocol-Specific Status Data in Upper Memory .................................................... 41

4 Hardware Information 43

4.1 Hardware Specifications ......................................................................................... 43

4.1.1 Serial Port Specifications ........................................................................................ 44

4.2 Serial Port Cables (for Gateways with Serial Ports) ............................................... 44

4.2.1 Serial Port Specifications ........................................................................................ 45

4.2.2 RS-232 - Null Modem (DTE without Hardware Handshaking) ............................... 45

4.2.3 RS-232 - DTE to DCE Modem Connection ............................................................ 46

4.2.4 RS-422 Interface Connections ................................................................................ 46

4.2.5 RS-485 Interface Connection ................................................................................. 47

5 EIP Protocol 49

5.1 EIP Functional Overview ........................................................................................ 49

5.1.1 EtherNet/IP General Specifications ........................................................................ 50

5.1.2 EIP Internal Database ............................................................................................. 51

5.2 EIP Configuration .................................................................................................... 53

5.2.1 Configuring EIP Class 3 Server .............................................................................. 53

5.2.2 Configuring EIP Class 1 Connection ...................................................................... 56

5.2.3 Configuring EIP Class 3 Client[x]/UClient Connection ........................................... 60

5.3 Network Diagnostics ............................................................................................... 70

5.3.1 EIP PCB Diagnostics .............................................................................................. 70

5.3.2 EIP Status Data in Upper Memory.......................................................................... 71

5.3.3 EIP Error Codes ...................................................................................................... 73

5.4 EIP Reference......................................................................................................... 76

5.4.1 SLC and MicroLogix Specifics ................................................................................ 76

5.4.2 PLC5 Processor Specifics ...................................................................................... 80

5.4.3 ControlLogix and CompactLogix Processor Specifics ............................................ 84

5.4.4 EIP Command Entry Form ...................................................................................... 93

6 MBTCP Protocol 95

6.1 MBTCP Functional Overview .................................................................................. 95

6.1.1 MBTCP General Specifications .............................................................................. 96

6.1.2 MBTCP Internal Database ...................................................................................... 97

6.2 MBTCP Configuration ........................................................................................... 101

6.2.1 Configuring MBTCP Servers ................................................................................ 101

6.2.2 Configuring MBTCP Client [x] ............................................................................... 103

6.2.3 Configuring MBTCP Client [x] Commands ........................................................... 105

6.3 Network Diagnostics ............................................................................................. 108

6.3.1 MBTCP PCB Diagnostics ..................................................................................... 108

6.3.2 MBTCP Status Data in Upper Memory ................................................................. 108

6.3.3 MBTCP Error Codes ............................................................................................. 111

6.4 MBTCP Reference ................................................................................................ 112

6.4.1 About the Modbus Protocol .................................................................................. 112

7 MBS Protocol 115

7.1 MBS Functional Overview .................................................................................... 115

7.1.1 Modbus Serial Specifications ................................................................................ 116

Page 6 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Contents User Manual

7.1.2 Modbus Master/Slave Port Specifications ............................................................. 116

7.1.3 MBS Internal Database ......................................................................................... 117

7.2 MBS Configuration ................................................................................................ 119

7.2.1 Configuring MBS Port [x] ....................................................................................... 119

7.2.2 MBS Port [x] Commands ....................................................................................... 124

7.3 MBS Diagnostics ................................................................................................... 127

7.3.1 MBS PCB Diagnostics ........................................................................................... 127

7.3.2 MBS Status Data in Upper Memory ...................................................................... 127

7.3.3 MBS Error Codes .................................................................................................. 133

7.4 MBS Reference ..................................................................................................... 134

8 ASCII Protocol 135

8.1 ASCII Functional Overview ................................................................................... 135

8.1.1 General Specifications .......................................................................................... 136

8.1.2 ASCII Data Flow .................................................................................................... 136

8.1.3 ASCII Internal Database........................................................................................ 139

8.1.4 ASCII Modes of Operation .................................................................................... 140

8.2 ASCII Configuration ............................................................................................... 142

8.2.1 ASCII Port [x] ......................................................................................................... 142

8.2.2 Configuring the Port for Receive-Only Mode ........................................................ 145

8.2.3 Configuring a Port for Transmit-Only Mode .......................................................... 145

8.2.4 Configuring a Port for Transmit-Receive Mode ..................................................... 145

8.2.5 Termination of Received Data ............................................................................... 145

8.3 ASCII Diagnostics ................................................................................................. 147

8.3.1 ASCII PCB Diagnostics ......................................................................................... 147

8.3.2 ASCII Status Data in Upper Memory .................................................................... 148

9 SIE Protocol 153

9.1 SIE Functional Overview ....................................................................................... 153

9.1.1 SIE General Specifications.................................................................................... 154

9.1.2 SIE Gateway Internal Database ............................................................................ 154

9.2 SIE Configuration .................................................................................................. 157

9.2.1 Configuring SIE Client [x] Connection ................................................................... 157

9.2.2 Configuring SIE Client x Commands ..................................................................... 158

9.3 SIE Diagnostics ..................................................................................................... 170

9.3.1 SIE PCB Diagnostics ............................................................................................. 170

9.3.2 SIE Status Data in Upper Memory ........................................................................ 171

9.3.3 SIE Error Codes .................................................................................................... 172

9.4 SIE Reference ....................................................................................................... 174

9.4.1 SIE CPU315-2 DP ................................................................................................. 174

9.4.2 SIE CPU1212C ..................................................................................................... 176

9.4.3 SIE CPU224XP ..................................................................................................... 178

10 PND Protocol 181

10.1 PND Functional Overview ..................................................................................... 181

10.1.1 PND General Specifications .................................................................................. 181

10.1.2 PND Internal Database ......................................................................................... 182

10.2 PND Configuration ................................................................................................ 183

10.2.1 Configuring PIE Connection .................................................................................. 186

10.2.2 Configuring PND Module Map .............................................................................. 187

ProSoft Technology, Inc. Page 7 of 215 January 25, 2018

Contents PLX3x Series ♦ Multi-Protocol Gateways User Manual

10.3 Step 7 Configuration ............................................................................................. 188

10.3.1 Creating a Variable Table to Display Floating Point Input Values ........................ 190

10.3.2 Creating a Variable Table to Display Floating Point Input Values ........................ 192

10.3.3 Creating a Variable Table to Display Floating Point Input Values ........................ 201

10.3.4 Creating a Variable Table to Display Floating Point Input Values ........................ 203

10.4 PND Diagnostics ................................................................................................... 205

10.4.1 PND PCB Diagnostics .......................................................................................... 205

10.4.2 PND Status Data in Upper Memory ...................................................................... 205

10.4.3 Input/Output Error Message Status Codes ........................................................... 206

10.4.4 Configuration Error Codes .................................................................................... 206

10.5 PND Performance ................................................................................................. 207

11 Support, Service & Warranty 209

11.1 Contacting Technical Support ............................................................................... 209

11.2 Warranty Information ............................................................................................ 211

Index 213

Page 8 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Start Here

In This Chapter

 Overview ................................................................................................. 9

 System Requirements ........................................................................... 10

 Package Contents ................................................................................. 10

 Mounting the Gateway on a DIN-rail ..................................................... 11

 Jumper Settings .................................................................................... 12

 SD Card................................................................................................. 12

 Connecting Power to the Unit ................................................................ 13

 Installing ProSoft Configuration Builder Software .................................. 14

User Manual

1 Start Here

To get the most benefit from this User Manual, you should have the following skills:

 PLC or PAC configuration software: Launch the program and use it to

configure the processor if required

 Microsoft Windows®: Install and launch programs, execute menu

commands, navigate dialog boxes, and enter data

 Hardware installation and wiring: Install the module, and safely connect

devices to a power source and to the PLX3x gateway port(s)

1.1 Overview

This document explains the features of the PLX3x gateway. It guides you through configuration, showing how to map data between a device or network, through the gateway, to a PLC or PAC. The ProSoft Configuration Builder software creates files to import into the PLC or PAC programming software, integrating the gateway into your system. You can also map data between areas in the gateway's internal database. This allows you to copy data to different addresses within the gateway database in order to create easier data requests and control.

The PLX3x gateways are stand-alone DIN-rail mounted units that provide one Ethernet port for communications, remote configuration, and diagnostics. Your specific gateway may include additional ports depending on the supported

ProSoft Technology, Inc. Page 9 of 215 January 25, 2018

protocols. The module has an SD Card slot (SD card optional) that allows you to store configuration files that you can use for recovery, transferring the configuration to another gateway, or general configuration backup.

Start Here PLX3x Series ♦ Multi-Protocol Gateways

Qty.

Part Name

Part Number

Part Description

Mini screwdriver

HRD250

Tool for wiring and securing the power connector

Power connector

J180

PLX3x gateway power connector

Qty.

Part Name

Part Number

Part Description

Mini screwdriver

HRD250

Tool for wiring and securing the power connector

Power connector

J180

PLX3x gateway power connector

User Manual

1.2 System Requirements

The ProSoft Configuration Builder configuration software for the PLX3x gateway requires the following minimum hardware and software components:

 Pentium® II 450 MHz minimum. Pentium III 733 MHz (or better)

recommended

 128 Mbytes of RAM minimum, 256 Mbytes of RAM recommended  100 Mbytes of free hard disk space (or more based on application

requirements)

 256-color VGA graphics adapter, 800 x 600 minimum resolution (True Color

1024  768 recommended)

Supported operating systems:

 Microsoft Windows 7 (32 bit) (64bit not tested)  Microsoft Windows Vista (not tested)  Microsoft Windows XP Professional with Service Pack 1 or 2  Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3 (not

tested)

 Microsoft Windows Server 2003 (not tested)

1.3 Package Contents

The following components are included with your PLX3x gateway, and are all required for installation and configuration. The quantity of cables provided depends on the specific protocol combination for your gateway.

Important: Before beginning the installation, please verify that all of the following items are present.

Gateway with Ethernet Port

Gateway with Two Ethernet Ports

Page 10 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Start Here

Qty.

Part Name

Part Number

Part Description

DB9 to Screw Terminal Adaptor

1454-9F

DB9 to screw terminal adapter

RJ45-DB9M Serial Adapter Cable

CABLE14

RJ45 to DB9 male serial adapter cable 1

Power Connector

J180

PLX3x gateway power connector

Mini screwdriver

HRD250

Tool for wiring and securing the power connector

Qty.

Part Name

Part Number

Part Description

DB9 to Screw Terminal Adaptor

1454-9F

DB9 to screw terminal adapter

RJ45-DB9M Serial Adapter Cable

CABLE14

RJ45 to DB9 male serial adapter cable 1

Power Connector

J180

PLX3x gateway power connector

Mini screwdriver

HRD250

Tool for wiring and securing the power connector

User Manual

Gateway with Ethernet Port and Single Serial Port

Gateway with Ethernet Port and Four Serial Ports

1.4 Mounting the Gateway on a DIN-rail

To mount the PLX3x gateway on a DIN-rail, follow these steps.

1 Position the gateway on the DIN-rail B at a slight angle. 2 Hook the lip on the rear of the adapter onto the top of the DIN-rail, and rotate

the adapter onto the rail.

3 Press the adapter down onto the DIN-rail until flush. The locking tab snaps

into position and lock the module to the DIN-rail.

4 If the adapter does not lock in place, use a screwdriver or similar device to

move the locking tab down while pressing the adapter flush onto the DIN-rail and release the locking tab to lock the adapter in place. If necessary, push up on the locking tab to lock.

ProSoft Technology, Inc. Page 11 of 215 January 25, 2018

Start Here PLX3x Series ♦ Multi-Protocol Gateways User Manual

1.5 Jumper Settings

There are three pairs of jumper pins located on the back of the module.

 MODE 1 - The two pins should be jumpered during normal operation.  MODE 2 - Default IP Jumper: This is the middle jumper. The default IP

address of the gateway is 192.168.0.250. Set this jumper to put the gateway's IP address back to the default.

 MODE 3 – If set, this jumper provides a level of security resulting in the

following behaviors:

o This jumper disables ProSoft Configuration Builder (PCB) upload

and download functions. If an upload or download request is made through PCB, the error message “Error: This module has been secured. Jumper 3 has been pinned” is displayed. This feature is supported on PCB version 4.4.15 and above.

o If a previous version of PCB is installed and Jumper Mode 3 is set,

the configuration cannot be uploaded/downloaded to the unit and PCB reports the following error: “Cannot connect to the module – Check IP address and connection: 405”.

o This jumper also disables access to the PLX3x web page, making

it impossible to upgrade the firmware.

o This jumper position is recognized even if changed after module

initialization.

o Applies to all modules with firmware version 1.04.

Page 12 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Start Here User Manual

1.6 SD Card

You can order a PLX3x gateway with an optional SD card (Part Number SDI-1G). In the event of a module failure, you can move the SD card from one module to the next and resume operation.

In general, if the SD card is present when you power up or reboot the module, the module uses the configuration on the SC card.

With an SD Card

 PCB downloads the configuration to the SD Card in the module.  The module does not transfer the configuration data from the SD card to

internal memory. If you remove the SD card and reboot to the module, the

module loads the configuration data from the module’s memory. If there is no

configuration data in the module’s memory, the module uses the factory default configuration.

Without an SD Card

 PCB downloads the configuration to the module’s internal memory.  If you insert a blank SD Card into the module after the module has been

configured, the module does not use the configuration on the SD card unless you reboot the module. If you want to copy the configuration to the SD card, you must download the configuration while the SD card is in the module.

1.7 Connecting Power to the Unit

WARNING: Be sure not to reverse polarity when applying power to the gateway. This causes

permanent damage to the gateway’s internal power distribution circuits.

ProSoft Technology, Inc. Page 13 of 215 January 25, 2018

Start Here PLX3x Series ♦ Multi-Protocol Gateways User Manual

1.8 Installing ProSoft Configuration Builder Software

You must install the ProSoft Configuration Builder (PCB) software to configure the gateway. You can always get the newest version of ProSoft Configuration Builder from the ProSoft Technology website (http://www.prosoft-technology.com). The filename contains the version of PCB. For example, PCB_4.4.3.4.0245.exe.

To install ProSoft Configuration Builder from the ProSoft Technology website

1 Open your web browser and navigate to www.prosoft-technology.com. 2 Search for 'PCB' or 'ProSoft Configuration Builder'. 3 Click on the ProSoft Configuration Builder search result link. 4 From the Downloads link, download the latest version of ProSoft

Configuration Builder.

5 Choose SAVE or SAVE FILE, if prompted. 6 Save the file to your Windows Desktop, so that you can find it easily when

you have finished downloading.

7 When the download is complete, locate and open the file, and then follow the

instructions on your screen to install the program.

Note: To use the ProSoft Configuration Builder under the Windows 7 OS, you must be sure to install it using the Run as Administrator option. To find this option, right-click the Setup.exe program icon, and then click RUN AS ADMINISTRATOR on the context menu. You must install using this option even if you are already logged in as an Administrator on your network or personal computer (PC). Using the Run as Administrator option allows the installation program to create folders and files on your PC with proper permissions and security.

If you do not use the Run as Administrator option, the ProSoft Configuration Builder may appear to install correctly, but you will receive multiple file access errors whenever the ProSoft Configuration Builder is running, especially when changing configuration screens. If this happens, you must completely uninstall the ProSoft Configuration Builder and then re-install using the Run as Administrator option to eliminate the errors.

Page 14 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

2 Using ProSoft Configuration Builder

ProSoft Configuration Builder (PCB) provides a quick and easy way to manage gateway configuration files customized to meet your application needs. PCB is not only a powerful solution for new configuration files, but also allows you to import information from previously installed (known working) configurations to new projects.

2.1 Connecting the PC to the Gateway

With the module securely mounted, connect one end of the Ethernet cable to the ETH 1 Port, and the other end to an Ethernet hub or switch accessible from the same network as the PC. Or, connect directly from the Ethernet Port on the PC to the ETH 1 Port on the module.

2.2 Setting a Temporary IP Address in the Gateway

Important: ProSoft Discovery Service (PDS) locates the gateway through UDP broadcast messages. PDS is an application that is built into PCB. These messages may be blocked by routers or layer 3 switches. In that case, PDS is unable to locate the gateways. To use PDS, arrange the Ethernet connection so that there is no router or layer 3 switch between the computer and the gateway OR reconfigure the router or layer 3 switch to allow the routing of the UDP broadcast messages.

ProSoft Technology, Inc. Page 15 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways User Manual

1 To open PDS, right-click on the gateway icon in PCB and click on

DIAGNOSTICS.

2 In the Diagnostics dialog box, click on the CONNECTION SETUP icon.

Page 16 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

3 In the Connection Setup dialog box, click the BROWSE DEVICE(S) button under

the ProSoft Discovery Service (PDS) heading.

4 In the ProSoft Discovery Service dialog box, click on the BROWSE FOR

PROSOFT MODULES icon to search for ProSoft Technology modules on the

network.

ProSoft Technology, Inc. Page 17 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways User Manual

5 Right-click module, and then select ASSIGN TEMPORARY IP.

6 The module’s default IP address is 192.168.0.250.

7 Enter an unused IP within your subnet, and then click OK. 8 See Configuring the Ethernet Port (page 23) for the steps to set the

permanent IP address in the gateway.

Page 18 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

2.3 Setting Up the Project

To begin, start ProSoft Configuration Builder (PCB). If you have used other Windows configuration tools before, you will find the screen layout familiar. The ProSoft Configuration Builder (PCB) window consists of a tree view on the left, an information pane, and a configuration pane on the right side of the window. When you first start PCB, the tree view consists of folders for Default Project and Default Location, with a Default Module in the Default Location folder. The following illustration shows the PCB window with a new project.

ProSoft Technology, Inc. Page 19 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways User Manual

To add the gateway to the project

1 Right-click DEFAULT MODULE in the tree view, and then choose CHOOSE

MODULE TYPE. This opens the Choose Module Type dialog box.

2 In the Product Line Filter area of the dialog box, select the appropriate

product type radio button.

3 In the STEP 1: Select Module Type dropdown list, select the model number

that matches your gateway.

4 For some gateways, you can disable one or more ports on the gateway if you

do not need them. See Disabling Gateway Ports (page 20).

5 Click OK to save your settings and return to the PCB Main window.

2.4 Disabling Gateway Ports

For some gateways, ProSoft Configuration Builder (PCB) gives you the option to disable one or more ports if you do not need them. Disabling ports can simplify the number of configuration options, making it easier to set up the gateway.

It is easiest to disable ports when you add the gateway to the project in PCB; however, you can enable and disable ports after you have added it to the project. Both methods are described in this topic.

Note: Disabling ports does not affect the performance of the gateway and is not required.

Page 20 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

To disable ports on the gateway when you add it to the project

The best time to disable one or more ports on a gateway is when you add the gateway to the project in PCB. See Setting Up the Project (page 19) for the steps to add a gateway. You can disable ports in the Choose Module Type dialog box after you select the module you want to add to the project. The following image gives an example.

There are two ports disabled. Please note the following:

 Ports that you can disable have UNCHECK IF NOT USED in the ACTION

REQUIRED column.

 Click the port name to disable the port. When you disable a port, a red circle

replaces the green checkmark (MBS Port 3 in this example).

 If there are multiple ports of the same type, only the last one has the

UnCheck if not Used message (MBS Port 2). You can disable and enable ports only in reverse order. In this example, MBS Port 4 was disabled before MBS Port 3.

 If you disable multiple ports of the same type, a yellow triangle replaces the

red circle for the port(s) that you disabled first (MBS Port 4).

 Finally, if you want to enable a disabled port in this dialog box, click the port

name again. Remember that you can enable ports only in order. In this example, you must enable MBS Port 3 before you can enable MBS Port 4.

ProSoft Technology, Inc. Page 21 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways User Manual

When you click OK, PCB inserts the gateway into the tree view with the disabled configuration options hidden.

Note that MBS Port 3 and MBS Port 4 do not appear in the configuration options for the gateway.

To disable or enable ports on the gateway after you add it to the project

1 Right-click the gateway (PLX31-EIP-MBS4 in this example) in the tree view,

and then choose CHOOSE MODULE TYPE. This opens the Choose Module Type dialog box, with the correct MODULE TYPE.

Warning: Note that all of the ports are enabled by default, and that the port state in the Choose Module Type dialog box DOES NOT MATCH THE ACTUAL STATE OF THE PORTS. If you want

any disabled ports to remain disabled, you must disable them again in this dialog box so that the red circle or yellow triangle appears next to the port name.

2 Click the port name to change its status from enabled to disabled, or from

disabled to enabled. The same rules noted above still apply. For example, you can disable MBS Port 3 only if MBS Port 4 is already disabled.

3 When you click OK, PCB updates the gateway in the tree view, showing the

configuration options for the enabled ports, and hiding the disabled ports.

Page 22 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

2.5 Configuring Gateway Parameters

1 Click the [+] sign next to the module icon to expand gateway information. 2 Click the [+] sign next to any icon to view gateway information and

configuration options.

3 Double-click any icon to open an Edit dialog box. 4 To edit a parameter, select the parameter in the left pane and make your

changes in the right pane.

5 Click OK to save your changes.

2.5.1 Renaming PCB Objects

You can rename objects such as the Default Project and Default Location folders in the tree view. You can also rename the MODULE icon to customize the project.

1 Right-click the object you want to rename and then choose RENAME. 2 Type the new name for the object and press Enter.

2.5.2 Printing a Configuration File

1 In the main PCB window, right-click the PLX3X GATEWAY icon and then

choose VIEW CONFIGURATION.

2 In the View Configuration dialog box, click the FILE menu and click PRINT. 3 In the Print dialog box, choose the printer to use from the drop-down list,

select the printing options, and click OK.

2.6 Configuring the Ethernet Port

This section shows how to set the Ethernet port parameters for the PLX3x gateway.

To configure the Ethernet port in PCB

1 In the ProSoft Configuration Builder tree view, double-click the Ethernet

Configuration icon.

ProSoft Technology, Inc. Page 23 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways

Parameter

Description

IP Address

Unique IP address assigned to the module

Netmask

Subnet mask of module

Gateway

Gateway (if used)

User Manual

2 Click any parameter in the Edit - WATTCP dialog box to change the value. If

your gateway has two Ethernet ports (PLX32) there are separate configuration options for each port.

Note: Each Ethernet port must be on a different Ethernet subnet.

To determine the protocol for an Ethernet port in PCB (PLX32 only)

1 In ProSoft Configuration Builder, click the [+] next to the gateway, then click

the [+] next to Module.

2 Double-click the second Module icon. 3 In the Edit - Module dialog box, click the port to see the protocol for that port.

You cannot change the protocol assigned to a port.

2.7 Mapping Data in Module Memory

Use the DATA MAP section in the ProSoft Configuration Builder to copy data between areas in the gateway's internal database. This allows you to copy data to different addresses within the gateway database in order to create simpler data requests and control. You can use this feature for the following tasks.

 Copy a maximum of 100 registers per Data Map command, and you can

configure a maximum of 200 separate copy commands.

 Copy data from the error or status tables in upper memory to internal

database registers in the user data area.

 Rearrange the byte and/or word order during the copy process. For example,

by rearranging byte or word order, you can convert floating-point values to the correct format for a different protocol.

 Use the Data Map to condense widely dispersed data into one contiguous

data block, making it easier to access.

Page 24 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

1 In the ProSoft Configuration Builder, expand the module tree by clicking the

[+] next to the module name.

2 Click the [+] next to COMMONNET, and then double-click DATA MAP.

3 In the Edit - Data Map dialog box, click ADD ROW.

4 Click EDIT ROW to edit the parameters for the mapping.

5 To change the value of a parameter, click the parameter and enter a new

value. Click OK when finished.

6 Repeat the steps above to add more memory mappings.

ProSoft Technology, Inc. Page 25 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways

Swap Code

Description

No Swap

No change is made in the byte ordering (1234 = 1234)

Word Swap

The words are swapped (1234 = 3412)

Word and Byte Swap

The words are swapped, then the bytes in each word are swapped (1234 =

4321)

Bytes

The bytes in each word are swapped (1234 = 2143)

User Manual

2.7.1 From Address

0 to highest Status Data address Specifies the beginning internal database register address for the copy operation.

This address can be any valid address in the user data area or the status data area of the gateway.

2.7.2 To Address

0 to 3999 Specifies the beginning destination register address for the copy operation. This

address must always be within the user data area. Make sure you specify a destination address that does not overwrite data that is stored in memory by one of the communication protocols running on the gateway.

2.7.3 Register Count

1 to 100 Specifies the number of registers to copy.

2.7.4 Swap Code

NO CHANGE, WORD SWAP, WORD AND BYTE SWAP, BYTE SWAP You may need to swap the order of the bytes in the registers during the copy

process in order to change the alignment of bytes between different protocols. Use this parameter when dealing with floating-point or other multi-register values, because there is no standard for storage of these data types in slave devices.

2.7.5 Delay Preset

This parameter sets an interval for each Data Map copy operation. The value for the Delay Preset is not a fixed amount of time. It is the number of firmware scans that must transpire between copy operations.

The firmware scan cycle can take a variable amount of time, depending on the level of activity of the protocol drivers running on the gateway and the level of activity on the gateway's communication ports. Each firmware scan can take from one to several milliseconds to complete. Therefore, Data Map copy operations cannot be expected to happen at regular intervals.

Page 26 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

If multiple copy operations (several rows in the Data map section) happen too frequently or all happen in the same update interval, they could delay the process scan of the gateway protocols, which could result in slow data updates or missed data on communication ports. To avoid these potential problems, set the Delay Preset to different values for each row in the Data Map section and set them to higher, rather than lower, numbers.

For example, Delay Preset values below 1000 could cause a noticeable delay in data updates through the communication ports. Do not set all Delay Presets to the same value. Instead, use different values for each row in the Data Map such as 1000, 1001, and 1002 or any other different Delay Preset values you like. This prevents the copies from happening concurrently and prevents possible process scan delays.

2.8 Downloading the Project to the Gateway

Note: For instructions on connecting to the module with your PC, see Connecting the PC to the Gateway (page 15).

In order for the module to use the settings you configured, you must download (copy) the updated Project file from your PC to the module.

Note: If jumper 3 of the module is set, this function is not available.

1 In the tree view in ProSoft Configuration Builder, right-click the PLX3X

GATEWAY icon and then choose DOWNLOAD FROM PC TO DEVICE. This opens

the Download dialog box.

2 In the Download dialog box, in the Select Connection Type dropdown box,

use the default ETHERNET option. Note: If you connected to the module using a temporary IP address, the

Ethernet address field contains that temporary IP address. ProSoft Configuration Builder uses this temporary IP address to connect to the module.

ProSoft Technology, Inc. Page 27 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways User Manual

3 Click TEST CONNECTION to verify that the IP address allows access to the

module.

4 If the connection succeeds, click DOWNLOAD to transfer the Ethernet

configuration to the module.

If the Test Connection procedure fails, you will see an error message. To correct the error, follow these steps.

1 Click OK to dismiss the error message. 2 In the Download dialog box, click BROWSE DEVICE(S) to open ProSoft

Discovery Service.

3 Right-click the module and then choose SELECT FOR PCB. 4 Close ProSoft Discovery Service. 5 Click DOWNLOAD to transfer the configuration to the module.

Page 28 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Using ProSoft Configuration Builder User Manual

2.9 Uploading the Project from the Gateway

Note: For instructions on connecting to the module with your PC, see Connecting the PC to the Gateway (page 15).

You can upload the project settings from the PLX3x gateway into the current project in ProSoft Configuration Builder on your PC.

1 In the tree view in ProSoft Configuration Builder, right-click the PLX3X

GATEWAY icon and then choose UPLOAD FROM DEVICE TO PC. This opens the

Upload dialog box.

2 In the Upload dialog box, in the Select Connection Type dropdown box, use

the default ETHERNET setting. Note: If you connected to the module using a temporary IP address, the

Ethernet address field contains that temporary IP address. ProSoft Configuration Builder uses this temporary IP address to connect to the module.

3 Click TEST CONNECTION to verify that the IP address allows access to the

module.

4 If the connection succeeds, click UPLOAD to transfer the Ethernet

configuration to the PC.

ProSoft Technology, Inc. Page 29 of 215 January 25, 2018

Using ProSoft Configuration Builder PLX3x Series ♦ Multi-Protocol Gateways User Manual

If the Test Connection procedure fails, you will see an error message. To correct the error, follow these steps.

1 Click OK to dismiss the error message. 2 In the Upload dialog box, click BROWSE DEVICE(S) to open ProSoft Discovery

Service.

3 Right-click the module and then choose SELECT FOR PCB. 4 Close ProSoft Discovery Service. 5 Click DOWNLOAD to transfer the configuration to the module.

Page 30 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Diagnostics and Troubleshooting

In This Chapter

 LED Indicators ....................................................................................... 31

 Using Diagnostics in ProSoft Configuration Builder ............................... 33

 Gateway Status Data in Upper Memory ................................................ 40

User Manual

3 Diagnostics and Troubleshooting

You can troubleshoot the module using several methods:

 Monitor the LED indicators on the gateway.  Use the Diagnostics functions in ProSoft Configuration Builder (PCB).  Examine the data in the status data area (upper memory) of the gateway

internal memory.

3.1 LED Indicators

The first and quickest is to scan the LEDs on the gateway to determine the existence and possible cause of a problem. The LEDs provide valuable information such as:

 The state of each port  System configuration errors  Application errors  Fault indications

ProSoft Technology, Inc. Page 31 of 215 January 25, 2018

Diagnostics and Troubleshooting PLX3x Series ♦ Multi-Protocol Gateways

LED

State

Description

PWR (Power)

Off

Power is not connected to the power terminals or source is insufficient to properly power the gateway (208 mA at 24 VDC is required).

Solid Green

Power is connected to the power terminals.

FLT (Fault)

Off

Normal operation.

Solid Red

A critical error has occurred. Program executable has failed or has been user-terminated and is no longer running. Press the Reset button or cycle power to clear the error.

CFG (Configura tion)

Off

Normal operation.

Solid Amber

The unit is in configuration mode. Either a configuration error exists, or the configuration file is being downloaded or read. After power-up, the gateway reads the configuration, and the unit implements the configuration values and initializes the hardware. This occurs during power cycle or after you press the Reset button.

ERR (Error)

Off

Normal operation.

FlashingAmber

An error condition has been detected and is occurring on one of the application ports. Check configuration and troubleshoot for communication errors.

Solid Amber

This error flag is cleared at the start of each command attempt (master/client) or on each receipt of data (slave/adapter/server). If this condition exists, it indicates a large number of errors are occurring in the application (due to bad configuration) or on one or more ports (network communication failures).

NS (Network Status) for EIP protocol only

Off

No power or no IP address

Solid Red

Duplicate IP address

Solid Green

Connected

Flashing Red

Connection timeout

Flashing Green

IP address obtained; no established connections

Alternating Red and Green Flash

Self-test

MS (Module Status) for EIP protocol only

Off

No power

Solid Red

Major fault

Solid Green

Device operational

Flashing Red

Minor fault

Flashing Green

Standby

Alternating Red and Green Flash

Self-test

User Manual

3.1.1 Main Gateway LEDs

This table describes the gateway front panel LEDs.

Page 32 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Diagnostics and Troubleshooting

LED

State

Description

LINK/ACT

Off

No physical network connection is detected. No Ethernet communication is possible. Check wiring and cables.

Solid Green

Physical network connection detected. This LED must be ON solid for Ethernet communication to be possible.

100 Mbit Off

No activity on the port.

Flashing Amber

The Ethernet port is actively transmitting or receiving data.

LED

State

Description

RX Off

No activity on the port.

Flashing Green

The port is actively receiving data.

TX Off

No activity on the port.

Flashing Amber

The port is actively transmitting data.

User Manual

3.1.2 Ethernet Port LEDs

This table describes the gateway Ethernet port LEDs.

3.1.3 Serial Port LEDs (for Gateways with Serial Ports)

This table describes gateway serial port LEDs.

3.2 Using Diagnostics in ProSoft Configuration Builder

ProSoft Configuration Builder (PCB) has many useful tools to help you with diagnostics and troubleshooting. You can use PCB to connect to your gateway and retrieve current status values, configuration data and other valuable information.

Tip: You can have a ProSoft Configuration Builder Diagnostics window open for more than one gateway at a time.

ProSoft Technology, Inc. Page 33 of 215 January 25, 2018

Diagnostics and Troubleshooting PLX3x Series ♦ Multi-Protocol Gateways User Manual

To connect to the gateway’s communication port.

1 In PCB, right-click the gateway name and choose DIAGNOSTICS.

This opens the Diagnostics window.

Note: The image above is for a specific version of the PLX3x gateway. The contents of the

Diagnostics window for your module depends on the protocols supported by the gateway.

See Diagnostics Menu (page 36) for more information. If there is no response from the gateway, as in the example above, follow these steps:

Page 34 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Diagnostics and Troubleshooting User Manual

2 From the toolbar, click the SETUP CONNECTION button.

3 In the Connection Setup dialog box, select ETHERNET from the SELECT

CONNECTION TYPE list. 4 Type in the gateway’s IP address in the ETHERNET field. 5 Click CONNECT. 6 Verify that the Ethernet is connected properly between your computer’s

communication port and the gateway. 7 If you are still not able to establish a connection, contact ProSoft Technology

Technical Support for assistance.

ProSoft Technology, Inc. Page 35 of 215 January 25, 2018

Diagnostics and Troubleshooting PLX3x Series ♦ Multi-Protocol Gateways

Menu Command

Submenu Command

Description

Module Version

Displays the gateway’s current software version and other

important values. You may be asked to provide this information when calling for technical support.

Data Map

Displays the gateway’s Data Map configuration.

Database View

ASCII

Displays the contents of the gateway’s database in ASCII

character format.*

Decimal

Displays the contents of the gateway’s database in decimal number format.*

Hex

Displays the contents of the gateway’s database in hexadecimal

number format.*

Float

Displays the contents of the gateway’s database in floating-point number format.*

User Manual

3.2.1 Diagnostics Menu

The Diagnostics menu is arranged as a tree structure in the left side of the Diagnostics window. The available menu commands depend on the protocols supported in your PLX3x gateway.

Caution: Some of the commands from this menu are designed for advanced debugging and system testing only, and can cause the gateway to stop communicating, potentially resulting in data loss or other communication failures. Use these commands only if you fully understand their potential effects, or if you are specifically directed to do so by ProSoft Technology Technical Support engineers.

The following menu commands are common to all PLX3x gateways:

*Use the scroll bar on the right edge of the window to navigate through the database. Each page displays 100 words of data. The total number of pages available depends on your gateway’s configuration.

Page 36 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Diagnostics and Troubleshooting User Manual

3.2.2 Capturing a Diagnostic Session to a Log File

You can capture anything you do in a Diagnostics session to a log file. This feature can be useful for troubleshooting and record-keeping purposes, and for communication with ProSoft Technology’s Technical Support team.

To capture session data to a log file

1 Open a Diagnostics window. See Using Diagnostics in ProSoft Configuration

Builder (page 33). 2 To log a Diagnostics session to a text file, from the toolbar, click the LOG FILE

button. Click the button again to stop the capture.

3 To view the log file, from the toolbar, click the VIEW LOG FILE button. The log

file opens as a text file, which you can rename and save to a different

location.

4 To email the log file to ProSoft Technology’s Technical Support team, from

the toolbar, click the EMAIL LOG FILE button. This only works if you have

installed Microsoft Outlook on your PC.)

5 If you capture multiple sequential sessions, PCB appends the new data to the

end of the previously captured data. If you want to clear the previous data

from the log file, you must click the CLEAR DATA button each time before you

start capturing data.

ProSoft Technology, Inc. Page 37 of 215 January 25, 2018

Diagnostics and Troubleshooting PLX3x Series ♦ Multi-Protocol Gateways User Manual

3.2.3 Using the Data Analyzer (Serial Protocols Only)

The Data Analyzer is an extremely valuable troubleshooting tool available in ProSoft Configuration Builder. It allows you to "see" the data packets entering and leaving the serial ports on the gateway. You can also capture this data to a log file.

Note: The PCB Data Analyzer is for serial ports only. To analyze data traffic on an Ethernet port, ProSoft Technology recommends using a network protocol analyzer available on the Internet, such as Wireshark.

To use the Data Analyzer

1 Open a Diagnostics window. See Using Diagnostics in ProSoft Configuration

Builder (page 33).

2 From the toolbar, click the SETUP DATA ANALYZER button.

3 In the Data Analyzer Setup dialog box, specify the time tick interval, the serial

port number, and whether the data packet contents should be displayed in hexadecimal number or ASCII character format. Click OK.

Note: The time tick is a symbol (_TT_) displayed on the Data Analyzer screen that allows you to estimate time intervals during a Data Analyzer session. The time tick prints at the time interval you choose in the Data Analyzer Setup dialog box. For example, if you select 10 mS Ticks, it prints _TT_ every 10 milliseconds.

4 If you wish to capture the Data Analyzer session to a log file, from the toolbar,

click the LOG FILE button.

Page 38 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Diagnostics and Troubleshooting User Manual

5 From the toolbar, click the START DATA ANALYZER button to start the Data

Analyzer. Click the button again to stop it.

The example below is part of a capture of standard Modbus data packets, displayed in hexadecimal number format.

 Data LEAVING the serial port is enclosed in angle brackets <>.  Data ENTERING the port is enclosed in square brackets [ ].  Each set of brackets holds one word (2 bytes) of data.

For Modbus protocol users: To interpret the data packets, refer to the Modbus Protocol Specification. See About the Modbus Protocol (page 112) or visit www.modbus.org.

3.2.4 Warm Boot / Cold Boot

Warm and Cold booting the PLX3x gateway can be done by clicking MODULE > GENERAL > WARM BOOT or COLD BOOT.

ProSoft Technology, Inc. Page 39 of 215 January 25, 2018

Diagnostics and Troubleshooting PLX3x Series ♦ Multi-Protocol Gateways

Description

4000 through 4001

Program Cycle Counter

4002 through 4004

Product Code (ASCII)

4005 through 4009

Product Revision (ASCII)

4010 through 4014

Operating System Revision (ASCII)

4015 through 4019

OS Run Number (ASCII)

User Manual

3.3 Gateway Status Data in Upper Memory

The gateway writes useful module status data in dedicated upper memory locations in its internal database. The location of this status data area depends on the protocols supported by your gateway. You can use the Data Map function in Prosoft Configuration Builder to map this data into the user data area of the gateway’s database (registers 0 through 3999). Remote devices, such as HMIs or processors can then access the status data. See Mapping Data in Module Memory (page 24).

3.3.1 General Gateway Status Data in Upper Memory

The following table describes the contents of the gateway’s general status data

area.

Page 40 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Diagnostics and Troubleshooting User Manual

3.3.2 Protocol-Specific Status Data in Upper Memory

The PLX3x gateway also has upper memory locations for protocol-specific status data. The location of the status data area for the gateway protocol drivers depend on the protocols. For more information, see:

 EIP Status Data in Upper Memory (page 71)  MBTCP Status Data in Upper Memory (page 108)  MBS Status Data in Upper Memory (page 127)  ASCII Status Data in Upper Memory (page 148)  SIE Status Data in Upper Memory (page 171)  PND Status Data in Upper Memory (page 205)

ProSoft Technology, Inc. Page 41 of 215 January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways User Manual

Page 42 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Hardware Information

In This Chapter

 EIP Functional Overview ....................................................................... 43

 Serial Port Cables (for Gateways with Serial Ports) .............................. 44

Specification

Description

Power Supply

24 VDC nominal 10 VDC to 36 VDC allowed Positive, Negative, GND Terminals

Current Load

208 mA normal @ 24 VDC normal 300 mA maximum @ 36 VDC maximum

Operating Temperature

-25°C to 70°C (-13°F to 158°F)

Storage Temperature

-40°C to 80°C (-40°F to 176°F)

Relative Humidity

5% to 95% RH with no condensation

Dimensions (H x W x D)

5.38 x 1.99 x 4.38 in

13.67 x 5.05 x 11.13 cm

LED Indicators (On all gateways)

 Configuration (CFG) and Error (ERR) Communication Status  Power (PWR) and Hardware Fault (FLT)  Network Status (NS) EtherNet/IP™ Class I or Class III Connection Status

(EtherNet/IP Only)

 Module Status (MS) Module Configuration Status (EtherNet/IP Only)  Ethernet Communication Port Link/Activity and 100 mbit  Serial Communication Port Receive (RX) and Transmit (TX)

Ethernet Port(s)

10/100 Mbit full-duplex RJ45 Connector Electrical Isolation 1500 Vrms at 50 Hz to 60 Hz for 60 seconds, applied as specified in section 5.3.2 of IEC 60950: 1991 Ethernet Broadcast Storm Resiliency = less than or equal to 5000 [ARP] frames-per-second and less than or equal to 5 minutes duration

Serial Port Isolation

2500 Vrms port signal isolation per UL 1577 serial port communication signal uses RF (Radio Frequency) modulation signal as isolation media, IC chip model is Silicon Labs Si844x (Si8440,Si8441,Si8442).

Shipped With Each Unit

2.5 mm screwdriver J180 Power Connector (1 to 4) RJ45-DB9M Serial Adapter Cable (serial protocol only) (1 to 4) DB9 to Screw Terminal Adapter (serial protocol only)

User Manual

4 Hardware Information

4.1 Hardware Specifications

ProSoft Technology, Inc. Page 43 of 215 January 25, 2018

Hardware Information PLX3x Series ♦ Multi-Protocol Gateways

Type

Specifications

Serial Port Isolation

Serial Port Protection

RS-485/422 port interface lines TVS diode protected at +/- 27V standoff voltage.

RS-232 port interface lines fault protected to +/- 36V power on, +/- 40V power off.

User Manual

4.1.1 Serial Port Specifications

4.2 Serial Port Cables (for Gateways with Serial Ports)

This section contains information on the cable and pinout assignments for the PLX3x gateway's serial ports (RS-232/422/485). The PLX3x gateway may come with one or four serial ports, depending on the configuration purchased.

Note: The PLX31-EIP-MBS4 gateway contains four serial communication ports.

The PLX31-EIP-MBS gateway contains one serial communication port.

Each physical serial port has a RJ45 jack connector. A six-inch RJ45 to DB9 Male adapter cable is provided for each serial port. The DB9 Male adapter cable provides connections for RS-232, wired as Data Terminal Equipment (DTE), RS422 and RS-485.

Page 44 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Hardware Information User Manual

4.2.1 Serial Port Specifications

This type of connection is used when the device connected to the gateway requires hardware handshaking (control and monitoring of modem signal lines). To enable hardware handshaking, set the port configuration to use RTS/CTS handshaking. (For MBS protocol, set the Use CTS Line parameter to Yes. For ASCII protocol, set the Handshaking parameter to Yes).

4.2.2 RS-232 - Null Modem (DTE without Hardware Handshaking)

This type of connection can be used to connect the gateway to a computer or field device communication port.

Note: If the port is configured to use RTS/CTS handshaking, then a jumper is required between the RTS and the CTS line on the gateway connection.

ProSoft Technology, Inc. Page 45 of 215 January 25, 2018

Hardware Information PLX3x Series ♦ Multi-Protocol Gateways User Manual

4.2.3 RS-232 - DTE to DCE Modem Connection

This type of connection is required between the gateway and a modem or other communication device.

For most modem applications, RTS/CTS handshaking should be enabled in the port configuration.

4.2.4 RS-422 Interface Connections

The following illustration applies when the RS-422 interface is selected.

Page 46 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways Hardware Information User Manual

4.2.5 RS-485 Interface Connection

The following illustration applies when the RS-485 interface is selected.

NOTE: This type of connection is commonly called a RS-485 half-duplex, 2-wire connection. If you have RS-485 4-wire, full-duplex devices, they can be connected to the gateway's serial ports by wiring together the TxD+ and RxD+ from the two pins of the full-duplex device to Pin 1 on the gateway and wiring together the TxD- and RxD- from the two pins of the full-duplex device to Pin 8 on the gateway. As an alternative, you could try setting the gateway to use the RS-422 interface and connect the full-duplex device according to the RS-422 wiring diagram. For additional assistance, please contact ProSoft Technical Support.

ProSoft Technology, Inc. Page 47 of 215 January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways User Manual

Page 48 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

In This Chapter

 EIP Functional Overview ....................................................................... 49

 EIP Configuration .................................................................................. 53

 Network Diagnostics .............................................................................. 70

 EIP Reference ....................................................................................... 76

User Manual

5 EIP Protocol

5.1 EIP Functional Overview

You can use the PLX3x gateway EIP gateway to interface many different protocols into the Rockwell Automation family of processors, or other softwarebased solutions.

The following illustration shows the functionality of the EtherNet/IP protocol.

ProSoft Technology, Inc. Page 49 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Class

Connection Type

Number of Connections

Class 1

I/O

Depends on the gateway model: PLX3x-EIP-MBTCP - 2 connections PLX3x-EIP-MBS - 2 connections PLX3x-EIP-MBS4 - 8 connections PLX3x-EIP-ASCII - 1 connection PLX3x-EIP-ASCII4 - 4 connections PLX3x-EIP-SIE - 2 connections PLX3x-EIP-PND - 8 connections

Class 3

Connected Client

Unconnected Client

Server

Supported PLC Types

PLC2, PLC5, SLC, CLX, CMPLX, MICROLX

Supported Message Types

PCCC and CIP

I/O connection sizes in/out

496/496 bytes

Max RPI time

5 ms per connection

CIP Services Supported

0x4C - CIP Data Table Read 0x4D - CIP Data Table Write CIP Generic

Command List

Supports up to 100 commands per client. Each command is configurable for command type, IP address, register to/from address, and word/bit count.

Command Sets

PLC-2/PLC-3/PLC5 Basic Command Set PLC5 Binary Command Set PLC5 ASCII Command Set SLC500 Command Set

User Manual

5.1.1 EtherNet/IP General Specifications

The EIP driver supports the following connections:

Page 50 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

5.1.2 EIP Internal Database

The internal database is central to the functionality of the PLX3x gateway. The gateway shares this database between all the communications ports on the gateway and uses it as a conduit to pass information from one protocol to another device on one network to one or more devices on another network. This permits data from devices on one communication port to be accessed and controlled by devices on another communication port.

In addition to data from the client and server, you can map status and error information generated by the gateway into the user data area of the internal database. The internal database is divided into two areas:

 Upper memory for the module status data area. This is where the module

writes internal status data for the protocols supported by the module.  Lower memory for the user data area. This is where incoming data from

external devices is stored and accessed.

Either protocol in the PLX3x gateway can write data to and read data from the user data area.

 If the module is acting as a client/master, you create commands to read data

from external client/server devices and store the data in a specific location in

the user data area.  If the module is acting as a server/slave, the external client/master devices

write data to a specific location in the user data area.

ProSoft Technology, Inc. Page 51 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

Note: If you want to access module status data in the upper memory, you can use the data mapping feature in the gateway to copy data from the module status data area to the user data area. See Mapping Data in Module Memory (page 24). Otherwise, you can use the diagnostic functions in ProSoft Configuration Builder to view module status data. For more information on the module status data, see Network Diagnostics (page 70).

EIP Client Access to Database

The client functionality exchanges data between the 's internal database and data tables established in one or more processors or other server based devices. The command list that you define in ProSoft Configuration Builder specifies what data is to be transferred between the gateway and each of the servers on the network. No ladder logic is required in the processor (server) for client functionality, except to assure that sufficient data memory exists.

The following illustration describes the flow of data between the Ethernet clients and the internal database.

Multiple Server Access to EIP Database

Server support in the gateway allows client applications (such as HMI software and processors) to read from and write to the gateway’s database. The server driver is able to support multiple concurrent connections from several clients.

When configured as a server, the user data area of the internal database in the gateway is the source for read requests and the destination for write requests from remote clients. Access to the database is controlled by the command type received in the incoming message from the client.

Page 52 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Data Type

Tag Name

Length of Each Element in CIP Message

Array Range for 4000 Element Database

BOOL

BOOLData[ ]

0 to 63999

Bit Array

BITAData[ ]

0 to 1999

SINT

SINTData[ ]

0 to 7999

INT

INT_Data[ ]

0 to 3999

DINT

DINTData[ ]

0 to 1999

REAL

REALData[ ]

0 to 1999

User Manual

The gateway must be correctly configured and connected to the network before any attempt is made to use it. Use a network verification program, such as ProSoft Discovery Service or the command prompt PING instruction, to verify that the gateway can be seen on the network. Use ProSoft Configuration Builder to confirm proper configuration of the gateway and to transfer the configuration files to and from the gateway.

5.2 EIP Configuration

5.2.1 Configuring EIP Class 3 Server

Use the EIP Class 3 Server connection in ProSoft Configuration Builder when the gateway is acting as a server (slave) device responding to message instructions initiated from a client (master) device such as an HMI, DCS, PLC, or PAC.

To set the server file size in PCB

1 In ProSoft Configuration Builder, click the [+] next to the gateway, then click

the [+] next to EIP Class 3 Server.

2 Double-click the second EIP Class 3 Server to display the Edit - EIP Class 3

Server dialog box.

3 Select the SERVER FILE SIZE (100 or 1000).

o For a value of 100, the registers are from N10:0 to N10:99. o For a value of 1000, the valid registers are from N10:0 to N10:999.

Accessing the Gateway’s Internal Memory

The following table refers to the user data area in the module's memory:

ProSoft Technology, Inc. Page 53 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Database Address

CIP Integer

CIP Boolean

CIP Bit Array

CIP Byte

CIP DINT

CIP Real

Int_data [0]

BoolData[0]

BitAData[0]

SIntData[0]

DIntData[0]

RealData [0]

999

Int_data [999]

BoolData[15984]

SIntData[1998]

1000

Int_data [1000]

BoolData[16000]

BitAData[500]

SIntData[2000]

DIntData[500]

RealData [500]

1999

Int_data [1999]

BoolData[31984]

SIntData[3998]

2000

Int_data [2000]

BoolData[32000]

BitAData[1000]

SIntData[4000]

DIntData[1000]

RealData [1000]

2999

Int_data [2999]

BoolData[47984]

SIntData[5998]

3000

Int_data [3000]

BoolData[48000]

BitAData[1500]

SIntData[6000]

DIntData[1500]

RealData [1500]

3999

Int_data [3999]

BoolData[63999]

SIntData[9998]

Database Address

File size 100

Database Address

File size 100

N10:0

999

N19:99

999

N19:99

1000

N20:0

1000

N20:0

1999

N29:99

1999

N29:99

2000

N30:0

2000

N30:0

User Manual

MSG Instruction Type - CIP

The following table defines the relationship of the user data area in the gateway’s

internal database to the addresses required in the MSG CIP instructions:

MSG Instruction Type - PCCC

The following table defines the relationship of the user data area in the gateway’s internal database to the addresses required in the MSG PCCC instructions:

Page 54 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Command

Function

Definition

Supported in Server

0x00

N/A

Protected Write

0x01

N/A

Unprotected Read

0x02

N/A

Protected Bit Write

0x05

N/A

Unprotected Bit Write

0x08

N/A

Unprotected Write

Command

Function

Definition

Supported in Server

0x0F

0x00

Word Range Write (Binary Address)

0x0F

0x01

Word Range Read (Binary Address)

0x0F

Typed Range Read (Binary Address)

0x0F

Typed Range Write (Binary Address)

0x0F

0x26

Read-Modify-Write (Binary Address)

0x0F

0x00

Word Range Write (ASCII Address)

0x0F

0x01

Word Range Read (ASCII Address)

0x0F

0x26

Read-Modify-Write (ASCII Address)

Command

Function

Definition

Supported in Server

0x0F

0xA1

Protected Typed Logical Read With Two Address Fields

0x0F

0xA2

Protected Typed Logical Read With Three Address Fields

0x0F

0xA9

Protected Typed Logical Write With Two Address Fields

0x0F

0xAA

Protected Typed Logical Write With Three Address Fields

X 0x0F

0xAB

Protected Typed Logical Write With Mask (Three Address Fields)

User Manual

EtherNet/IP Explicit Messaging Server Command Support

The PLX3x gateway supports several command sets.

Basic Command Set Functions

PLC-5 Command Set Functions

SLC-500 Command Set Functions

ProSoft Technology, Inc. Page 55 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

5.2.2 Configuring EIP Class 1 Connection

Use the EIP Class 1 Connection in ProSoft Configuration Builder when the gateway acts as an EIP adapter transferring data to and from a PLC (the EIP scanner) using a direct I/O connection. Direct I/O connections can transfer large amounts of data quickly.

The PLX3x EIP gateway can handle up to eight I/O connections (depending on the model), each with 248 words of input data and 248 words of output data.

Adding the Gateway to RSLogix5000 v.20

1 Start Rockwell Automation RSLinx and browse to the PLX3x gateway. 2 Right-click the gateway and then choose UPLOAD EDS FROM DEVICE.

Note: RSLogix5000 may need to be restarted in order to complete the EDS installation.

3 After you restart RSLogix 5000, open the desired RSLogix 5000 project. 4 In the Controller Organizer, right-click the EtherNet/IP bridge in the I/O tree

and choose NEW MODULE.

5 In the Select Module Type dialog box, in the Enter search text box, type

PLX3.

Page 56 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

6 Click your PLX3x gateway, and then click CREATE. This opens the New

Module dialog box.

7 In the New Module dialog box, enter a name for the gateway, then enter the

IP address of the PLX3x gateway.

8 To add I/O connections click CHANGE.

ProSoft Technology, Inc. Page 57 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

9 In the Module Definition dialog box, enter the I/O connections.

10 You can add up to eight I/O connections (depending on the PLX3x module).

The I/O connections have a fixed size of 496 bytes of input data and 496 bytes of output data. When finished click OK.

11 In the Module Properties dialog box, click the CONNECTION tab to configure

each I/O connection with its own RPI time. When finished, click OK. The new gateway appears in the Controller Organizer under the EtherNet/IP bridge.

Adding the Gateway to RSLogix5000 v.16 through v.19

Note: Class 1 connections are not supported in RSLogix v.15 and older

1 Start Rockwell Automation RSLogix 5000. 2 In the Controller Organizer, right-click the EtherNet/IP bridge in the I/O tree

and choose NEW MODULE.

3 In the Select Module Type dialog box, click FIND. Search for Generic

EtherNet Bridge, click Generic Ethernet Bridge, and then click CREATE.

4 In the New Module dialog box, enter a name for the gateway, then enter the

IP address of the PLX3x gateway. This creates the communication path from the processor to the PLX3x gateway.

Page 58 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Parameter

Value Range

Description

Input Data Address

0 to 3999

Specifies the starting address within the gateway’s

virtual database for data transferred from the gateway to the PLC.

Input Size

0 to 248

Specifies the number of Integers being transferred to the PLC's input image (248 integers max).

Output Data Address

0 to 3999

Specifies the starting address within the gateway’s

virtual database for data transferred from the PLC to the gateway.

Output Size

0 to 248

Specifies the number of integers being transferred to the PLC's output image (248 integers max).

User Manual

5 Add a new module under the Generic EtherNet Bridge and add a CIP

Connection (CIP-MODULE). Here is where you specify the parameters for

the I/O connection. The input and output sizes need to match the input and

output sizes configured in PCB. The ADDRESS field value represents the

connection number in PCB. By default all of the connections have 248 Input

words, 248 Output words, and 0 Configuration words. Set the Comm format

to Data type INT, and set the Assembly instances to be "1" for input, "2" for

output, and "4" for configuration. 6 Add and configure a CIP Connection for each I/O connection.

Configuring EIP Class 1 Connections in PCB

After you have created the PLX3x module in RSLogix 5000, you must configure the connections in the module.

To configure Class 1 connections in PCB

1 In ProSoft Configuration Builder, click the [+] next to the gateway, then click

the [+] next to EIP Class 1 Connection [x]. The value of [x] depends on the

number of ports on your PLX3x gateway (1 to 4).

2 Double-click the EIP Class 1 Connection [x] to display the Edit - EIP Class 1

Connection [x] dialog box.

3 In the dialog box, click a parameter and then enter a value for the parameter.

There are four configurable parameters for each I/O connection in ProSoft

Configuration Builder.

ProSoft Technology, Inc. Page 59 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

5.2.3 Configuring EIP Class 3 Client[x]/UClient Connection

The PLX3x gateway supports two connected clients and one unconnected client (most devices use connected clients; be sure refer to the user manual for the target device for verification).

 Use the EIP Class 3 Client [x] connections when the gateway is acting as a

client/master initiating message instructions to the server/slave devices. The PLX3x EIP protocol supports three connected client connections. Typical applications include SCADA systems, and SLC communication.

 Use the EIP Class 3 UClient connection when the gateway is acting as a

client/master initiating message instructions to the server/slave devices. The PLX3x EIP protocol supports one unconnected client connection. Unconnected messaging is a type of EtherNet/IP explicit messaging that uses TCP/IP implementation. Certain devices, such as the AB Power Monitor 3000 series B, support unconnected messaging. Check your device documentation for further information about its EtherNet/IP implementation.

Class 3 Client[x]/UClient

To configure Class 3 Client/UClient [x] connections

1 In ProSoft Configuration Builder, click the [+] next to the gateway, then click

the [+] next to EIP Class 3 Client [x] or EIP Class 3 UClient [x].

2 Double-click the second EIP Class 3 Client [x] to display the Edit - EIP Class

3 Client [x] dialog box.

3 In the dialog box, click any parameter to change its value.

Page 60 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Parameter

Value

Description

Minimum Command Delay

0 to 65535 milliseconds

Specifies the number of milliseconds to wait between the initial issuances of a command. This parameter can be used to delay all commands sent to servers to avoid "flooding" commands on the network. This parameter does not affect retries of a command as they will be issued when failure is recognized.

Response Timeout

0 to 65535 milliseconds

Specifies the amount of time in milliseconds that a Client will wait before retransmitting a command if no response is received from the addressed server. The value to use depends on the type of communication network used, and the expected response time of the slowest device connected to the network.

Retry Count

0 to 10

Specifies the number of times a command will be retried if it fails.

User Manual

The following table specifies the configuration for the EIP client (master) device on the network port:

Class 3 Client[x]/UClient Commands

There is a separate command list for each of the different message types supported by the protocol. Each list is processed from top to bottom, one after the other, until all specified commands are completed, and then the polling process begins again.

This section defines the EtherNet/IP commands to be issued from the gateway to server devices on the network. You can use these commands for data collection and control of devices on the TCP/IP network. In order to interface the virtual database with Rockwell Automation Programmable Automation Controllers (PACs), Programmable Logic Controllers (PLCs), or other EtherNet/IP server devices, you must construct a command list, using the command list parameters for each message type.

To add Class 3 Client/UClient [x] commands

1 In ProSoft Configuration Builder, click the [+] next to the gateway, then click

the [+] next to EIP Class 3 Client [x] or EIP Class 3 UClient [x].

2 Double-click the desired command type to display the Edit - EIP Class 3

Client [x] Commands or Edit - EIP Class 3 UClient [x] Commands dialog box.

3 Click ADD ROW to add a new command. 4 Click EDIT ROW or double-click the row to display the Edit dialog box where

you configure the command.

ProSoft Technology, Inc. Page 61 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Parameter

Value

Description

Enable

Enable Disable Conditional

Write

Specifies if the command should be executed and under what conditions.

ENABLE - The Command is executed each scan of the command list DISABLE - The command is disabled and will not be executed CONDITIONAL WRITE - The Command executes only if the internal data

associated with the command changes

Internal Address

0 to 3999

Specifies the database address in the module’s internal database to be associated with the command. If the command is a read function, the data received in the response message is placed at the specified location. If the command is a write function data used in the command is sourced from specified data area.

Poll Interval

0 to 65535

Specifies the minimum interval to execute continuous commands. The parameter is entered in 1/10 of a second. If a value of 100 is entered for a command, the command executes no more frequently than every 10 seconds.

Reg Count

0 to 125

Specifies the number of data points to be read from or written to the target device.

Swap Code

None Word swap Word and Byte

swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) BYTE SWAP - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies the IP address of the target device to be addressed.

Slot

-1

Specifies the slot number for the device. Use a value of -1 when interfacing to an SLC 5/05. These devices do not have a slot parameter. When addressing a processor in a ControlLogix or CompactLogix rack, the slot number corresponds to the slot in the rack containing the controller being addressed.

Func Code

501 509

Specifies the function code to be used in the command.

501 - Protected Typed Read 509 - Protected Typed Write

File Type

Binary Counter Timer Control Integer Float ASCII String Status

Specifies the file type to be associated with the command.

File Number

-1

Specifies the PLC-5 file number to be associated with the command. If a value of -1 is entered for the parameter, the field will not be used in the command, and the default file will be used.

Element Number

Specifies the element in the file where the command will start. Comment

Optional 32 character comment for the command.

User Manual

Class 3 Client/UClient [x] Commands SLC500 2 Address Fields

Page 62 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Parameter

Value

Description

Enable

Enable Disable Conditional Write

Specifies if the command should be executed and under what conditions.

ENABLE - The Command is executed each scan of the command list DISABLE - The command is disabled and will not be executed CONDITIONAL WRITE - The Command executes only if the internal data

associated with the command changes

Internal Address

0 to 3999

Poll Interval

0 to 65535

Reg Count

0 to 125

Specifies the number of data points to be read from or written to the target device.

Swap Code

None Word swap Word and Byte swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) Byte swap - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies the IP address of the target device to be addressed by this command.

Slot

-1

Specifies the slot number for the device. Use a value of -1 when interfacing to an SLC 5/05. These devices do not have a slot parameter. When addressing a processor in a ControlLogix or CompactLogix, the slot number corresponds to the slot in the rack containing the controller being addressed.

Func Code

502 510 511

Specifies the function code to be used in the command.

502 - Protected Typed Read 510 - Protected Typed Write 511 - Protected Typed Write w/Mask

User Manual

Class 3 Client[x]/UClient Commands SLC500 3 Address Fields

This command is typically used when accessing data in a Timer or Counter. I.e. T.1.1.2 is the address of the accumulator in Timer 1.

ProSoft Technology, Inc. Page 63 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Parameter

Value

Description

File Type

Binary Counter Timer Control Integer Float ASCII String Status

Specifies the file type to be associated with the command.

File Number

-1

Specifies the SLC 500 file number to be associated with the command. If a value of -1 is entered for the parameter, the field will not be used in the command, and the default file will be used.

Element Number

Specifies the element in the file where the command will start.

Sub Element

Specifies the sub-element to be used with the command. Refer to the AB documentation for a list of valid sub-element codes.

Comment

Optional 32 character comment for the command.

Parameter

Value

Description

Enable

Enable Disable Conditional Write

Specifies if the command should be executed and under what conditions.

ENABLE - The Command is executed each scan of the command list DISABLE - The command is disabled and will not be executed CONDITIONAL WRITE - The Command executes only if the internal data

associated with the command changes

Internal Address

0 to 3999

Poll Interval

0 to 65535

Reg Count

0 to 125

Specifies the number of data points to be read from or written to the target device.

Swap Code

None Word swap Word and Byte swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) BYTE SWAP - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies the IP address of the target device to be addressed by this command.

Slot

-1

Specifies the slot number for the device. Use a value of -1 when

User Manual

Class 3 Client[x]/UClient Commands PLC5 Binary

Page 64 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Parameter

Value

Description

interfacing to a PLC5 These devices do not have a slot parameter. When addressing a processor in a ControlLogix or CompactLogix, the slot number corresponds to the slot in the rack containing the controller being addressed.

Func Code

100 101 102

Specifies the function code to be used in the command.

100 - Word Range Write 101 - Word Range Read 102 - Read-Modify-Write

File Number

-1

Specifies the PLC5 file number to be associated with the command. If a value of -1 is entered for the parameter, the field will not be used in the command, and the default file will be used.

Element Number

Specifies the element in the file where the command will start.

Sub Element

Specifies the sub-element to be used with the command. Refer to the AB documentation for a list of valid sub-element codes.

Comment

Optional 32 character comment for the command.

Parameter

Value

Description

Enable

Enable Disable Conditional Write

Specifies if the command should be executed and under what conditions.

ENABLE - The Command is executed each scan of the command list DISABLE - The command is disabled and will not be executed CONDITIONAL WRITE - The Command executes only if the internal data

associated with the command changes

Internal Address

0 to 3999

Poll Interval

0 to 65535

Reg Count

0 to 125

Specifies the number of data points to be read from or written to the target device.

Swap Code

None Word swap Word and Byte swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) BYTE SWAP - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies IP address of the target device to be addressed by this command.

Slot

-1

Specifies the slot number for the device. Use a value of -1 when

User Manual

Class 3 Client[x]/UClient Commands PLC5 ASCII

ProSoft Technology, Inc. Page 65 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Parameter

Value

Description

Func Code

150 151 152

Specifies the function code to be used in the command.

150 - Word Range Write 151 - Word Range Read 152 - Read-Modify-Write

File String

Specifies the PLC-5 Address as a string. For example N10:300

Comment

Optional 32 character comment for the command.

Parameter

Value

Description

Enable

Enable Disable Conditional Write

Specifies if the command should be executed and under what conditions.

ENABLE - The Command is executed each scan of the command list DISABLE - The command is disabled and will not be executed CONDITIONAL WRITE - The Command executes only if the internal data

associated with the command changes

Internal Address

0 to 3999

Poll Interval

0 to 65535

Reg Count

0 to 125

Specifies the number of data points to be read from or written to the target device.

Swap Code

None Word swap Word and Byte swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) BYTE SWAP - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies the IP address of the target device to be addressed by this command.

Slot

-1

Specifies the slot number for the device. Use a value of -1 when interfacing to a PLC5 These devices do not have a slot parameter. When addressing a processor in a ControlLogix or CompactLogix, the slot number corresponds to the slot in the rack containing the controller being addressed.

Func Code

332 333

Specifies the function code to be used in the command.

332 - CIP Data Table Read 333 - CIP Data Table Write

User Manual

Class 3 Client[x]/UClient Commands Controller Tag Access

Page 66 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Data Type

Bool SINT INT DINT REAL DWORD

Specifies the data type of the target controller tag name.

Tag Name

Specifies the controller tag in the target PLC.

Offset

0 to 3999

Specifies the offset database where the value corresponds to the Tag Name parameter

Comment

Optional 32 character comment for the command.

Parameter

Value

Description

Enable

Disabled Enabled Conditional Write

Specifies the condition to execute the command.

DISABLED - The command is disabled and will not be executed. ENABLED - The command is executed on each scan of the command

list if the Poll Interval is set to zero. If the Poll Interval is non-zero, the command is executed when the interval timer expires.

CONDITIONAL WRITE - The command executes only if the internal data value(s) to be sent has changed.

Internal Address

0 to 9998

Specifies the database address in the module’s internal database to be associated with the command. If the command is a read function, the data received in the response message is placed at the specified location. If the command is a write function, data used in the command is sourced from specified data area.

Poll Interval

0 to 65535

Specifies the minimum interval to execute continuous commands. The parameter is entered in 1/10 of a second. For example, if a value of '100' is entered for a command, the command executes no more frequently than every 10 seconds.

Reg Count

0 to 125

Specifies the number of data points to read/write to the target device.

Swap Code

None Word swap Word and Byte swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) BYTE SWAP - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies the IP address of the target device to be addressed by this command.

Slot

-1

Use ‘-1’ to target a connected device. Use > -1 to target a device in a specific slot number within the rack.

Func Code

CIP Generic

Used to read/write the attributes of any object by using an explicit address

Service Code

00 to FF (Hex)

An integer identification value which denotes a particular Object Instance and/or Object class function. For more information refer to ODVA CIP specification.

User Manual

Class 3 Client[x]/UClient Commands CIP Generic

ProSoft Technology, Inc. Page 67 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Class

00 to FFFF (Hex)

An integer identification value assigned to each Object Class accessible from the network. For more information, refer to ODVA CIP specification.

Instance

Applicationdependent

An integer identification value assigned to an Object Instance that identifies it among all Instances of the same Class. For more information, refer to ODVA CIP specification.

Attribute

00 to FFFF (Hex)

An integer identification value assigned to a Class and/or Instance Attribute. For more information, refer to ODVA CIP specification.

Comment

This field can be used to give a 32 character comment to the command. The ":" and "#" characters are reserved characters. It is strongly recommended not be use in the comment section.

User Manual

Note: Due to the behavior of Connected Clients, please note the following:

- You cannot configure multiple commands with different Class objects to the same device.

- You cannot configure multiple commands with different Class objects to different devices.

- You can configure multiple commands using the Get_Attribute_Single of the same Class and address different Attributes.

- If you have commands in any of the other command types (i.e. Controller Tag Access) and configure a CIP Generic command to the same device, it will not work due to the Connected Client having an active connection to a device. However, you can use both Controller Tag Access and CIP Generic if the target devices are different.

- To avoid any or all these scenarios, it is recommended to use the Unconnected Client if you wish to send commands to different devices, since these connections are reset/closed after each command is executed.

Page 68 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Parameter

Value

Description

Enable

Enable Disable Conditional Write

Specifies if the command should be executed and under what conditions.

ENABLE - The command is executed each scan of the command list DISABLE - The command is disabled and will not be executed CONDITIONAL WRITE - The command executes only if the internal data

associated with the command changes

Internal Address

0 to 3999

Poll Interval

0 to 65535

Reg Count

0 to 125

Specifies the number of data points to be read from or written to the target device.

Swap Code

None Word swap Word and Byte swap Byte swap

Specifies if the data from the server is to be ordered differently than it was received. This parameter is typically used when dealing with floating-point or other multi-register values.

NONE - No change is made (abcd) WORD SWAP - The words are swapped (cdab) WORD AND BYTE SWAP - The words and bytes are swapped (dcba) BYTE SWAP - The bytes are swapped (badc)

IP Address

xxx.xxx.xxx.xxx

Specifies the IP address of the target device to be addressed by this command.

Slot

-1

Use a value of -1 when interfacing to an SLC 5/05. These devices do not have a slot parameter. When addressing a processor in a ControlLogix or CompactLogix, the slot number corresponds to the slot in the rack containing the controller being addressed.

Func Code

1 2 3 4 5

Specifies the function code to be used in the command.

1 - Protected Write 2 - Unprotected Read 3 - Protected Bit Write 4 - Unprotected Bit Write 5 - Unprotected Write

Word Address

Specifies the word address where to start the operation. Comment

Optional 32 character comment for the command.

User Manual

Class 3 Client[x]/UClient Commands Basic

ProSoft Technology, Inc. Page 69 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Connection Type

Submenu Item

Description

EIP Class 1

Config

Configuration settings for Class 1 Connections.

Status

Status of the Class 1 Connections. Displays any configuration error, as well as the number of Class 1 Connections.

EIP Class 3 Server

Config

Configuration settings for Class 3 Server Connections.

Comm Status

Status information for each Class 3 Server Connection. Displays port numbers, IP addresses, socket status, and read and write counts.

EIP Class 3 Client/UClient [x]

Config

Configuration settings for Class 3 Client/UClient Connections.

Comm Status

Status information for Class 3 Client/UClient [x] commands. Displays a summary of all the errors resulting from Class 3 Client/UClient [x] commands.

Commands

Configuration for the Class 3 Client/UClient [x] command list.

Cmd Errors (Decimal)

Current error codes for each command on the Class 3 Client/UClient [x] command list in decimal number format. A zero means there is currently no error for the command.

Cmd Errors (Hex)

Current error codes for each command on the Class 3 Client/UClient [x] command list in hexadecimal number format. A zero means there is currently no error for the command.

User Manual

5.3 Network Diagnostics

5.3.1 EIP PCB Diagnostics

The best way to troubleshoot the EIP driver is to use ProSoft Configuration Builder to access the diagnostic capabilities of the gateway through the Ethernet debug port.

The following table summarizes the status information available in PCB for the EIP driver:

For specific information on error codes, see EIP Error Codes (page 73).

Page 70 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

EIP Client

Address Range

Connected Client 0

7900 through 7909

Connected Client 1

8100 through 8109

Unconnected Client 0

12800 through 12809

Offset

Description

Number of Command Requests

Number of Command Responses

Number of Command Errors

Number of Requests

Number of Responses

Number of Errors Sent

Number of Errors Received

Reserved

Current Error Code

Last Error Code

EIP Client

Address Range

Connected client 0

7910 through 8009

Connected client 1

8110 through 8209

Unconnected client 0

12810 through 12909

User Manual

5.3.2 EIP Status Data in Upper Memory

The EIP driver has an associated status data area located in the PLX3x gateway’s upper memory. The Data Map functionality of the PLX3x gateway can be used to map this data into the normal user data range of the PLX3x gateway’s database.

Note that all the status values are initialized to zero (0) at power-up, cold boot and during warm boot.

EIP Client Status Data

The following table lists the addresses in upper memory the PLX3x gateway stores general error and status data for each EIP connected and unconnected client:

The content of each client’s status data area is structured in the same way. The

following table describes the content of each register in the status data area:

EIP Client Command List Error Data

The PLX3x gateway stores a status/error code in upper memory for each

command in each EIP client’s command list. The following table lists the

addresses in upper memory where the gateway stores the command list error data for each EIP client:

ProSoft Technology, Inc. Page 71 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Offset

Description

Command #1 Error Code

Command #2 Error Code

Command #3 Error Code

Command #4 Error Code

Command #5 Error Code

. . .

Command #98 Error Code

Command #99 Error Code

Command #100 Error Code

EIP Server

Address Range

11000 through 11015

11016 through 11031

11032 through 11047

11048 through 11063

11064 through 11079

Offset

Description

0 through 1

Connection State

2 through 3

Open Connection Count

4 through 5

Socket Read Count

6 through 7

Socket Write Count

8 through 15

Peer IP

User Manual

The first word in each client’s command list error data area contains the

status/error code for the first command in the client’s command list. Each

successive word in the command error list is associated with the next command in the list. Therefore, the size of the command list error data area depends on the number of commands defined.

The structure of the command list error data area (which is the same for all clients) is displayed in the following table:

EIP Server Status Data

The following table lists the addresses in upper memory where the PLX3x gateway stores status data for each EIP server:

The content of each server’s status data area is structured the same. The following table describes the content of each register in the status data area:

Page 72 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Code (Int)

Code (Hex)

Description

0x0000

Success, no error

256

0x0100

DST node is out of buffer space

512

0x0200

Cannot guarantee delivery (Link Layer)

768

0x0300

Duplicate token holder detected

1024

0x0400

Local port is disconnected

1280

0x0500

Application layer timed out waiting for response

1536

0x0600

Duplicate node detected

1792

0x0700

Station is offline

2048

0x0800

Hardware fault

Code (Int)

Code (Hex)

Description

0x0000

Success, no error

4096

0x1000

Illegal command or format

8192

0x2000

Host has a problem and will not communicate

12288

0x3000

Remote node host is missing, disconnected or shut down

16384

0x4000

Host could not complete function due to hardware fault

20480

0x5000

Addressing problem or memory protect rungs

24576

0x6000

Function not allowed due to command protection selection

26872

0x7000

Processor is in Program mode

-32768

0x8000

Compatibility mode file missing or communication zone problem

-28672

0x9000

Remote node cannot buffer command

-24576

0xA000

Wait ACK (1775-KA buffer full)

-20480

0xB000

Remote node problem due to download

User Manual

5.3.3 EIP Error Codes

The gateway stores error codes returned from the command list process in the command list error memory region. A word is allocated for each command in the memory area. The error codes are formatted in the word as follows: The leastsignificant byte of the word contains the extended status code and the mostsignificant byte contains the status code.

Use the error codes returned for each command in the list to determine the success or failure of the command. If the command fails, use the error code to determine the cause of failure.

Warning: The gateway-specific error codes (not EtherNet/IP/PCCC compliant) are returned from the gateway and never returned from an attached EtherNet/IP/PCCC slave device. These are error codes that are part of the EtherNet/IP/PCCC protocol or are extended codes unique to the PLX3x gateway. The most common errors for the EtherNet/IP/PCCC protocol are shown below.

Local STS Error Codes

Remote STS Error Codes

ProSoft Technology, Inc. Page 73 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Code (Int)

Code (Hex)

Description

-16384

0xC000

Wait ACK (1775-KA buffer full)

-12288

0xD000

Not used

-8192

0xE000

Not used

0xF0nn

Error code in the EXT STS byte (nn contains EXT error code)

Code (Int)

Code (Hex)

Description

-4096

0xF000

Not used

-4095

0xF001

A field has an illegal value

-4094

0xF002

Fewer levels specified in address than minimum for any address

-4093

0xF003

More levels specified in address than system supports

-4092

0xF004

Symbol not found

-4091

0xF005

Symbol is of improper format

-4090

0xF006

Address does not point to something usable

-4089

0xF007

File is wrong size

-4088

0xF008

Cannot complete request

-4087

0xF009

Data or file is too large

-4086

0xF00A

Transaction size plus word address is too large

-4085

0xF00B

Access denied, improper privilege

-4084

0xF00C

Condition cannot be generated - resource is not available

-4083

0xF00D

Condition already exists - resource is already available

-4082

0xF00E

Command cannot be executed

-4081

0xF00F

Histogram overflow

-4080

0xF010

No access

-4079

0xF011

Illegal data type

-4078

0xF012

Invalid parameter or invalid data

-4077

0xF013

Address reference exists to deleted area

-4076

0xF014

Command execution failure for unknown reason

-4075

0xF015

Data conversion error

-4074

0xF016

Scanner not able to communicate with 1771 rack adapter

-4073

0xF017

Type mismatch

-4072

0xF018

1171 Gateway response was not valid

-4071

0xF019

Duplicate label

-4070

0xF01A

File is open; another node owns it

-4069

0xF01B

Another node is the program owner

-4068

0xF01C

Reserved

-4067

0xF01D

Reserved

-4066

0xF01E

Data table element protection violation

-4065

0xF01F

Temporary internal problem

User Manual

EXT STS Error Codes

Page 74 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Code (Int)

Code (Hex)

Description

-1

0xFFFF

CTS modem control line not set before transmit

-2

0xFFFE

Timeout while transmitting message

-10

0xFFF6

Timeout waiting for DLE-ACK after request

-11

0xFFF5

Timeout waiting for response after request

-12

0xFFF4

Reply data does not match requested byte count

-20

0xFFEC

DLE-NAK received after request

-21

0xFFEB

DLE-NAK sent after response

-200

0xFF38

DLE-NAK received after request

Error (Int)

Error (Hex)

Description

-33

0xFFDF

Failed to connect to target

-34

0xFFDE

Failed to register session with target (timeout)

-35

0xFFDD

Failed forward open response timeout

-36

0xFFDC

PCCC/Tag command response timeout

-37

0xFFDB

No TCP/IP connection error

Error (Int)

Error (Hex)

Description

-40

0xFFD8

Invalid response length

-41

0xFFD7

CPF item count not correct

-42

0xFFD6

CPF address field error

-43

0xFFD5

CPF packet tag invalid

-44

0xFFD4

CPF bad command code

-45

0xFFD3

CPF status error reported

-46

0xFFD2

CPF incorrect connection ID value returned

-47

0xFFD1

Context field not matched

-48

0xFFD0

Incorrect session handle returned

-49

0xFFCF

CPF not correct message number

Error (Int)

Error (Hex)

Description

-50

0xFFCE

Message length received not valid

-51

0xFFCD

Status error reported

-52

0xFFCC

Invalid version

User Manual

EIP Error Codes

TCP/IP Interface Error Codes

Common Response Error Codes

ProSoft Technology, Inc. Page 75 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Error (Int)

Error (Hex)

Description

-55

0xFFC9

Message length received not valid

-56

0xFFC8

Status error reported

Error (Int)

Error (Hex)

Description

-61

0xFFC3

Message length received not valid

-62

0xFFC2

Status error reported

-63

0xFFC1

CPF bad command code

-64

0xFFC0

TNS in PCCC message not matched

-65

0xFFBF

Vendor ID in PCCC message not matched

-66

0xFFBE

Serial number in PCCC message not matched

User Manual

Forward Open Response Error Codes

PCCC Response Error Codes

5.4 EIP Reference

5.4.1 SLC and MicroLogix Specifics

Messaging from a SLC 5/05

The PLX3x gateway can receive messages from a SLC 5/05 containing an Ethernet interface. The gateway supports both read and write commands.

SLC5/05 Write Commands

Write commands transfer data from the SLC processor to the gateway. The following diagram shows an example rung to execute a write command.

1 Set the READ/WRITE parameter to WRITE. The gateway supports a TARGET

DEVICE parameter value of 500CPU or PLC5.

Page 76 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

2 In the MSG object, click SETUP SCREEN in the MSG object to complete the

configuration of the MSG instruction. This displays the following dialog box.

3 Set the TARGET DEVICE DATA TABLE ADDRESS to a valid file element (such as,

N11:0) for SLC and PLC5 messages.

4 Set the MULTIHOP option to YES. 5 Complete the MULTIHOP tab portion of the dialog box shown in the following

image.

6 Set the TO ADDRESS value to the gateway’s Ethernet IP address. 7 Press the INS key to add the second line for ControlLogix Backplane and set

the slot number to zero.

ProSoft Technology, Inc. Page 77 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

SLC5/05 Read Commands

Read commands transfer data to the SLC processor from the gateway. The following diagram shows an example rung to execute a read command.

1 Set the READ/WRITE parameter to READ. The gateway supports a TARGET

DEVICE parameter value of 500CPU or PLC5.

2 In the MSG object, click SETUP SCREEN in the MSG object to complete the

configuration of the MSG instruction. This displays the following dialog box.

3 Set the TARGET DEVICE DATA TABLE ADDRESS to a valid file element (such

as, N11:0) for SLC and PLC5 messages.

4 Set the MULTIHOP option to YES.

Page 78 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

File Type

Description

Status

Bit T Timer

Counter

Control

Integer

Floating-point

String

ASCII

User Manual

5 Fill in the MULTIHOP tab portion of the dialog box as shown in the following

image.

6 Set the TO ADDRESS value to the gateway’s Ethernet IP address. 7 Press the INS key to add the second line for ControlLogix Backplane and set

the slot number to zero.

SLC File Types

This information is specific to the SLC and MicroLogix family or processors used with the PCCC command set. The SLC and MicroLogix processor commands support a file type field entered as a single character to denote the data table to use in the command. The following table defines the relationship of the file types accepted by the gateway and the SLC file types.

The File Type Command Code is the ASCII character code value of the File Type letter. This is the value to enter for the FILE TYPE parameter of the PCCC Command configurations in the data tables in the ladder logic.

Additionally, the SLC specific functions (502, 510 and 511) support a subelement field. This field selects a sub-element field in a complex data table. For example, to obtain the current accumulated value for a counter or timer, set the sub-element field to 2.

ProSoft Technology, Inc. Page 79 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

5.4.2 PLC5 Processor Specifics

Messaging from a PLC5

The gateway can receive messages from a PLC5 containing an Ethernet interface. The gateway supports both read and write commands.

PLC5 Write Commands

Write commands transfer data from the PLC5 processor to the gateway. The following diagram shows an example rung to execute a write command.

1 In the MSG object, click SETUP SCREEN in the MSG object to complete the

configuration of the MSG instruction. This displays the following dialog box.

2 Select the COMMUNICATION COMMAND to execute from the following list of

supported commands.

o PLC5 Type Write o PLC2 Unprotected Write o PLC5 Typed Write to PLC o PLC Typed Logical Write

Page 80 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

3 Set the TARGET DEVICE DATA TABLE ADDRESS to a valid file element (such

as,N11:0) for SLC and PLC5 messages. For the PLC2 Unprotected Write

message, set the address to the database index (such as, 1000) for the

command.

4 Set the MULTIHOP option to YES. 5 Complete MULTIHOP tab portion of the dialog box as shown in the following

image.

6 Set the TO ADDRESS value to the gateway’s Ethernet IP address. 7 Press the INS key to add the second line for ControlLogix Backplane and set

the slot number to zero.

PLC5 Read Commands

Read commands transfer data to the PLC5 processor from the gateway. The following diagram shows an example rung that executes a read command.

ProSoft Technology, Inc. Page 81 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

1 In the MSG object, click SETUP SCREEN in the MSG object to complete the

configuration of the MSG instruction. This displays the following dialog box.

2 Select the COMMUNICATION COMMAND to execute from the following list of

supported commands.

o PLC5 Type Read o PLC2 Unprotected Read o PLC5 Typed Read to PLC o PLC Typed Logical Read

3 Set the TARGET DEVICE DATA TABLE ADDRESS to a valid file element (such

as, N11:0) for SLC and PLC5 messages. For the PLC2 Unprotected Read message, set the address to the database index (such as, 1000) for the command.

4 Set the MULTIHOP option to YES. 5 Complete the MULTIHOP tab portion of the dialog box as shown in the

following image.

6 Set the TO ADDRESS value to the gateway’s Ethernet IP address. 7 Press the INS key to add the second line for ControlLogix Backplane and set

the slot number to zero.

Page 82 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Code

Description

Control

Preset

Accumulated

Code

Description

Control

Length

Position

Code

Description

Control

SP 4 Kp

Ki 8 Kd

Code

Description

Control

RLEN

DLEN

Data file #

Element #

Rack/Grp/Slot

User Manual

PLC-5 Sub-Element Fields

This section contains information specific to the PLC-5 processor when using the PCCC command set. The commands specific to the PLC-5 processor contain a sub-element code field. This field selects a sub-element field in a complex data table. For example, to obtain the current accumulated value for a counter or timer, set the sub-element field to 2. The following tables show the sub-element codes for PLC-5 complex data tables.

Timer / Counter

Control

All PD values are floating point values, they are two words long.

ProSoft Technology, Inc. Page 83 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Code

Description

Control

Error

RLEN

DLEN

User Manual

5.4.3 ControlLogix and CompactLogix Processor Specifics

Messaging from a ControlLogix or CompactLogix Processor

Use the MSG instruction to exchange data between a Control/CompactLogix processor and the gateway. There are two basic methods of data transfer supported by the gateway when using the MSG instruction: encapsulated PCCC messages and CIP Data Table messages. You can use either method.

Encapsulated PCCC Messages

This section contains information specific to the Control/CompactLogix processor when using the PCCC command set. The current implementation of the PCCC command set does not use functions that can directly access the Controller Tag Database. In order to access this database, you must use the table-mapping feature in RSLogix 5000. RSLogix 5000 permits assigning Controller Tag Arrays to virtual PLC 5 data tables. The PLX3x gateway using the PLC 5 command set defined in this document can then access this controller data.

PLC5 and SLC5/05 processors containing an Ethernet interface use the encapsulated PCCC message method. The gateway simulates these devices and accepts both read and write commands.

Encapsulated PCCC Write Message

Write commands transfer data from the processor to the gateway. The gateway supports the following encapsulated PCCC commands:

 PLC2 Unprotected Write  PLC5 Typed Write  PLC5 Word Range Write  PLC Typed Write

Page 84 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

The following diagram shows an example rung that executes a write command.

1 In the Message Configuration dialog box, define the data set to be transferred

from the processor to the gateway as shown in the following image.

2 Complete the dialog box for the data area to be transferred.

o For PLC5 and SLC messages, set the DESTINATION ELEMENT to an

element in a data file (such as, N10:0).

o For the PLC2 Unprotected Write message, set the DESTINATION ELEMENT

to the address in the gateway’s internal database. This cannot be set to a

value less than ten. This is not a limitation of the gateway but of the RSLogix software.

o For a PLC2 Unprotected Write or Read function, enter the database

address in octal format.

ProSoft Technology, Inc. Page 85 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

3 Click the COMMUNICATION tab and complete the communication information

as shown in the following image.

4 Make sure you select CIP as the COMMUNICATION METHOD. The PATH

specifies the message route from the processor to the EIP gateway. Path elements are separated by commas. In the example path shown:

o The first element is "Enet", which is the user-defined name given to the

1756-ENET gateway in the chassis (you can substitute the slot number of the ENET gateway for the name)

o The second element, "2", represents the Ethernet port on the 1756-ENET

gateway.

o The last element of the path, "192.168.0.75" is the IP address of the

gateway, which is the target for the message.

More complex paths are possible if routing to other networks using multiple 1756ENET gateways and racks. Refer to the ProSoft Technology Technical Support Knowledgebase for more information on Ethernet routing and path definitions (www.prosoft-technology.com/support).

Page 86 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

Encapsulated PCCC Read Message

Read commands transfer data from the gateway to a processor. The gateway supports the encapsulated PCCC commands:

 PLC2 Unprotected Read  PLC5 Typed Read  PLC5 Word Range Read  PLC Typed Read

The following diagram shows an example rung that executes a read command.

1 In the Message Configuration dialog box, define the data set to be transferred

from the processor to the gateway as shown in the following image.

2 Complete the dialog box for the data area to be transferred.

o For PLC5 and SLC messages, set the SOURCE ELEMENT to an element in

a data file (such as, N10:0).

o For the PLC2 Unprotected Read message, set the SOURCE ELEMENT to

the address in the gateway’s internal database. This cannot be set to a value less than ten. This is not a limitation of the gateway but of the RSLogix software.

ProSoft Technology, Inc. Page 87 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

3 Click the COMMUNICATION tab and complete the communication information

as shown in the following image.

4 Make sure you select CIP as the COMMUNICATION METHOD. The PATH

specifies the message route from the processor to the EIP gateway. Path elements are separated by commas. In the example path shown:

o The first element is "Enet", which is the user-defined name given to the

1756-ENET gateway in the chassis (you can substitute the slot number of the ENET gateway for the name)

o The second element, "2", represents the Ethernet port on the 1756-ENET

gateway.

o The last element of the path, "192.168.0.75" is the IP address of the

gateway, and the target for the message.

Page 88 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

CIP Data Table Operations

You can use CIP messages to transfer data between the ControlLogix or CompactLogix processor and the gateway. Tag names define the elements to be transferred. The gateway supports both read and write operations.

CIP Data Table Write

CIP data table write messages transfer data from the processor to the gateway. The following diagram shows an example rung that executes a write command.

1 In the Message Configuration dialog box, define the data set to be transferred

from the processor to the gateway as shown in the following image.

2 Complete the dialog box for the data area to be transferred. CIP Data Table

messages require a tag database element for both the source and

destination.

o The SOURCE TAG is a tag defined in the Controller Tag database. o The DESTINATION ELEMENT is the tag element in the gateway. o The gateway simulates a tag database as an array of elements defined by

the maximum register size for the gateway with the tag name INT_DATA (with the maximum value of int_data[3999]).

ProSoft Technology, Inc. Page 89 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

3 In the previous example, the first element in the database is the starting

location for the write operation of ten elements. Click the COMMUNICATION tab and complete the communication information as shown in the following image.

4 Make sure you select CIP as the COMMUNICATION METHOD. The PATH

specifies the message route from the processor to the EIP gateway. Path elements are separated by commas. In the example path shown:

o The first element is "Enet", which is the user-defined name given to the

1756-ENET gateway in the chassis (you can substitute the slot number of the ENET gateway for the name)

o The second element, "2", represents the Ethernet port on the 1756-ENET

gateway.

o The last element of the path, "192.168.0.75" is the IP address of the

gateway, which is the target for the message.

Page 90 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol User Manual

CIP Data Table Read

CIP data table read messages transfer data to the processor from the gateway. The following diagram shows an example rung that executes a read command.

1 In the Message Configuration dialog box, define the data set to be transferred

from the processor to the gateway as shown in the following image.

2 Complete the dialog box for the data area to be transferred. CIP Data Table

messages require a tag database element for both the source and

destination.

o The DESTINATION TAG is a tag defined in the Controller Tag database. o The SOURCE ELEMENT is the tag element in the gateway. o The gateway simulates a tag database as an array of elements defined by

the maximum register size for the gateway (user configuration parameter "Maximum Register" in the [Gateway] section) with the tag name

INT_DATA.

ProSoft Technology, Inc. Page 91 of 215 January 25, 2018

EIP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

3 In the previous example, the first element in the database is the starting

location for the read operation of ten elements. Click the COMMUNICATION tab and complete the communication information as shown in the following image.

4 Make sure you select CIP as the COMMUNICATION METHOD. The PATH

specifies the message route from the processor to the EIP gateway. Path elements are separated by commas. In the example path shown:

o The first element is "Enet", which is the user-defined name given to the

1756-ENET gateway in the chassis (you can substitute the slot number of the ENET gateway for the name)

o The second element, "2", represents the Ethernet port on the 1756-ENET

gateway.

o The last element of the path, "192.168.0.75" is the IP address of the

gateway, which is the target for the message.

Page 92 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways EIP Protocol

Gateway Information Data

Device Information Data

Column #

1 2 3 4 5 6 7 8 9

Function Code

Enable Code

Internal Address

Poll Interval Time

Count

Swap Code

IP Address

Slot Number

Function Code

Function Parameters

User Manual

5.4.4 EIP Command Entry Form

Use the following form to design the application’s command list.

IP Address = IP address of processor to reach Slot Number = -1 for PLC5 & SLC, processor slot number of ControlLogix

ProSoft Technology, Inc. Page 93 of 215 January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways User Manual

Page 94 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways MBTCP Protocol

In This Chapter

 MBTCP Functional Overview ................................................................ 95

 MBTCP Configuration ......................................................................... 101

 Network Diagnostics ............................................................................ 108

 MBTCP Reference .............................................................................. 112

User Manual

6 MBTCP Protocol

6.1 MBTCP Functional Overview

You can use the PLX3x gateway Modbus TCP/IP (MBTCP) protocol to interface many different protocols into the Schneider Electric Quantum family of processors as well other devices supporting the protocol. The MBTCP protocol supports both client and server connections.

The gateway supports a client connection on the TCP/IP network to interface with processors (and other server based devices) using a command list of up to 100 entries that you specify. The gateway stores the write commands for remote processors in the gateway's lower memory. This is also where the gateway stores data from read commands from other devices. See MBTCP Internal Database (page 97) for more information.

Data in the lower memory of the gateway’s internal database is accessible for

read and write operations by any node on the network supporting the MBAP (Service Port 502) or MBTCP (Service Ports 2000/2001) TCP/IP protocols. The MBAP protocol (Port 502) is a standard implementation defined by Schneider Electric and used on their Quantum processor. This open protocol is a modified version of the Modbus serial protocol. The MBTCP protocol is an embedded Modbus protocol message in a TCP/IP packet. The gateway supports up to five active server connections on Service Ports 502, five additional active server connections on Service Port 2000, and one active client connection.

The following illustration shows the functionality of the Modbus TCP/IP protocol.

ProSoft Technology, Inc. Page 95 of 215 January 25, 2018

MBTCP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

6.1.1 MBTCP General Specifications

The Modbus TCP/IP protocol allows multiple independent, concurrent Ethernet connections. The connections may be all clients, all servers, or a combination of both client and server connections.

 10/100 MB Ethernet Communication port  Supports Enron version of Modbus protocol for floating-point data

transactions

 Configurable parameters for the client including a minimum response delay of

0 to 65535 ms and floating-point support

 Supports five independent server connections for Service Port 502  Supports five independent server connections for Service Port 2000  All data mapping begins at Modbus register 400001, protocol base 0.  Error codes, network error counters, and port status data available in user

data memory

Modbus TCP/IP Client

 Actively reads data from and writes data to Modbus TCP/IP devices using

MBAP

 Up to 10 client connections with multiple commands to talk to multiple servers

Modbus TCP/IP Server

 The server driver accepts incoming connections on Service Port 502 for

clients using Modbus TCP/IP MBAP messages and connections on Service Port 2000 (or other Service Ports) for clients using Encapsulated Modbus messages.

 Supports multiple independent server connections for any combination of

Service Port 502 (MBAP) and Service Port 2000 (Encapsulated)

 Up to 20 servers are supported

Page 96 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways MBTCP Protocol

Parameter

Description

Modbus Commands Supported

(client and server)

1: Read Coil Status 2: Read Input Status 3: Read Holding Registers 4: Read Input Registers 5: Force (Write) Single Coil 6: Preset (Write) Single Holding

15: Force (Write) Multiple Coils 16: Preset (Write) Multiple Holding Registers 22: Mask Write Holding Register (Slave Only) 23: Read/Write Holding Registers (Slave

Only)

Configurable Parameters:

(client and server)

 Gateway IP Address  PLC Read Start Register (%MW)  PLC Write Start Register (%MW)  Number of MBAP and MBTCP servers  Gateway Modbus Read Start Address  Gateway Modbus Write Start Address

Configurable Parameters:

(client only)

 Minimum Command Delay  Response Timeout  Retry Count  Command Error Pointer

Command List

Up to 160 Modbus commands (one tag per command)

Status Data

 Error codes reported individually for each command.  High-level status data available from Modbus TCP/IP client (for example

PLC)

Command List Polling

Each command can be individually enabled or disabled; write-only-on-datachange is available

User Manual

6.1.2 MBTCP Internal Database

 Upper memory for the module status data area. This is where the module

writes internal status data for the protocols supported by the module.

ProSoft Technology, Inc. Page 97 of 215 January 25, 2018

MBTCP Protocol PLX3x Series ♦ Multi-Protocol Gateways User Manual

 Lower memory for the user data area. This is where incoming data from

external devices is stored and accessed.

Either protocol in the PLX3x gateway can write data to and read data from the user data area.

 If the module is acting as a client/master, you create commands to read data

from external client/server devices and store the data in a specific location in the user data area.

 If the module is acting as a server/slave, the external client/master devices

write data to a specific location in the user data area.

Page 98 of 215 ProSoft Technology, Inc. January 25, 2018

PLX3x Series ♦ Multi-Protocol Gateways MBTCP Protocol User Manual

Modbus TCP/IP Client Access to Database

The client functionality exchanges data between the PLX3x gateway's internal database and data tables established in one or more Quantum processors or other server based devices. The command list that you define in ProSoft Configuration Builder specifies what data is to be transferred between the gateway and each of the servers on the network. No ladder logic is required in the processor (server) for client functionality, except to ensure that sufficient data memory exists.

The following illustration describes the flow of data between the Ethernet clients and the internal database.

Multiple Server Access to Database

The MBTCP gateway provides server functionality using reserved Service Port 502 for Modbus TCP/IP MBAP messages, as well as Service Ports 2000 and 2001 to support the TCP/IP Encapsulated Modbus version of the protocol used by several HMI manufacturers. Server support in the gateway permits client applications (for example: HMI software, Quantum processors, etc) to read from

and write to the gateway’s database. This section discusses the requirements for

attaching to the gateway using client applications. The server driver supports multiple concurrent connections from several clients.

Up to five clients can simultaneously connect on Service Port 502 and five more can simultaneously connect on Service Port 2000. The MBTCP protocol uses Service Port 2001 to pass Encapsulated Modbus commands through from the Ethernet port to the gateway’s serial port.

ProSoft Technology, Inc. Page 99 of 215 January 25, 2018

MBTCP Protocol PLX3x Series ♦ Multi-Protocol Gateways

Database Address

Modbus Address

40001

1000

41001

2000

42001

3000

43001

3999

44000

Database Address

Modbus Address

4000

44001

5000

45001

6000

46001

7000

47001

8000

48001

9000

49001

9999

50000

User Manual

When configured as a server, the gateway uses its internal database as the source for read requests and the destination for write requests from remote clients. Access to the database is controlled by the command type received in the incoming message from the client. The following table specifies the relationship of the gateway’s internal database to the addresses required in the incoming Modbus TCP/IP requests.

The following virtual addresses are not part of the normal gateway user database and are not valid addresses for standard data. However, these addresses may be used for incoming commands that are requesting floating-point data.

To use addresses in this upper range requires that you configure the following parameters in Prosoft Configuration Builder (PCB):

 Set the Float Flag in the MBTCP server configuration to YES  Set the Float Start to a database address in the range below  Set the Float Offset to a database address in the gateway user memory area

shown above.

Remember that, once this is done, all data above the Float Start address must be floating-point data. See Configuring MBTCP Servers (page 101).

Page 100 of 215 ProSoft Technology, Inc. January 25, 2018

The gateway must be correctly configured and connected to the network before any attempt is made to use it. Use a network verification program, such as ProSoft Discovery Service or the command prompt PING instruction, to verify that other devices can find the gateway on the network. Use ProSoft Configuration Builder to confirm proper configuration of the gateway and to transfer the configuration files to and from the gateway.

ProSoft Technology PLX3x Series User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual