ProSoft TECHNOLOGY PLX32 Multi Protocol Gateway User Manual

: June 11, 2024
: ProSoft TECHNOLOGY

Table of Contents

PLX32 Multi Protocol Gateway
Product Information
Specifications
Product Usage Instructions
1. Start Here
1.1 Overview
1.2 System Requirements
1.3 Package Contents
1.4 Mounting the Gateway on a DIN-rail
1.5 Jumper Settings
1.6 SD Card
1.7 Connecting Power to the Unit
- Frequently Asked Questions (FAQ)
Q: How do I reset the Multi-Protocol Gateway to factory
Q: Can the PLX32-EIP-MBTCP-UA Gateway be used in hazardous

PLX32 Multi Protocol Gateway

Product Information

Specifications

Product Name: PLX32-EIP-MBTCP-UA Multi-Protocol Gateway
Manufacturer: ProSoft Technology, Inc.
Date of User Manual: October 27, 2023
Power Requirements: Class 2 Power
Agency Approvals and Certifications: Available on the
manufacturer’s website

Product Usage Instructions

1. Start Here

Before using the Multi-Protocol Gateway, follow the steps
outlined below:

1.1 Overview

Get familiar with the features and functions of the
PLX32-EIP-MBTCP-UA Multi-Protocol Gateway by referring to the user
manual.

1.2 System Requirements

Ensure that your system meets the necessary requirements
specified in the user manual for optimal performance.

1.3 Package Contents

Check the package contents to verify that all items are included
as listed in the user manual.

1.4 Mounting the Gateway on a DIN-rail

Follow the instructions provided in the user manual to correctly
mount the gateway on a DIN-rail for secure installation.

1.5 Jumper Settings

Adjust the jumper settings according to the user manual to
configure the gateway as required for your setup.

1.6 SD Card

If applicable, insert an SD card into the designated slot
following the guidelines provided in the user manual.

1.7 Connecting Power to the Unit

Connect the power supply to the unit as instructed in the user
manual to power up the Multi-Protocol Gateway.

Frequently Asked Questions (FAQ)

Q: How do I reset the Multi-Protocol Gateway to factory

settings?

A: To reset the gateway to factory settings, locate the reset
button on the device and hold it for 10 seconds until the unit
restarts.

Q: Can the PLX32-EIP-MBTCP-UA Gateway be used in hazardous

locations?

A: No, it is not recommended to use the gateway in hazardous
locations as per safety guidelines provided in the user manual.

PLX32-EIP-MBTCP-UA
Multi-Protocol Gateway

USER MANUAL

October 27, 2023

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Contents 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
PLX32-EIP-MBTCP-UA User Manual For Public Use.
October 27, 2023
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.

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.
Copyright © 2023 ProSoft Technology, Inc. All Rights Reserved.
For professional users in the European Union
If you wish to discard electrical and electronic equipment (EEE), please contact your dealer or supplier for further information.

Prop 65 Warning Cancer and Reproductive Harm www.P65Warnings.ca.gov

ProSoft Technology, Inc.

Page 2 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Contents User Manual

Open Source Information
Open Source Software used in the product
The product contains, among other things, Open Source Software files, as defined below, developed by third parties and licensed under an Open Source Software license. These Open Source Software files are protected by copyright. Your right to use the Open Source Software is governed by the relevant applicable Open Source Software license conditions. Your compliance with those license conditions will entitle you to use the Open Source Software as foreseen in the relevant license. In the event of conflicts between other ProSoft Technology, Inc. license conditions applicable to the product and the Open Source Software license conditions, the Open Source Software conditions shall prevail. The Open Source Software is provided royalty-free (i.e. no fees are charged for exercising the licensed rights). Open Source Software contained in this product and the respective Open Source Software licenses are stated in the module webpage, in the link Open Source. If Open Source Software contained in this product is licensed under GNU General Public License (GPL), GNU Lesser General Public License (LGPL), Mozilla Public License (MPL) or any other Open Source Software license, which requires that source code is to be made available and such source code is not already delivered together with the product, you can order the corresponding source code of the Open Source Software from ProSoft Technology, Inc. – against payment of the shipping and handling charges – for a period of at least 3 years since purchase of the product. Please send your specific request, within 3 years of the purchase date of this product, together with the name and serial number of the product found on the product label to:
ProSoft Technology, Inc. Director of Engineering 9201 Camino Media, Suite 200 Bakersfield, CA 93311 USA
Warranty regarding further use of the Open Source Software
ProSoft Technology, Inc. provides no warranty for the Open Source Software contained in this product, if such Open Source Software is used in any manner other than intended by ProSoft Technology, Inc. The licenses listed below define the warranty, if any, from the authors or licensors of the Open Source Software. ProSoft Technology, Inc. specifically disclaims any warranty for defects caused by altering any Open Source Software or the product’s configuration. Any warranty claims against ProSoft Technology, Inc. in the event that the Open Source Software contained in this product infringes the intellectual property rights of a third party are excluded. The following disclaimer applies to the GPL and LGPL components in relation to the rights holders: “This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU Lesser General Public License for more details.” For the remaining open source components, the liability exclusions of the rights holders in the respective license texts apply. Technical support, if any, will only be provided for unmodified software.

This information is also available in the Help > About menu of the ProSoft Configuration Builder (PCB) software.

ProSoft Technology, Inc.

Page 3 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Contents User Manual

Important Installation Instructions
Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 5014 (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.
Class 2 Power

Agency Approvals and Certifications
Please visit our website: www.prosoft-technology.com

ProSoft Technology, Inc.

Page 4 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Contents User Manual

Contents
Your Feedback Please………………………………………………………………………………………………………..2 How to Contact Us ……………………………………………………………………………………………………………..2 Content Disclaimer……………………………………………………………………………………………………………..2 Important Installation Instructions …………………………………………………………………………………………4 Agency Approvals and Certifications …………………………………………………………………………………….4

1 Start Here

1.1

Overview……………………………………………………………………………………………………. 8

1.2

System Requirements ………………………………………………………………………………….8

1.3

Package Contents ……………………………………………………………………………………….9

1.4

Mounting the Gateway on a DIN-rail ………………………………………………………………9

1.5

Jumper Settings ………………………………………………………………………………………..10

1.6

SD Card……………………………………………………………………………………………………11

1.7

Connecting Power to the Unit ……………………………………………………………………..12

1.8

Installing ProSoft Configuration Builder Software …………………………………………..13

2 Using ProSoft Configuration Builder

2.1 2.2 2.3 2.4 2.5
2.5.1 2.5.2 2.6 2.7 2.7.1 2.7.2 2.7.3 2.7.4 2.7.5 2.8 2.9

Connecting the PC to the Gateway ………………………………………………………………14 Setting a Temporary IP Address in the Gateway ……………………………………………14 Setting Up the Project ………………………………………………………………………………..17 Disabling Gateway Protocol Functionalities …………………………………………………..19 Configuring Gateway Parameters ………………………………………………………………..22 Renaming PCB Objects ……………………………………………………………………………..22 Printing a Configuration File ………………………………………………………………………..22 Configuring the Ethernet Port………………………………………………………………………23 Mapping Data in Module Memory ………………………………………………………………..24 From Address ……………………………………………………………………………………………25 To Address ……………………………………………………………………………………………….25 Register Count ………………………………………………………………………………………….25 Swap Code ……………………………………………………………………………………………….26 Delay Preset ……………………………………………………………………………………………..26 Downloading the Project to the PLX32 -EIP-MBTCP-UA …………………………………27 Uploading the Project from the Gateway ………………………………………………………29

3 Diagnostics and Troubleshooting

3.1 3.1.1 3.1.2
3.2 3.2.1 3.2.2 3.2.3
3.3 3.3.1 3.3.2

LED Indicators …………………………………………………………………………………………..31 Main Gateway LEDs…………………………………………………………………………………..32 Ethernet Port LEDs ……………………………………………………………………………………33 Using Diagnostics in ProSoft Configuration Builder ………………………………………..34 Diagnostics Menu ………………………………………………………………………………………36 Capturing a Diagnostic Session to a Log File ………………………………………………..37 Warm Boot / Cold Boot……………………………………………………………………………….37 Gateway Status Data in Upper Memory………………………………………………………..38 General Gateway Status Data in Upper Memory……………………………………………38 Protocol-Specific Status Data in Upper Memory…………………………………………….39

ProSoft Technology, Inc.

Page 5 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Contents User Manual

4 Hardware Information

4.1

Hardware Specifications……………………………………………………………………………..40

5 EIP Protocol

5.1 5.1.1 5.1.2
5.2 5.2.1 5.2.2 5.2.3
5.3 5.3.1 5.3.2 5.3.3
5.4 5.4.1 5.4.2 5.4.3

EIP Functional Overview …………………………………………………………………………….41 EtherNet/IP General Specifications………………………………………………………………42 EIP Internal Database ………………………………………………………………………………..43 EIP Configuration ………………………………………………………………………………………45 Configuring EIP Class 3 Server …………………………………………………………………..45 Configuring EIP Class 1 Connection …………………………………………………………….48 Configuring EIP Class 3 Client[x]/UClient Connection …………………………………….53 Network Diagnostics…………………………………………………………………………………..65 EIP PCB Diagnostics………………………………………………………………………………….65 EIP Status Data in Upper Memory ……………………………………………………………….66 EIP Error Codes ………………………………………………………………………………………..69 EIP Reference …………………………………………………………………………………………..72 SLC and MicroLogix Specifics …………………………………………………………………….72 PLC5 Processor Specifics…………………………………………………………………………..76 ControlLogix and CompactLogix Processor Specifics …………………………………….81

6 MBTCP Protocol

6.1 6.1.1 6.1.2
6.2 6.2.1 6.2.2 6.2.3
6.3 6.3.1 6.3.2 6.3.3
6.4 6.4.1

MBTCP Functional Overview ………………………………………………………………………90 MBTCP General Specifications……………………………………………………………………91 MBTCP Internal Database ………………………………………………………………………….92 MBTCP Configuration ………………………………………………………………………………..95 Configuring MBTCP Servers ……………………………………………………………………….95 Configuring MBTCP Client [x] ……………………………………………………………………..97 Configuring MBTCP Client [x] Commands…………………………………………………….99 Network Diagnostics…………………………………………………………………………………102 MBTCP PCB Diagnostics………………………………………………………………………….102 MBTCP Status Data in Upper Memory ……………………………………………………….102 MBTCP Error Codes ………………………………………………………………………………..105 MBTCP Reference …………………………………………………………………………………..106 About the Modbus Protocol ……………………………………………………………………….106

7 OPC UA Server

108

7.1 7.1.1 7.1.2 7.1.3
7.2 7.2.1 7.2.2 7.2.3 7.2.4 7.2.5 7.2.6
7.3 7.4 7.5

UA Server Configuration Manager Software………………………………………………..108 Installation ………………………………………………………………………………………………108 NTP Server Time Synchronization ……………………………………………………………..109 Launching PSW- UACM…………………………………………………………………………….110 Certificates ……………………………………………………………………………………………..112 Security Policy …………………………………………………………………………………………112 Creating a Provisioning Application Instance Certificate ……………………………….113 Creating a CA Certificate…………………………………………………………………………..115 Creating an Application Instance Certificate ………………………………………………..117 Refreshing the Status Tab…………………………………………………………………………118 Creating and Signing a New Certificate ………………………………………………………123 Importing a Certificate Public Key File ………………………………………………………..127 Exporting the CA Certificate to the OPC Client…………………………………………….130 Revocation List ………………………………………………………………………………………..131

ProSoft Technology, Inc.

Page 6 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Contents User Manual

7.6 7.7
7.7.1 7.7.2 7.8 7.9 7.10 7.11 7.11.1 7.11.2 7.12 7.12.1 7.12.2 7.12.3 7.12.4 7.12.5 7.12.6

Downloading the UA Server Configuration to the Gateway ……………………………132 User Access Control…………………………………………………………………………………135 Adding a User………………………………………………………………………………………….135 Adding a User to a Group………………………………………………………………………….137 Creating Tags ………………………………………………………………………………………….140 Advanced Tab …………………………………………………………………………………………144 Saving the UA Server Configuration …………………………………………………………..147 UA Client Connectivity………………………………………………………………………………148 Data Map Example…………………………………………………………………………………..148 UA Client Setup……………………………………………………………………………………….152 Troubleshooting and Maintenance of OPC UA Server ………………………………….153 Status Tab ………………………………………………………………………………………………153 Communication Errors Log………………………………………………………………………..153 PCB Module Diagnostics…………………………………………………………………………..153 Reset of State Back to “Waiting to be provisioned” ………………………………………153 Backup of PSW-UACM Configuration Database ………………………………………….154 Moving the PSW-UACM Installation to a Different Machine …………………………..154

8 Support, Service & Warranty

155

8.1

Contacting Technical Support ……………………………………………………………………155

8.2

Warranty Information………………………………………………………………………………..155

ProSoft Technology, Inc.

Page 7 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Start Here 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 gateway, and safely connect devices to
a power source and to the PLX32-EIP-MBTCP-UA ports
1.1 Overview
This document explains the features of the PLX32-EIP-MBTCP-UA. 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 PLX32-EIP-MBTCP-UA is a stand-alone DIN-rail mounted unit that provides two Ethernet ports for communications, remote configuration, and diagnostics. The gateway 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.
1.2 System Requirements
The ProSoft Configuration Builder configuration software for the PLX32-EIP- MBTCP-UA requires the following minimum system components: · Windows 7 Professional (32-bit version), 8 GB RAM Intel® CoreTM i5 650 (3.20 GHz) · Windows XP Professional Ver.2002 Service Pack 2, 512 MB RAM Pentium 4 (2.66
GHz) · Windows 2000 Ver.5.00.2195 Service Pack 2 512 MB RAM Pentium III (550 MHz)
Note: To use PCB under the Windows 7 OS, you must be sure to install PCB using the “Run as Administrator” option. To find this option, right-click on the Setup.exe installer program icon. In the context menu, you will see the “Run as Administrator” option. Left-click to use this install option. Be aware, 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 will allow the PCB installer to create folders and files on your PC with proper permissions and security. If you do not use the “Run as Administrator” option, PCB may appear to install correctly; but you will receive numerous, repeating file access errors whenever PCB is running, especially when changing configuration screens. If this happens, to eliminate the errors, you will have to completely uninstall PCB and then re-install using the “Run as Administrator” option.

ProSoft Technology, Inc.

Page 8 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Start Here User Manual

1.3 Package Contents
The following components are included with the PLX32-EIP-MBTCP-UA, and are all required for installation and configuration.

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

Qty. Part Name

Mini screwdriver

Power connector

Jumper

Part Number HRD250 J180 J809

Part Description Tool for wiring and securing the power connector PLX32-EIP- MBTCP-UA power connector Spare jumper for resetting OPC UA configuration

1.4 Mounting the Gateway on a DIN-rail
To mount the PLX32-EIP-MBTCP-UA 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 gateway 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 9 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway
1.5 Jumper Settings There are three pairs of jumper pins located on the back of the gateway.

Start Here User Manual

· 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, an error message occurs indicating that these functions are unavailable. o This jumper also disables access to the PLX32-EIP-MBTCP-UA web page making it impossible to upgrade the firmware.
Attention: Simultaneously setting jumper MODE 1 and MODE 3 will restore the OPC UA configuration to factory defaults.

ProSoft Technology, Inc.

Page 10 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Start Here User Manual

1.6 SD Card
You can order a PLX32-EIP-MBTCP-UA with an optional SD card (Part Number SDI- 1G). In the event of a gateway failure, you can move the SD card from one gateway to the next and resume operation.
In general, if the SD card is present when you power up or reboot the gateway, the gateway uses the configuration on the SC card.

With an SD Card
· The ProSoft Configuration Builder downloads the configuration to the SD Card in the gateway.
· The gateway does not transfer the configuration data from the SD card to internal memory. If you remove the SD card and reboot to the gateway, the gateway loads the configuration data from the gateway’s memory. If there is no configuration data in the gateway’s memory, the gateway uses the factory default configuration.

Without an SD Card
· The ProSoft Configuration Builder downloads the configuration to the internal memory of the gateway. The gateway uses the configuration from internal memory.
· If you insert a blank SD Card into the gateway after the gateway has been configured, the gateway does not use the configuration on the SD card unless you reboot the gateway. If you want to copy the configuration to the SD card, you must download the configuration to the gateway while the SD card is in the gateway.

ProSoft Technology, Inc.

Page 11 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway 1.7 Connecting Power to the Unit

Start Here User Manual

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 12 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Start Here 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.
To ensure a successful installation of ProSoft OPC UA Configuration Manager, a reboot may be required prior to starting the installation. In several test systems, Windows Update Service had to be stopped prior to installation. Once the installation completes, you can restart the Windows Update service.
Stop Windows Update service 1. Click the Windows Start button and enter the following: services.msc 2. Scroll down and right-click on Windows Update, and choose STOP.
Perform the ProSoft OPC UA Configuration Manager setup procedures. Once the setup completes, perform the steps above and choose Start for the last step.

ProSoft Technology, Inc.

Page 13 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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 allows you to import information from previously installed (known working) configurations to new projects.

2.1 Connecting the PC to the Gateway
With the gateway 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 gateway.

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.
1 To open PDS, right-click on the PLX32-EIP-MBTCP-UA icon in PCB and click on DIAGNOSTICS.

ProSoft Technology, Inc.

Page 14 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

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

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 15 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

5 Right-click on the gateway, and then select ASSIGN TEMPORARY IP.

6 The gateway’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 22) to set the permanent IP address in the
gateway.

ProSoft Technology, Inc.

Page 16 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

2.3 Setting Up the Project
If you have used other Windows configuration tools before, you will find the screen layout familiar. The ProSoft Configuration Builder 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.

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.

ProSoft Technology, Inc.

Page 17 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

2 In the Product Line Filter area of the dialog box, select the PLX30 radio button.

3 In the STEP 1: Select Module Type dropdown list, select PLX32-EIP-MBTCP-UA. 4 You can disable one or more drivers on the gateway if you do not need them. See
Disabling Gateway Ports (page 19). 5 Click OK to save your settings and return to the PCB Main window.

ProSoft Technology, Inc.

Page 18 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

2.4 Disabling Gateway Protocol Functionalities
ProSoft Configuration Builder (PCB) gives you the option to disable one or more driver functionalities if you do not need them. Disabling driver functionalities can simplify the number of configuration options, making it easier to set up the gateway.
It is easiest to disable driver functionalities when you add the gateway to the project in PCB; however, you can enable and disable them after you have added it to the project. Both methods are described in this topic.

Note: Disabling driver functionalities does not affect the performance of the gateway, and is not required.

To disable driver functionalities when you add it to the project
The best time to disable one or more driver functionalities on the gateway is when you add the gateway to the project in PCB. You can disable them 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.

ProSoft Technology, Inc.

Page 19 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

There are three driver functionalities disabled. Please note the following:
· Drivers that you can disable have UNCHECK IF NOT USED in the ACTION REQUIRED column.
· Click the driver name to disable the functionality. When disabled, a red circle replaces the green checkmark.
· If there are multiple drivers of the same type, only the last one has the UnCheck if not Used message. You can disable and enable only in reverse order.
· Finally, if you want to enable a disabled functionality in this dialog box, click the driver functionality name again.

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

ProSoft Technology, Inc.

Page 20 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

To disable or enable functionalities on the gateway after you add it to the project
1 Right-click the PLX32-EIP-MBTCP-UA icon 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 drivers are enabled by default, and that the driver state in the Choose Module Type dialog box DOES NOT MATCH THE ACTUAL STATE OF THE DRIVERS. If you want any disabled drivers 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 driver functionality name to change its status from Enabled to Disabled, or vice-versa. The same rules noted above still apply.
3 When you click OK, PCB updates the gateway in the tree view, showing the configuration options for the enabled functionalities, and hiding the disabled functionalities.

ProSoft Technology, Inc.

Page 21 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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 options.

icon to view gateway information and configuration

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 PLX32-EIP-MBTCP-UA 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.

ProSoft Technology, Inc.

Page 22 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

2.6 Configuring the Ethernet Port This section shows how to set the Ethernet port parameters for the PLX32-EIP-MBTCPUA.
To configure the Ethernet port in PCB
1 In the ProSoft Configuration Builder tree view, double-click on the Ethernet Configuration icon.

2 Click any parameter in the Edit – WATTCP dialog box to change the value. Since the gateway has two Ethernet ports, there are separate configuration options for each port.

Parameter IP Address Netmask Gateway

Description Unique IP address assigned to the gateway Subnet mask of gateway Gateway (if used)

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

ProSoft Technology, Inc.

Page 23 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

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.

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.

ProSoft Technology, Inc.

Page 24 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway 4 Click EDIT ROW to edit the parameters for the mapping.

Using ProSoft Configuration Builder User Manual

5 To change the value of a parameter, click the parameter and enter a new value. Click OK when finished.
6 Repeat the above steps to add more memory mappings.
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 9999 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.

ProSoft Technology, Inc.

Page 25 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

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.

Swap Code No Swap

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

Word Swap

The words are swapped (1234 = 3412)

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

Swap

Bytes

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

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.
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.

ProSoft Technology, Inc.

Page 26 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder User Manual

2.8 Downloading the Project to the PLX32-EIP-MBTCP-UA

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

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

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 PLX32 -EIP-MBTCPUA 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.

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.
Note: The steps above only downloads or modifies the OPC UA server’s IP address and name, it does not download or modify the OPC UA configuration.

ProSoft Technology, Inc.

Page 27 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder 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 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.

ProSoft Technology, Inc.

Page 28 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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 14).

You can upload the project settings from the PLX32-EIP-MBTCP-UA into the current project in ProSoft Configuration Builder on your PC.
1 In the tree view in ProSoft Configuration Builder, right-click the PLX32 -EIP-MBTCPUA 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.

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.
Note: The steps above only uploads or modifies the OPC UA server’s IP address and name, it does not upload or modify the OPC UA configuration.

ProSoft Technology, Inc.

Page 29 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Using ProSoft Configuration Builder 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.

ProSoft Technology, Inc.

Page 30 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

3 Diagnostics and Troubleshooting
You can troubleshoot the gateway 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 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

3.1.1 Main Gateway LEDs This table describes the gateway front panel LEDs.

LED PWR (Power)
FLT (Fault)
CFG (Configuration)
ERR (Error)
NS (Network Status) for EIP protocol only
MS (Module Status) for EIP protocol only

State Off
Solid Green Off Solid Red
Off Solid Amber
Off FlashingAmber
Solid Amber
Off Solid Red Solid Green Flashing Red Flashing Green Alternating Red and Green Flash Off Solid Red Solid Green Flashing Red Flashing Green Alternating Red and Green Flash

Description
Power is not connected to the power terminals or source is insufficient to properly power the gateway (208 mA at 24 VDC is required).
Power is connected to the power terminals.
Normal operation.
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.
Normal operation.
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.
Normal operation.
An error condition has been detected and is occurring on one of the application ports. Check configuration and troubleshoot for communication errors.
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).
No power or no IP address
Duplicate IP address
Connected
Connection timeout
IP address obtained; no established connections
Self-test
No power
Major fault
Device operational
Minor fault
Standby
Self-test

ProSoft Technology, Inc.

Page 32 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

3.1.2 Ethernet Port LEDs This table describes the gateway Ethernet port LEDs.

LED LINK/ACT
100 Mbit

State Off
Solid Green
Off Flashing Amber

Description
No physical network connection is detected. No Ethernet communication is possible. Check wiring and cables.
Physical network connection detected. This LED must be ON solid for Ethernet communication to be possible.
No activity on the port.
The Ethernet port is actively transmitting or receiving data.

ProSoft Technology, Inc.

Page 33 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

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.

To connect to the gateway’s communication port.
1 In PCB, right-click the gateway name and choose DIAGNOSTICS.

2 This opens the Diagnostics window.

ProSoft Technology, Inc.

Page 34 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

If there is no response from the gateway, as in the example above, follow these steps: 1 From the toolbar, click the SETUP CONNECTION button.

2 In the Connection Setup dialog box, select ETHERNET from the SELECT CONNECTION TYPE list.
3 Type in the gateway’s IP address in the ETHERNET field. 4 Click CONNECT.
5 Verify that the Ethernet is connected properly between your computer’s communication port and the gateway.
6 If you are still not able to establish a connection, contact ProSoft Technology Technical Support for assistance.

ProSoft Technology, Inc.

Page 35 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

3.2.1 Diagnostics Menu
The Diagnostics menu is arranged as a tree structure in the left side of the Diagnostics window.

Caution: Some commands in 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 shown below:

Menu Command Module
Database View

Submenu Command Version
Data Map ASCII
Decimal
Hex
Float

Description
Displays the gateway’s current software version and other important values. You may be asked to provide this information when calling for technical support.
Displays the gateway’s Data Map configuration. Displays the contents of the gateway’s database in ASCII character format.
Displays the contents of the gateway’s database in decimal number format.
Displays the contents of the gateway’s database in hexadecimal number format. Displays the contents of the gateway’s database in floating-point number format.

*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.

ProSoft Technology, Inc.

Page 36 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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, 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.

3.2.3 Warm Boot / Cold Boot
Warm and Cold booting the PLX32-EIP-MBTCP-UA can be done by clicking MODULE > GENERAL > WARM BOOT or COLD BOOT.

ProSoft Technology, Inc.

Page 37 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting 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 9999). Remote devices, such as HMIs or processors can then access the status data. See Mapping Data in Module Memory (page 23).

3.3.1 General Gateway Status Data in Upper Memory The following table describes the contents of the gateway’s general status data area.

Description Program Cycle Counter Product Code (ASCII) Product Revision (ASCII) Operating System Revision (ASCII) OS Run Number (ASCII)

ProSoft Technology, Inc.

Page 38 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

Diagnostics and Troubleshooting User Manual

3.3.2 Protocol-Specific Status Data in Upper Memory
The PLX32-EIP-MBTCP-UA 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 66) · MBTCP Status Data in Upper Memory (page 102)

ProSoft Technology, Inc.

Page 39 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway
4 Hardware Information

Hardware Information User Manual

4.1 Hardware Specifications

Specification Power Supply

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

Current Load

24 VDC nominal @ 300 mA 10 to 36 VDC @ 610 mA 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

Configuration (CFG) and Error (ERR) Communication Status Power (PWR) and Hardware Fault (FLT) Network Status (NS) EtherNet/IPTM 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

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

Shipped With Each Unit

2.5 mm screwdriver J180 Power Connector

ProSoft Technology, Inc.

Page 40 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway
5 EIP Protocol

EIP Protocol User Manual

5.1 EIP Functional Overview
You can use the PLX32-EIP-MBTCP-UA to interface many different protocols into the Rockwell Automation family of processors, or other software-based solutions. The following illustration shows the functionality of the EtherNet/IP protocol.

ProSoft Technology, Inc.

Page 41 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

5.1.1 EtherNet/IP General Specifications

The EIP driver supports the following connections:

Class Class 1 Class 3

Connection Type I/O Connected Client Unconnected Client

Number of Connections 2 2 1

Server

EIP Protocol User Manual

Specification Supported PLC Types Supported Message Types I/O connection sizes in/out Max RPI time CIP Services Supported
Command List
Command Sets

Description
PLC2, PLC5, SLC, CLX, CMPLX, MICROLX
PCCC and CIP
496/496 bytes
5 ms per connection
0x4C: CIP Data Table Read 0x4D: CIP Data Table Write CIP Generic
Supports up to 100 commands per client. Each command is configurable for command type, IP address, register to/from address, and word/bit count.
PLC-2/PLC-3/PLC5 Basic Command Set PLC5 Binary Command Set PLC5 ASCII Command Set SLC500 Command Set

ProSoft Technology, Inc.

Page 42 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

5.1.2 EIP Internal Database
The internal database is central to the functionality of the PLX32-EIP-MBTCP- UA. 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 protocol.
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 gateway status data area. This is where the gateway writes internal status data for the protocols supported by the gateway.
· Lower memory for the user data area. This is where incoming data from external devices is stored and accessed.

Each protocol in the PLX32-EIP-MBTCP-UA can write data to and read data from the user data area.
Note: If you want to access gateway status data in the upper memory, you can use the data mapping feature in the gateway to copy data from the gateway status data area to the user data area. See Mapping Data in Module Memory (page 23). Otherwise, you can use the diagnostic functions in ProSoft Configuration Builder to view gateway status data. For more information on the gateway status data, see Network Diagnostics (page 65).

ProSoft Technology, Inc.

Page 43 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

EIP Client Access to Database
The client functionality exchanges data between the gateway’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.
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.

ProSoft Technology, Inc.

Page 44 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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 gateway’s memory:

Data Type
BOOL Bit Array SINT INT DINT REAL

Tag Name
BOOLData[ ] BITAData[ ] SINTData[ ] INT_Data[ ] DINTData[ ] REALData[ ]

Length of Each Element in CIP Message 1 4 1 2 4 4

Array Range for 10,000 Element Database 0 to 159999 0 to 4999 0 to 19999 0 to 9999 0 to 4999 0 to 4999

ProSoft Technology, Inc.

Page 45 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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:

Database

CIP

CIP Boolean

Integer

Address

Int_data BoolData[0] [0]

999

Int_data BoolData[15984] [999]

1000 1999

Int_data BoolData[16000] [1000] Int_data BoolData[31984] [1999]

2000 2999

Int_data BoolData[32000] [2000] Int_data BoolData[47984] [2999]

3000 3999

Int_data BoolData[48000] [3000] Int_data [3999] BoolData[63999]

CIP Bit Array CIP Byte

BitAData[0]

SIntData[0]

SIntData[1998] BitAData[500] SIntData[2000]

SIntData[3998] BitAData[1000] SIntData[4000]

SIntData[5998] BitAData[1500] SIntData[6000]

SIntData[9998]

CIP DINT

CIP Real

DIntData[0]

RealData [0]

DIntData[500] RealData [500]

DIntData[1000] RealData [1000]

DIntData[1500] RealData [1500]

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:

Database Address 0 999 1000 1999 2000

File size 100 N10:0 N19:99 N20:0 N29:99 N30:0

Database Address 0 999 1000 1999 2000

File size 100 N10:0 N19:99 N20:0 N29:99 N30:0

ProSoft Technology, Inc.

Page 46 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway
EtherNet/IP Explicit Messaging Server Command Support The PLX32-EIP-MBTCP-UA supports several command sets.

EIP Protocol User Manual

Basic Command Set Functions

Command 0x00 0x01 0x02 0x05 0x08

Function N/A N/A N/A N/A N/A

Definition Protected Write Unprotected Read Protected Bit Write Unprotected Bit Write Unprotected Write

Supported in Server X X X X X

PLC-5 Command Set Functions

Command 0x0F 0x0F

Function 0x00 0x01

Definition Word Range Write (Binary Address) 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 0x0F 0x0F

0x00 0x01 0x26

Word Range Write (ASCII Address) Word Range Read (ASCII Address) Read-Modify- Write (ASCII Address)

Supported in Server X X X X
X X

SLC-500 Command Set Functions

Command 0x0F 0x0F 0x0F 0x0F 0x0F

Function 0xA1 0xA2 0xA9 0xAA 0xAB

Definition

Supported in Server

Protected Typed Logical Read With Two

Address Fields

Protected Typed Logical Read With Three X

Address Fields

Protected Typed Logical Write With Two

Address Fields

Protected Typed Logical Write With Three

Address Fields

Protected Typed Logical Write With Mask (Three Address Fields)

ProSoft Technology, Inc.

Page 47 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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 PLX32-EIP-MBTCP-UA 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 PLX32-EIP-MBTCP-UA. 2 Right-click the gateway and then choose UPLOAD EDS FROM DEVICE.

Note: RSLogix5000 may need to be restarted 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.

ProSoft Technology, Inc.

Page 48 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

6 Click your PLX32-EIP-MBTCP-UA, 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 PLX32-EIP-MBTCP-UA.

8 To add I/O connections click CHANGE. ProSoft Technology, Inc.

Page 49 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

9 In the Module Definition dialog box, enter the I/O connections. Up to eight I/O connections can be added. The I/O connections have a fixed size of 496 bytes of input data and 496 bytes of output data. When finished click OK.

10 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.
11 The new gateway appears in the Controller Organizer under the EtherNet/IP bridge.

ProSoft Technology, Inc.

Page 50 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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 PLX32-EIP-MBTCP-UA. This creates the communication path from the processor to the PLX32-EIP-MBTCP-UA. 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.

ProSoft Technology, Inc.

Page 51 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Configuring EIP Class 1 Connections in PCB After you have created the PLX32 -EIP-MBTCP-UA gateway 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].

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.

Parameter Input Data Address Input Size Output Data Address Output Size

Value Range 0 to 9999 0 to 248 0 to 9999 0 to 248

Description
Specifies the starting address within the gateway’s virtual database for data transferred from the gateway to the PLC.
Specifies the number of Integers being transferred to the PLC’s input image (248 integers max).
Specifies the starting address within the gateway’s virtual database for data transferred from the PLC to the gateway.
Specifies the number of integers being transferred to the PLC’s output image (248 integers max).

ProSoft Technology, Inc.

Page 52 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

5.2.3 Configuring EIP Class 3 Client[x]/UClient Connection
The PLX32-EIP-MBTCP-UA 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 PLX32EIP-MBTCP-UA 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 PLX32-EIP-MBTCPUA 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.

ProSoft Technology, Inc.

Page 53 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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

Parameter
Minimum Command Delay

Value
0 to 65535 milliseconds

Response 0 to 65535

Timeout

milliseconds

Retry Count 0 to 10

Description
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.
Specifies the amount of time in milliseconds that a Client will wait before re-transmitting 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.
Specifies the number of times a command will be retried if it fails.

ProSoft Technology, Inc.

Page 54 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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 55 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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

Parameter Enable

Value
Enable Disable Conditional Write

Internal Address

0 to 9999

Poll Interval Reg Count Swap Code
IP Address Slot

0 to 65535
0 to 125
None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx -1

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.
Specifies the number of data points to be read from or written to the target device.
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)
Specifies the IP address of the target device to be addressed.
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 CLX or CMPLX rack, the slot number corresponds to the slot containing the controller being addressed.

Func Code 501 509

File Type File Number

Binary Counter Timer Control Integer Float ASCII String Status
-1

Specifies the function code to be used in the command. 501 – Protected Typed Read 509 – Protected Typed Write Specifies the file type to be associated with the command.
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.

ProSoft Technology, Inc.

Page 56 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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.

Parameter Enable

Value
Enable Disable Conditional Write

Internal Address Poll Interval Reg Count Swap Code
IP Address Slot Func Code File Type
File Number

0 to 9999
0 to 65535
0 to 125
None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx
-1
502 510 511
Binary Counter Timer Control Integer Float ASCII String Status -1

Specifies the database address in the gateway’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. 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. Specifies the number of data points to be read from or written to the target device. 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) Specifies the IP address of the target device to be addressed by this command. 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. Specifies the function code to be used in the command. 502 – Protected Typed Read 510 – Protected Typed Write 511 – Protected Typed Write w/Mask Specifies the file type to be associated with the command.
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.

ProSoft Technology, Inc.

Page 57 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Parameter Element Number
Sub Element
Comment

Value

Description Specifies the element in the file where the command will start.
Specifies the sub-element to be used with the command. Refer to the AB documentation for a list of valid sub-element codes. Optional 32 character comment for the command.

ProSoft Technology, Inc.

Page 58 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Class 3 Client[x]/UClient Commands PLC5 Binary

Parameter Enable
Internal Address
Poll Interval Reg Count Swap Code
IP Address Slot
Func Code
File Number

Value Enable Disable Conditional Write
0 to 9999
0 to 65535
0 to 125 None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx -1
100 101 102 -1

Description
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
Specifies the database address in the gateway’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.
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.
Specifies the number of data points to be read from or written to the target device.
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)
Specifies the IP address of the target device to be addressed by this command.
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.
Specifies the function code to be used in the command. 100 – Word Range Write 101 – Word Range Read 102 – Read-Modify-Write
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.

ProSoft Technology, Inc.

Page 59 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Class 3 Client[x]/UClient Commands PLC5 ASCII

Parameter Enable

Value
Enable Disable Conditional Write

Internal Address

0 to 9999

Poll Interval

0 to 65535

Reg Count Swap Code
IP Address Slot
Func Code

0 to 125 None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx -1
150 151 152

Specifies the number of data points to be read from or written to the target device.
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)
Specifies IP address of the target device to be addressed by this command.
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.
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.

ProSoft Technology, Inc.

Page 60 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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

Parameter Enable
Internal Address
Poll Interval Reg Count Swap Code
IP Address Slot
Func Code Data Type
Tag Name

Value Enable Disable Conditional Write
0 to 9999
0 to 65535
0 to 125 None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx -1
332 333 Bool SINT INT DINT REAL DWORD

Description 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 Specifies the database address in the gateway’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. 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. Specifies the number of data points to be read from or written to the target device. 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) Specifies the IP address of the target device to be addressed by this command. 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. Specifies the function code to be used in the command. 332 – CIP Data Table Read 333 – CIP Data Table Write Specifies the data type of the target controller tag name.
Specifies the controller tag in the target PLC.

Offset

0 to 65535

Comment

Specifies the offset database where the value corresponds to the Tag Name parameter
Optional 32 character comment for the command.

ProSoft Technology, Inc.

Page 61 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Class 3 Client[x]/UClient Commands CIP Generic

Parameter Enable

Value
Disabled Enabled Conditional Write

Internal Address

0 to 9999

Poll Interval

0 to 65535

Description
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.
Specifies the database address in the gateway’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.
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 Swap Code
IP Address Slot Func Code Service Code Class
Instance
Attribute Comment

0 to 125 None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx -1 CIP Generic 00 to FF (Hex)
00 to FFFF (Hex)
Applicationdependent 00 to FFFF (Hex)

Specifies the number of data points to read/write to the target device.
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)
Specifies the IP address of the target device to be addressed by this command.
Use `-1′ to target a connected device. Use > -1 to target a device in a specific slot number within the rack.
Used to read/write the attributes of any object by using an explicit address
An integer identification value which denotes a particular Object Instance and/or Object class function. For more information refer to ODVA CIP specification.
An integer identification value assigned to each Object Class accessible from the network. For more information, refer to ODVA CIP specification.
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.
An integer identification value assigned to a Class and/or Instance Attribute. For more information, refer to ODVA CIP specification.
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.

ProSoft Technology, Inc.

Page 62 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Note: Due to the behavior of Connected Clients, please note the following:
– Multiple commands with different Class objects cannot be configured to the same device. – Multiple commands with different Class objects cannot be configured 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.

ProSoft Technology, Inc.

Page 63 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

Class 3 Client[x]/UClient Commands Basic

Parameter Enable

Value
Enable Disable Conditional Write

Description
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 9999

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
IP Address

None Word swap Word and Byte swap Byte swap
xxx.xxx.xxx.xxx

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)
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.

ProSoft Technology, Inc.

Page 64 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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:

Connection Type EIP Class 1
EIP Class 3 Server
EIP Class 3 Client/UClient [x]

Submenu Item Config Status
Config Comm Status
Config Comm Status
Commands Cmd Errors (Decimal)
Cmd Errors (Hex)

Description
Configuration settings for Class 1 Connections.
Status of the Class 1 Connections. Displays any configuration error, as well as the number of Class 1 Connections.
Configuration settings for Class 3 Server Connections.
Status information for each Class 3 Server Connection. Displays port numbers, IP addresses, socket status, and read and write counts.
Configuration settings for Class 3 Client/UClient Connections.
Status information for Class 3 Client/UClient [x] commands. Displays a summary of all the errors resulting from Class 3 Client/UClient [x] commands.
Configuration for the Class 3 Client/UClient [x] command list.
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.
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.

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

ProSoft Technology, Inc.

Page 65 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

5.3.2 EIP Status Data in Upper Memory
The EIP driver has an associated status data area located in the upper memory of the PLX32-EIP-MBTCP-UA. The Data Map functionality of the PLX32-EIP-MBTCP- UA can be used to map this data into the normal user data range of the PLX32 -EIP-MBTCP-UA 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 PLX32-EIP-MBTCP-UA stores general error and status data for each EIP connected and unconnected client:

EIP Client Connected Client 0 Connected Client 1 Unconnected Client 0

Address Range 17900 through 17909 18100 through 18109 22800 through 22809

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:

Offset 0 1 2 3 4 5 6 7 8 9

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

ProSoft Technology, Inc.

Page 66 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

EIP Client Command List Error Data

The PLX32-EIP-MBTCP-UA 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:

EIP Client Connected client 0 Connected client 1 Unconnected client 0

Address Range 17910 through 18009 18110 through 18209 22810 through 22909

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:

Offset 0 1
2 3 4 . . . 97 98 99

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

ProSoft Technology, Inc.

Page 67 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

EIP Class 1 Server Status Data
The following table lists the addresses in upper memory where the PLX3x gateway stores the Open Connection Count for each EIP Class 1 server.

EIP Class 1 Server
1 2 3 4 5 6 7 8

Address Range 17000
17001 17002 17003 17004 17005 17006 17007 17008

Description Bit map of PLC State for each Connection 1 to 8. 0 = Run 1 = Program Open Connection Count for Connection 1 Open Connection Count for Connection 2 Open Connection Count for Connection 3 Open Connection Count for Connection 4 Open Connection Count for Connection 5 Open Connection Count for Connection 6 Open Connection Count for Connection 7 Open Connection Count for Connection 8

EIP Class 3 Server Status Data

The following table lists the addresses in upper memory where the PLX32-EIP- MBTCPUA stores status data for each EIP server:

EIP Server 0 1 2 3 4

Address Range 18900 through 18915 18916 through 18931 18932 through 18947 18948 through 18963 18964 through 18979

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:

Offset 0 through 1 2 through 3 4 through 5 6 through 7 8 through 15

Description Connection State Open Connection Count Socket Read Count Socket Write Count Peer IP

ProSoft Technology, Inc.

Page 68 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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 least- significant byte of the word contains the extended status code and the most- significant 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 within 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 PLX32-EIP-MBTCP- UA. The most common EtherNet/IP/PCCC errors are shown below:

Local STS Error Codes

Code (Int) 0 256 512 768 1024 1280 1536 1792 2048

Code (Hex) 0x0000 0x0100 0x0200 0x0300 0x0400 0x0500 0x0600 0x0700 0x0800

Description Success, no error DST node is out of buffer space Cannot guarantee delivery (Link Layer) Duplicate token holder detected Local port is disconnected Application layer timed out waiting for response Duplicate node detected Station is offline Hardware fault

Remote STS Error Codes

Code (Int) 0 4096 8192 12288 16384 20480 24576 26872 -32768 -28672 -24576 -20480 -16384 -12288 -8192

Code (Hex) 0x0000 0x1000 0x2000 0x3000 0x4000 0x5000 0x6000 0x7000 0x8000 0x9000 0xA000 0xB000 0xC000 0xD000 0xE000
0xF0nn

Description Success, no error Illegal command or format Host has a problem and will not communicate Remote node host is missing, disconnected or shut down Host could not complete function due to hardware fault Addressing problem or memory protect rungs Function not allowed due to command protection selection Processor is in Program mode Compatibility mode file missing or communication zone problem Remote node cannot buffer command Wait ACK (1775-KA buffer full) Remote node problem due to download Wait ACK (1775-KA buffer full) Not used Not used Error code in the EXT STS byte (nn contains EXT error code)

ProSoft Technology, Inc.

Page 69 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EXT STS Error Codes

Code (Int) -4096 -4095 -4094 -4093 -4092 -4091 -4090 -4089 -4088 -4087 -4086 -4085 -4084 -4083 -4082 -4081 -4080 -4079 -4078 -4077 -4076 -4075 -4074 -4073 -4072 -4071 -4070 -4069 -4068 -4067 -4066 -4065

Code (Hex) 0xF000 0xF001 0xF002 0xF003 0xF004 0xF005 0xF006 0xF007 0xF008 0xF009 0xF00A 0xF00B 0xF00C 0xF00D 0xF00E 0xF00F 0xF010 0xF011 0xF012 0xF013 0xF014 0xF015 0xF016 0xF017 0xF018 0xF019 0xF01A 0xF01B 0xF01C 0xF01D 0xF01E 0xF01F

Description Not used A field has an illegal value Fewer levels specified in address than minimum for any address More levels specified in address than system supports Symbol not found Symbol is of improper format Address does not point to something usable File is wrong size Cannot complete request Data or file is too large Transaction size plus word address is too large Access denied, improper privilege Condition cannot be generated – resource is not available Condition already exists – resource is already available Command cannot be executed Histogram overflow No access Illegal data type Invalid parameter or invalid data Address reference exists to deleted area Command execution failure for unknown reason Data conversion error Scanner not able to communicate with 1771 rack adapter Type mismatch 1171 Gateway response was not valid Duplicate label File is open; another node owns it Another node is the program owner Reserved Reserved Data table element protection violation Temporary internal problem

EIP Error Codes

Code (Int) -1 -2 -10 -11 -12 -20 -21 -200

Code (Hex) 0xFFFF 0xFFFE 0xFFF6 0xFFF5 0xFFF4 0xFFEC 0xFFEB 0xFF38

Description CTS modem control line not set before transmit Timeout while transmitting message Timeout waiting for DLE-ACK after request Timeout waiting for response after request Reply data does not match requested byte count DLE- NAK received after request DLE-NAK sent after response DLE-NAK received after request

EIP Protocol User Manual

ProSoft Technology, Inc.

Page 70 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

TCP/IP Interface Error Codes

Error (Int) -33 -34 -35 -36 -37

Error (Hex) 0xFFDF 0xFFDE 0xFFDD 0xFFDC 0xFFDB

Description Failed to connect to target Failed to register session with target (timeout) Failed forward open response timeout PCCC/Tag command response timeout No TCP/IP connection error

Common Response Error Codes

Error (Int) -40 -41 -42 -43 -44 -45 -46 -47 -48 -49

Error (Hex) 0xFFD8 0xFFD7 0xFFD6 0xFFD5 0xFFD4 0xFFD3 0xFFD2 0xFFD1 0xFFD0 0xFFCF

Description Invalid response length CPF item count not correct CPF address field error CPF packet tag invalid CPF bad command code CPF status error reported CPF incorrect connection ID value returned Context field not matched Incorrect session handle returned CPF not correct message number

Error (Int) -50 -51 -52

Error (Hex) 0xFFCE 0xFFCD 0xFFCC

Description Message length received not valid Status error reported Invalid version

Forward Open Response Error Codes

Error (Int) -55 -56

Error (Hex) 0xFFC9 0xFFC8

Description Message length received not valid Status error reported

PCCC Response Error Codes

Error (Int) -61 -62 -63 -64 -65
-66

Error (Hex) 0xFFC3 0xFFC2 0xFFC1 0xFFC0
0xFFBF 0xFFBE

Description Message length received not valid Status error reported CPF bad command code TNS in PCCC message not matched
Vendor ID in PCCC message not matched Serial number in PCCC message not matched

EIP Protocol User Manual

ProSoft Technology, Inc.

Page 71 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

5.4 EIP Reference
5.4.1 SLC and MicroLogix Specifics
Messaging from a SLC 5/05 The PLX32-EIP-MBTCP-UA 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.
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.

ProSoft Technology, Inc.

Page 72 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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 73 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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.

ProSoft Technology, Inc.

Page 74 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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.

File Type S B T C R N F Z A

Description Status Bit Timer Counter Control Integer Floating-point String ASCII

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 sub- element 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 75 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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
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.

ProSoft Technology, Inc.

Page 76 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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.

ProSoft Technology, Inc.

Page 77 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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.

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.

ProSoft Technology, Inc.

Page 78 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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.

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
Code 0 1 2

Description Control Preset Accumulated

Control
Code 0 1 2

Description Control Length Position

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

Code 0 2 4 6 8 26

Description Control SP Kp Ki Kd PV

ProSoft Technology, Inc.

Page 79 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

BT
Code 0 1 2 3 4 5
MG
Code 0 1 2 3

Description Control RLEN DLEN Data file # Element # Rack/Grp/Slot
Description Control Error RLEN DLEN

EIP Protocol User Manual

ProSoft Technology, Inc.

Page 80 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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 PLX32EIP- MBTCP-UA 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
The following diagram shows an example rung that executes a write command.

ProSoft Technology, Inc.

Page 81 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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.
3 Click the COMMUNICATION tab and complete the communication information as shown in the following image.

ProSoft Technology, Inc.

Page 82 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

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 1756ENET 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 1756-ENET gateways and racks. Refer to the ProSoft Technology Technical Support Knowledgebase for more information on Ethernet routing and path definitions.

ProSoft Technology, Inc.

Page 83 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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 84 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol User Manual

3 Click the COMMUNICATION tab and complete the communication information as shown in the following image.

ProSoft Technology, Inc.

Page 85 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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 86 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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.

ProSoft Technology, Inc.

Page 87 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

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 88 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

EIP Protocol 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.

ProSoft Technology, Inc.

Page 89 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway
6 MBTCP Protocol

MBTCP Protocol User Manual

6.1 MBTCP Functional Overview
You can use the PLX32-EIP-MBTCP-UA 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 92) 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 90 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

MBTCP Protocol 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, 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

Parameter Modbus Commands Supported (client and server)
Configurable Parameters: (client and server)
Configurable Parameters: (client only)
Command List Status Data
Command List Polling

Description

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 Register

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)

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

Minimum Command Delay Response Timeout Retry Count
Command Error Pointer

Up to 160 Modbus commands (one tag per command)

Error codes reported individually for each command. High-level status data available from Modbus TCP/IP client (Ex: PLC)

Each command can be individually enabled or disabled; write-only-on-datachange is available

ProSoft Technology, Inc.

Page 91 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

MBTCP Protocol User Manual

6.1.2 MBTCP Internal Database
The internal database is central to the functionality of the PLX32-EIP-MBTCP- UA. 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 gateway status data area. This is where the gateway writes internal status data for the protocols supported by the gateway.
· Lower memory for the user data area. This is where incoming data from external devices is stored and accessed.

ProSoft Technology, Inc.

Page 92 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

MBTCP Protocol User Manual

Modbus TCP/IP Client Access to Database
The client functionality exchanges data between the PLX32-EIP-MBTCP-UA’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.
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.

ProSoft Technology, Inc.

Page 93 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

MBTCP Protocol User Manual

Database Address 0 1000 2000 3000 3999

Modbus Address 40001 41001 42001 43001 44000

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 95).

Database Address 4000 5000 6000 7000 8000 9000 9999

Modbus Address 44001 45001 46001 47001 48001 49001 50000

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.
Modbus Message Routing: Port 2001
When Modbus messages are sent to the PLX32-EIP-MBTCP-UA over the TCP/IP connection to port 2001, the messages are routed by the gateway directly out the serial communication port (Port 0, if it is configured as a Modbus master). The commands (whether a read or a write command) are immediately routed to the slave devices on the serial port. Response messages from the slave devices are routed by the gateway to the TCP/IP network to be received by the originating host.

ProSoft Technology, Inc.

Page 94 of 155

PLX32-EIP-MBTCP-UA Multi-Protocol Gateway

MBTCP Protocol User Manual

6.2 MBTCP Configuration
6.2.1 Configuring MBTCP Servers This section contains database offset information used by the PLX32-EIP-MBTCP-UA MBTCP server when accessed by external clients. You can use these

ProSoft TECHNOLOGY PLX32 Multi Protocol Gateway User Manual

PLX32 Multi Protocol Gateway

Product Information

Specifications

Product Usage Instructions

1. Start Here

1.1 Overview

1.2 System Requirements

1.3 Package Contents

1.4 Mounting the Gateway on a DIN-rail

1.5 Jumper Settings

1.6 SD Card

1.7 Connecting Power to the Unit

Frequently Asked Questions (FAQ)

Q: How do I reset the Multi-Protocol Gateway to factory

Q: Can the PLX32-EIP-MBTCP-UA Gateway be used in hazardous

References

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Related Manuals