ProSoft inRAx MVI56-MNETCR User Manual

Download

MVI56-MNETCR

ControlLogix Platform

Modbus TCP/IP Multi Client Communication Module for Remote Chassis

April 1, 2011

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

5201 Truxtun Ave., 3rd Floor Bakersfield, CA 93309 +1 (661) 716-5100 +1 (661) 716-5101 (Fax) www.prosoft-technology.com

support@prosoft-technology.com

MVI56-MNETCR User Manual April 1, 2011

ProSoft Technology ®, ProLinx ®, inRAx ®, ProTalk ®, and RadioLinx ® are Registered Trademarks 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.

ProSoft Technology® Product Documentation

In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments. User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided on the enclosed CD-ROM, and are available at no charge from our web site: www.prosoft-technology.com

Important Installation Instructions

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

A WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR

CLASS I, DIV. 2;

B WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE

REPLACING OR WIRING MODULES

C WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN

SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.

D THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.

MVI (Multi Vendor Interface) Modules

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

AVERTISSEMENT - RISQUE D'EXPLOSION - AVANT DE DÉCONNECTER L'ÉQUIPEMENT, COUPER LE COURANT OU S'ASSURER QUE L'EMPLACEMENT EST DÉSIGNÉ NON DANGEREUX.

Warnings

North America Warnings

A Warning - Explosion Hazard - Substitution of components may impair suitability for Class I, Division 2. B Warning - Explosion Hazard - When in hazardous locations, turn off power before replacing or rewiring modules. C Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is

known to be non-hazardous.

Avertissement - Risque d'explosion - Avant de déconnecter l'équipement, couper le courant ou s'assurer que l'emplacement est désigné non dangereux.

D Suitable for use in Class I, Division 2 Groups A, B, C and D Hazardous Locations or Non-Hazardous Locations.

ATEX Warnings and Conditions of Safe Usage

Power, Input, and Output (I/O) wiring must be in accordance with the authority having jurisdiction.

A Warning - Explosion Hazard - When in hazardous locations, turn off power before replacing or wiring modules. B Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is

known to be non-hazardous.

C These products are intended to be mounted in an IP54 enclosure. The devices shall provide external means to

prevent the rated voltage being exceeded by transient disturbances of more than 40%. This device must be used only with ATEX certified backplanes.

D DO NOT OPEN WHEN ENERGIZED.

Battery Life Advisory

The MVI46, MVI56, MVI56E, MVI69, and MVI71 modules use a rechargeable Lithium Vanadium Pentoxide battery to backup the real-time clock and CMOS. The battery should last for the life of the module. The module must be powered for approximately twenty hours before the battery becomes fully charged. After it is fully charged, the battery provides backup power for the CMOS setup and the real-time clock for approximately 21 days. When the battery is fully discharged, the module will revert to the default BIOS and clock settings.

Note: The battery is not user replaceable.

Markings

Electrical Ratings

 Backplane Current Load: 800 mA @ 5.1 Vdc; 3 mA @ 24 Vdc  Operating Temperature: 0°C to 60°C (32°F to 140°F)  Storage Temperature: -40°C to 85°C (-40°F to 185°F)  Shock: 30 g, operational; 50 g, non-operational; Vibration: 5 g from 10 Hz to 150 Hz  Relative Humidity: 5% to 95% (without condensation)  All phase conductor sizes must be at least 1.3 mm(squared) and all earth ground conductors must be at least

4mm(squared).

Label Markings

ATEX II 3 G EEx nA IIC T6 0°C <= Ta <= 60°C

cULus E183151 Class I Div 2 Groups A,B,C,D T6

-30°C <= Ta <= 60°C

Agency Approvals and Certifications

Agency Applicable Standard

RoHS CE EMC-EN61326-1:2006; EN61000-6-4:2007 ATEX EN60079-15:2003 cULus UL508; UL1604; CSA 22.2 No. 142 & 213 CB Safety CA/10533/CSA

IEC 61010-1 Ed.2; CB 243333-2056722 (2090408) GOST-R EN 61010 CSA EN 61010

243333

ME06

E18315

MVI56-MNETCR ♦ ControlLogix Platform Contents Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Contents

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

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

ProSoft Technology® Product Documentation .................................................................................... 2

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

MVI (Multi Vendor Interface) Modules ................................................................................................ 3

Warnings ............................................................................................................................................. 3

Battery Life Advisory ........................................................................................................................... 3

Markings .............................................................................................................................................. 4

Guide to the MVI56-MNETCR User Manual 9

1 Start Here 11

1.1

1.2

1.3

1.4

1.5

System Requirements ............................................................................................. 12

Package Contents ................................................................................................... 13

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

Setting Jumpers ...................................................................................................... 15

Installing the Module in the Rack ............................................................................ 16

2 Configuring the MVI56-MNETCR Module 17

2.1

2.2

2.3

2.4

2.5

2.1.1

2.1.2

2.1.3

2.1.4

2.1.5

2.1.6

2.1.7

2.3.1

2.3.2

2.4.1

2.4.2

2.4.3

2.4.4

Importing the MVI56-MNETCR Add-On Instruction ............................................... 18

Creating a New RSLogix 5000 Project .................................................................... 18

Creating the Remote Network ................................................................................. 19

Creating the Module - Remote Rack ....................................................................... 21

Creating the Module - Local Rack ........................................................................... 23

Importing Add-On Instruction .................................................................................. 25

Connecting Your PC to the ControlLogix Processor ............................................... 35

Downloading the Sample Program to the Processor .............................................. 36

Connecting your PC to the Module ......................................................................... 37

Using ProSoft Configuration Builder ....................................................................... 38

Setting Up the Project ............................................................................................. 38

Renaming PCB Objects .......................................................................................... 40

Module Configuration .............................................................................................. 42

Module ..................................................................................................................... 42

MNET Client x ......................................................................................................... 44

Static ARP Table ..................................................................................................... 52

Ethernet Configuration ............................................................................................ 53

Downloading the Project to the Module Using a Serial COM port .......................... 54

3 Ladder Logic 55

3.1

3.1.1

3.1.2

3.1.3

3.1.4

Module Data Object (MNETCRMODULEDEF) ....................................................... 56

User Data Object (MNETCRDATA) ........................................................................ 57

Command Control Data Object (MNETCCONTROL) ............................................. 58

Status Object (MNETCRSTATUS) .......................................................................... 59

Backplane Control Object (MNETCRUTIL) ............................................................. 61

ProSoft Technology, Inc. Page 5 of 127 February 14, 2011

Contents MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4 Diagnostics and Troubleshooting 63

4.1

4.2

4.3

4.1.1

4.1.2

4.1.3

4.2.1

4.2.2

4.2.3

4.2.4

4.2.5

4.2.6

4.2.7

LED Status Indicators ............................................................................................. 64

Ethernet LED Indicators .......................................................................................... 66

Clearing a Fault Condition ...................................................................................... 66

Troubleshooting ...................................................................................................... 66

Using ProSoft Configuration Builder (PCB) for Diagnostics ................................... 68

Using the Diagnostic Window in ProSoft Configuration Builder ............................. 68

Navigation ............................................................................................................... 70

Main Menu .............................................................................................................. 71

Modbus Database View Menu ................................................................................ 74

Command List Menu ............................................................................................... 75

Master Command Error List Menu.......................................................................... 76

Network Menu ......................................................................................................... 77

Reading Status Data from the Module ................................................................... 79

5 Reference 81

5.1

5.2

5.3

5.4

5.5

5.6

5.7

5.1.1

5.1.2

5.1.3

5.2.1

5.2.2

5.2.3

5.3.1

5.3.2

5.3.3

5.4.1

5.5.1

5.5.2

5.5.3

Product Specifications ............................................................................................ 82

General Specifications ............................................................................................ 82

Functional Specifications ........................................................................................ 83

Hardware Specifications ......................................................................................... 84

Functional Overview ............................................................................................... 85

About the MODBUS/TCP Protocol ......................................................................... 85

Backplane Data Transfer ........................................................................................ 85

Special Function Blocks .......................................................................................... 90

Data Flow between MVI56-MNETCR Module, Processor, and Network .............. 98

Client Driver ............................................................................................................ 99

Client Command List ............................................................................................ 100

Client Command Errors ........................................................................................ 100

Data Flow between MVI56-MNETCR Module, Processor, and Network ............ 102

Client Driver .......................................................................................................... 103

Cable Connections ............................................................................................... 106

Ethernet Connection ............................................................................................. 106

RS-232 Configuration/Debug Port ........................................................................ 107

DB9 to RJ45 Adaptor (Cable 14) .......................................................................... 109

Adding the Module to an Existing Project ............................................................. 110

Using the Sample Program - RSLogix 5000 Version 15 and earlier .................... 113

6 Support, Service & Warranty 115

Contacting Technical Support ........................................................................................................ 115

6.1

6.1.1

6.1.2

6.1.3

6.2

6.2.1

6.2.2

6.2.3

6.2.4

6.2.5

6.2.6

Return Material Authorization (RMA) Policies and Conditions ............................. 117

Returning Any Product .......................................................................................... 117

Returning Units Under Warranty ........................................................................... 118

Returning Units Out of Warranty ........................................................................... 118

LIMITED WARRANTY .......................................................................................... 119

What Is Covered By This Warranty ...................................................................... 119

What Is Not Covered By This Warranty ................................................................ 120

Disclaimer Regarding High Risk Activities ............................................................ 120

Intellectual Property Indemnity ............................................................................. 121

Disclaimer of all Other Warranties ........................................................................ 121

Limitation of Remedies ** ..................................................................................... 122

Page 6 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Contents Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

6.2.7

6.2.8

6.2.9

6.2.10

Time Limit for Bringing Suit ................................................................................... 122

No Other Warranties ............................................................................................. 122

Allocation of Risks ................................................................................................. 122

Controlling Law and Severability ........................................................................... 123

Index 125

ProSoft Technology, Inc. Page 7 of 127 February 14, 2011

Contents MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Page 8 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Start Here Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Guide to the MVI56-MNETCR User Manual

Function

Introduction (Must Do)

Diagnostic and Troubleshooting

Reference

Product Specifications

Functional Overview

Support, Service, and Warranty

Index

Section to Read Details

Start Here (page 11) This section introduces the customer to the

→

Diagnostics and

→

Troubleshooting (page 63)

Reference (page 81)

→

Product Specifications (page

82)

Functional Overview (page 85, page 75)

Support, Service

→

and Warranty (page

115)

Index

module. Included are: package contents, system requirements, hardware installation, and basic configuration.

This section describes Diagnostic and Troubleshooting procedures.

These sections contain general references associated with this product, Specifications, and the Functional Overview.

This section contains Support, Service and Warranty information.

Index of chapters.

ProSoft Technology, Inc. Page 9 of 127 February 14, 2011

Start Here MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Page 10 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Start Here Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

1 Start Here

In This Chapter

 System Requirements ........................................................................... 12

 Package Contents ................................................................................. 13

 Installing ProSoft Configuration Builder Software .................................. 14

 Setting Jumpers .................................................................................... 15

 Installing the Module in the Rack ........................................................... 16

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

 Rockwell Automation® RSLogix™ software: launch the program, configure

ladder logic, and transfer the ladder logic to the processor

 Microsoft Windows: install and launch programs, execute menu commands,

navigate dialog boxes, and enter data

 Hardware installation and wiring: install the module, and safely connect

Modbus TCP/IP and ControlLogix devices to a power source and to the MVI56-MNETCR module’s application port(s)

ProSoft Technology, Inc. Page 11 of 127 February 14, 2011

Start Here MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

1.1 System Requirements

The MVI56-MNETCR module requires the following minimum hardware and software components:

 Rockwell Automation ControlLogix™ processor, with compatible power

supply and one free slot in the rack, for the MVI56-MNETCR module. The module requires 800 mA of available power.

 Rockwell Automation RSLogix 5000 programming software version 2.51 or

higher

 Rockwell Automation RSLinx communication software  Pentium® II 450 MHz minimum. Pentium III 733 MHz (or better)

recommended

 Supported operating systems:

Microsoft Windows XP Professional with Service Pack 1 or 2

Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3

Microsoft Windows Server 2003

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

requirements)

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

1024 × 768 recommended)

 CD-ROM drive  ProSoft Configuration Builder, HyperTerminal or other terminal emulator

program.

Note: You can install the module in a local or remote rack. For remote rack installation, the module requires EtherNet/IP or ControlNet communication with the processor.

Page 12 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Start Here Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

1.2 Package Contents

The following components are included with your MVI56-MNETCR module, 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 Part Number Part Description

1 MVI56-MNETCR

Module

1 Cable Cable #15 - RS232

1 Cable Cable #14 - RJ45

1 inRAx Solutions CD Contains sample programs, utilities and

If any of these components are missing, please contact ProSoft Technology Support for replacement parts.

MVI56-MNETCR Modbus TCP/IP Multi Client Communication

Module for Remote Chassis For RS232 between a Personal Computer

Null Modem

to DB9 Male Adapter

(PC) and the CFG port of the module For connecting the module’s port to Cable

#15 for RS-232 connections

documentation for the MVI56-MNETCR module.

ProSoft Technology, Inc. Page 13 of 127 February 14, 2011

Start Here MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

1.3 Installing ProSoft Configuration Builder Software

You must install the ProSoft Configuration Builder (PCB) software to configure the module. You can always get the newest version of ProSoft Configuration Builder from the ProSoft Technology website.

Installing ProSoft Configuration Builder from the ProSoft website

1 Open your web browser and navigate to http://www.prosoft-

technology.com/pcb

2 Click the D

Configuration Builder.

3 Choose S 4 Save the file to your Windows Desktop, so that you can find it easily when

you have finished downloading.

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

instructions on your screen to install the program.

If you do not have access to the Internet, you can install ProSoft Configuration Builder from the ProSoft Solutions Product CD-ROM, included in the package with your module.

Installing ProSoft Configuration Builder from the Product CD-ROM

1 Insert the ProSoft Solutions Product CD-ROM into the CD-ROM drive of your

PC. Wait for the startup screen to appear.

2 On the startup screen, click P

Windows Explorer file tree window.

3 Click to open the U

and files you will need to set up and configure your module.

4 Double-click the S

PCB_*.

software on your PC. The information represented by the "*" character in the file name is the PCB version number and, therefore, subject to change as new versions of PCB are released.

OWNLOAD HERE

AVE

or S

AVE FILE

TILITIES

ETUP CONFIGURATION TOOL

EXE

file and follow the instructions on your screen to install the

link to download the latest version of ProSoft

when prompted.

RODUCT DOCUMENTATION

folder. This folder contains all of the applications

folder, double-click the

. This action opens a

Note: Many of the configuration and maintenance procedures use files and other utilities on the CD-ROM. You may wish to copy the files from the Utilities folder on the CD-ROM to a convenient location on your hard drive.

Page 14 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Start Here Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

1.4 Setting Jumpers

The Setup Jumper acts as "write protection" for the module’s flash memory. In "write protected" mode, the Setup pins are not connected, and the module’s firmware cannot be overwritten. Do not jumper the Setup pins together unless you are directed to do so by ProSoft Technical Support.

The following illustration shows the MVI56-MNETCR jumper configuration.

Note: If you are installing the module in a remote rack, you may prefer to leave the Setup pins jumpered. That way, you can update the module’s firmware without requiring physical access to the module.

ProSoft Technology, Inc. Page 15 of 127 February 14, 2011

Start Here MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

1.5 Installing the Module in the Rack

If you have not already installed and configured your ControlLogix processor and power supply, please do so before installing the MVI56-MNETCR module. Refer to your Rockwell Automation product documentation for installation instructions.

Warning: You must follow all safety instructions when installing this or any other electronic devices. Failure to follow safety procedures could result in damage to hardware or data, or even serious injury or death to personnel. Refer to the documentation for each device you plan to connect to verify that suitable safety procedures are in place before installing or servicing the device.

After you have checked the placement of the jumpers, insert MVI56-MNETCR into the ControlLogix chassis. Use the same technique recommended by Rockwell Automation to remove and install ControlLogix modules.

Warning: When you insert or remove the module while backplane power is on, an electrical arc can occur. This could cause an explosion in hazardous location installations. Verify that power is removed or the area is non-hazardous before proceeding. Repeated electrical arcing causes excessive wear to contacts on both the module and its mating connector. Worn contacts may create electrical resistance that can affect module operation.

1 Turn power OFF. 2 Align the module with the top and bottom guides, and slide it into the rack

until the module is firmly against the backplane connector.

3 With a firm but steady push, snap the module into place. 4 Check that the holding clips on the top and bottom of the module are securely

in the locking holes of the rack.

5 Make a note of the slot location. You must identify the slot in which the

module is installed in order for the sample program to work correctly. Slot numbers are identified on the green circuit board (backplane) of the ControlLogix rack.

6 Turn power ON.

Note: If you insert the module improperly, the system may stop working, or may behave unpredictably.

Page 16 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2 Configuring the MVI56-MNETCR Module

In This Chapter

 Import the MVI56-MNETCR Add-On Instruction .................................... 18

 Connecting your PC to the Module ........................................................ 37

 Using ProSoft Configuration Builder ...................................................... 38

 Module Configuration ............................................................................ 42

 Downloading the Project to the Module Using a Serial COM port ......... 54

ProSoft Technology, Inc. Page 17 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.1 Importing the MVI56-MNETCR Add-On Instruction

Note: This section only applies if you are using RSLogix5000 version 16 or higher. If you are configuring the MVI56-MNETCR module with an earlier version of RSLogix 5000, please refer to the Ladder Logic section, Using the Sample Program (page 113).

Before You Begin

The following file is required before you start this procedure. Copy the file from the ProSoft Solutions CD-ROM, or download it from Error! Hyperlink reference

not valid..

File Name Description

MVI56MNETCR_AddOn_R ung_v1_3.L5X

L5X file containing Add-On instruction, user defined data types, data objects and ladder logic required to set up the MVI56-MNETCR module

2.1.1 Creating a New RSLogix 5000 Project

1 Open the F

ILE

menu, and then choose NEW.

2 Select your ControlLogix controller model. 3 Select R

EVISION

16. 4 Enter a name for your controller, such as My_Controller. 5 Select your ControlLogix chassis type. 6 Select S

LOT 0

for the controller.

Page 18 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.1.2 Creating the Remote Network

1 Right-click I/O C

ONFIGURATION

and choose N

EW MODULE

…

2 Expand the C

OMMUNICATIONS

module selections and then select the Ethernet Bridge module that matches your hardware. This example uses a 1756ENBT/A module.

Note: If you are prompted to "Select Major Revision", choose the lower of the available revision numbers.

ProSoft Technology, Inc. Page 19 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

3 Name the ENBT/A module, then set the IP Address and slot location in the

local rack with the ControlLogix processor.

4 Click OK. 5 Next, select the 1756-ENBT module that you just created in the Controller

Organization pane and click the right mouse button to open a shortcut menu. On the shortcut menu, choose N

EW MODULE

6 Repeat steps 2 and 3 to add the second EtherNet/IP module to the remote

rack.

Page 20 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.1.3 Creating the Module - Remote Rack

1 In the C

ACKPLANE

ONTROLLER ORGANIZATION

node, and then click the right mouse button to open a shortcut

menu. On the shortcut menu, choose N

2 This action opens the S

ELECT MODULE

and then select 1756-MODULE (G

window, select the remote 1756

EW MODULE

dialog box. Expand the O

ENERIC

1756 M

ODULE

)

THER

node,

3 Set the Module Properties values as follows:

Parameter Value

Name Enter a module identification string. The recommended value is

MNETCR.

Description Enter a description for the module. Example: Modbus TCP/IP

Multi Client Communication Module for Remote Chassis. Comm Format Slot Enter the slot number in the rack where the MVI56-MNETCR

Input Assembly Instance 1 Input Size 42 Output Assembly Instance 2 Output Size 42 Configuration Assembly Instance 4 Configuration Size 0

Select D

module will be installed.

ATA

-INT (Very Important)

ProSoft Technology, Inc. Page 21 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4 On the C

ONNECTION

tab, set the RPI value for your project. Fifty milliseconds

is usually a good starting value.

The MVI56-MNETCR module is now visible in the I/O C

ONFIGURATION

pane.

Page 22 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.1.4 Creating the Module - Local Rack

1 In the C

node.

2 Select the 1756 B

open a shortcut menu. On the shortcut menu, choose N

3 This action opens the S

ONTROLLER ORGANIZATION

ACKPLANE

node, and then click the right mouse button to

ELECT MODULE

window, expand the I/O configuration

EW MODULE

...

dialog box.

4 Select the 1756-M

ODULE (GENERIC

1756 M

ODULE)

from the list and click OK.

5 Set the Module Properties values as follows:

Parameter Value

Name Enter a module identification string. The recommended value is

MNETCR. Description Enter a description for the module. Example: Modbus TCP/IP

Multi Client Communication Module for Remote Chassis. Comm Format Slot Enter the slot number in the rack where the MVI56-MNETCR

Input Assembly Instance 1 Input Size 42 Output Assembly Instance 2 Output Size 42 Configuration Assembly Instance 4 Configuration Size 0

Select D

module is to be installed.

ATA

-INT (Very Important)

ProSoft Technology, Inc. Page 23 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

6 On the C

ONNECTION

tab, set the RPI value for your project. Five milliseconds

is usually a good starting value. Click OK to confirm.

The MVI56-MNETCR module is now visible in the I/O C

ONFIGURATION

pane.

Page 24 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.1.5 Importing Add-On Instruction

1 In the C

subfolder until you reach the M

2 In the M 3 Select an empty rung in the new routine, and then click the right mouse

button to open a shortcut menu. On the shortcut menu, choose I R

UNG

ONTROLLER ORGANIZATION

AINPROGRAM

folder, double-click to open the M

…

window, expand the T

AINPROGRAM

folder.

ASKS

folder and

AINROUTINE

MPORT

ladder.

ProSoft Technology, Inc. Page 25 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4 Navigate to the location on your PC where you saved the Add-On Instruction

(for example, "My Documents" or "Desktop"). Select the

MVI56MNETCR_ADDON_R

UNG_V

1_3.L5X file

This action opens the I

MPORT CONFIGURATION

controller tags that will be created.

dialog box, showing the

Page 26 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

If you are installing the module in a Remote Rack, open the dropdown menus for the Input and Output tags, and select the MNETCR module in the remote rack.

5 Click OK to confirm the import. RSLogix will indicate that the import is in

progress:

ProSoft Technology, Inc. Page 27 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

When the import is complete, you will see the new Add-On Instruction rung in the ladder.

The procedure has also imported new User Defined Data Types, data objects and the Add-On instruction for your project.

6 Save the application and then download the sample ladder logic into the

processor.

Page 28 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Adding Multiple Modules (Optional)

Important: If your application requires more than one MVI56-MNETCR module into the same project, follow the steps below.

1 In the I/O C

shortcut menu, and then choose N

ONFIGURATION

folder, click the right mouse button to open a

EW MODULE

2 Select 1756-MODULE

3 Fill the module properties as follows:

Parameter Value

Name Enter a module identification string. Example: MNETCR_2. Description Enter a description for the module. Example: Modbus TCP/IP

Multi Client Communication Module for Remote Chassis Comm Format Slot Enter the slot number in the rack where the MVI56-MNETCR

Input Assembly Instance 1 Input Size 42 Output Assembly Instance 2 Output Size 42 Configuration Assembly Instance 4 Configuration Size 0

Select D

module is located.

ATA

-INT.

ProSoft Technology, Inc. Page 29 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4 Click OK to confirm. The new module is now visible:

5 Expand the T 6 In the M

ASKS

folder, and then expand the M

AINPROGRAM

AINTASK

folder, double-click to open the M

folder.

AINROUTINE

ladder.

7 Select an empty rung in the routine, and then click the right mouse button to

open a shortcut menu. On the shortcut menu, choose I

MPORT RUNG

…

Page 30 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

8 Select the MVI56MNETCR_ADDON_R

MPORT

UNG_V

1_4.L5X file, and then click

9 This action opens the I

that will be imported.

MPORT CONFIGURATION

window, which shows the tags

ProSoft Technology, Inc. Page 31 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

10 Associate the I/O connection variables to the correct module. The default

values are RemoteENBT_Slot6:1:I and RemoteENBT_Slot6:1:O so these require change.

Page 32 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

11 Change the default tags MNETCR and AOI56MNETCR to avoid conflict with

existing tags. In this procedure, you will append the string "_2" as shown in the following illustration.

12 Click OK to confirm.

The setup procedure is now complete. Save the project and download the application to your ControlLogix processor.

ProSoft Technology, Inc. Page 33 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Adjusting the Input and Output Array Sizes (Optional)

The module internal database is divided into two user-configurable areas:

 Read Data  Write Data

The Read Data area is moved from the module to the processor, while the Write Data area is moved from the processor to the module.

The MVI56-MNETCR Add-On Instruction rung is configured for 600 registers of Read Data and 600 registers of Write Data, which is sufficient for most applications. However, you can configure the sizes of these data areas to meet the needs of your application.

1 In ProSoft Configuration Builder, expand the Module icon in the tree view and

double-click M

OUNT

to contain the number of words for your Read Data area.

ODULE

to open an Edit window. Change the R

EAD REGISTER

Important: Because the module pages data in blocks of 200 registers at a time, you must configure your user data in multiples of 200 registers.

2 To modify the WriteData array, follow the above steps, substituting WriteData

for ReadData. Also, make sure that the ReadData and WriteData arrays do not overlap in the module memory. For example, if your application requires 2000 words of WriteData starting at register 0, then your Read Register Start parameter must be set to a value of 2000 or greater in ProSoft Configuration Builder.

3 Save and download the configuration to the module. (page 54). It is unnecessary to manually edit the ReadData and WriteData user-defined data

types in the ladder logic, as these are automatically updated to match the changed array sizes in ProSoft Configuration Builder.

Page 34 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.1.6 Connecting Your PC to the ControlLogix Processor

There are several ways to establish communication between your PC and the ControlLogix processor. The following steps show how to establish communication through the serial interface. It is not mandatory that you use the processor's serial interface. You may access the processor through whatever network interface is available on your system. Refer to your Rockwell Automation documentation for information on other connection methods.

1 Connect the right-angle connector end of the cable to your controller at the

communications port.

2 Connect the straight connector end of the cable to the serial port on your

computer.

ProSoft Technology, Inc. Page 35 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.1.7 Downloading the Sample Program to the Processor

Note: The key switch on the front of the ControlLogix processor must be in the REM or PROG position.

1 If you are not already online with the processor, open the Communications

menu, and then choose D

OWNLOAD.

RSLogix 5000 will establish communication with the processor. You do not have to download through the processor's serial port, as shown here. You may download through any available network connection.

2 When communication is established, RSLogix 5000 will open a confirmation

dialog box. Click the D

OWNLOAD

button to transfer the sample program to the

processor.

3 RSLogix 5000 will compile the program and transfer it to the processor. This

process may take a few minutes.

4 When the download is complete, RSLogix 5000 will open another

confirmation dialog box. If the key switch is in the REM position, click OK to switch the processor from PROGRAM mode to RUN mode.

Note: If you receive an error message during these steps, refer to your RSLogix documentation to interpret and correct the error.

Page 36 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.2 Connecting your PC to the Module

With the module securely mounted, connect your PC to the Configuration/Debug port using an RJ45-DB-9 Serial Adapter Cable and a Null Modem Cable.

1 Attach both cables as shown. 2 Insert the RJ45 cable connector into the Configuration/Debug port of the

module.

3 Attach the other end to the serial port on your PC.

ProSoft Technology, Inc. Page 37 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.3 Using ProSoft Configuration Builder

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

2.3.1 Setting Up the Project

To begin, start PROS

OFT CONFIGURATION BUILDER

(PCB).

If you have used other Windows configuration tools before, you will find the screen layout familiar. PCB’s window consists of a tree view on the left, and 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.

Page 38 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Adding the MVI56-MNETCR module to the project

1 Use the mouse to select D

EFAULT MODULE

in the tree view, and then click the

right mouse button to open a shortcut menu.

2 On the shortcut menu, choose C

HOOSE MODULE TYPE

. This action opens the

Choose Module Type dialog box.

3 In the Product Line Filter area of the dialog box, select MVI56. In the Select

Module Type dropdown list, select MVI56-MNETCR, and then click OK to

save your settings and return to the ProSoft Configuration Builder window.

ProSoft Technology, Inc. Page 39 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.3.2 Renaming PCB Objects

Notice that the contents of the information pane and the configuration pane changed when you added the module to the project.

At this time, you may wish to rename the Default Project and Default Location folders in the tree view.

1 Select the object, and then click the right mouse button to open a shortcut

menu. From the shortcut menu, choose R

ENAME

. 2 Type the name to assign to the object. 3 Click away from the object to save the new name.

Configuring Module Parameters

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

configuration options.

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

changes in the right pane.

5 Click OK to save your changes.

Page 40 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Creating Optional Comment Entries

1 Click the [+] to the left of the icon to expand the module

comments.

2 Double-click the icon. The Edit - Module Comment dialog box

appears.

3 Enter your comment and click OK to save your changes.

Printing a Configuration File

1 Select the module icon, and then click the right mouse button to open a

shortcut menu.

2 On the shortcut menu, choose V

IEW CONFIGURATION

. This action opens the

View Configuration window.

3 In the View Configuration window, open the F

ILE

menu, and choose P

RINT.

This action opens the Print dialog box.

4 In the Print dialog box, choose the printer to use from the drop-down list,

select printing options, and then click OK.

ProSoft Technology, Inc. Page 41 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.4 Module Configuration

2.4.1 Module

This section of the configuration describes the database setup and module level parameters. This section provides the module with a unique name, identifies the method of failure for the communications for the module if the processor is not in RUN mode, and describes how to initialize the module upon startup.

Error/Status Pointer

-1 to 4955 Starting register location in virtual Modbus database for the error/status table. If a

value of -1 is entered, the error/status data will not be placed in the database. All other valid values determine the starting location of the data. This data area includes the module version information and all error/status data.

Read Register Start

0 to 4999 The Read Register Start parameter specifies the start of the Read Data area in

module memory. Data in this area will be transferred from the module to the processor.

Note: Total user database memory space is limited to the first 5000 registers of module memory, addresses 0 through 4999. Therefore, the practical limit for this parameter is 4999 minus the value entered for Read Register Count, so that the Read Data Area does not try to extend above address

4999. Read Data and Write Data Areas must be configured to occupy separate address ranges in module memory and should not be allowed to overlap.

Read Register Count

0 to 5000 The Read Register Count parameter specifies the size of the Read Data area of

module memory and the number of registers to transfer from this area to the processor, up to a maximum of 5000 words.

Note: Total Read Register Count and Write Register Count cannot exceed 5000 total registers. Read Data and Write Data Areas must be configured to occupy separate address ranges in module memory and should not be allowed to overlap.

Page 42 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Write Register Start

0 to 4999 The Write Register Start parameter specifies the start of the Write Data area in

module memory. Data in this area will be transferred in from the processor.

Note: Total user database memory space is limited to the first 5000 registers of module memory, addresses 0 through 4999. Therefore, the practical limit for this parameter is 4999 minus the value entered for Write Register Count, so that the Write Data Area does not try to extend above address

4999. Read Data and Write Data Areas must be configured to occupy separate address ranges in module memory and should not be allowed to overlap.

Write Register Count

0 to 5000 The Write Register Count parameter specifies the size of the Write Data area of

module memory and the number of registers to transfer from the processor to this memory area, up to a maximum value of 5000 words.

Failure Flag Count

If this Value is greater than zero, the protocol communication will be interrupted once the backplane failure is detected, or communication with the processor fails. A value of zero will disable this feature.

Initialize Output Data

0 = No, 1 = Yes This parameter is used to determine if the output data for the module should be

initialized with values from the processor. If the value is set to 0, the output data will be initialized to 0. If the value is set to 1, the data will be initialized with data from the processor. Use of this option requires associated ladder logic to pass the data from the processor to the module.

ProSoft Technology, Inc. Page 43 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Duplex/Speed Code

0, 1, 2, 3 or 4 This parameter allows you to cause the module to use a specific duplex and

speed setting.

 Value = 1: Half duplex, 10 MB speed  Value = 2: Full duplex, 10 MB speed  Value = 3: Half duplex, 100 MB speed  Value = 4: Full duplex, 100 MB speed  Value = 0: Auto-negotiate

Auto-negotiate is the default value for backward compatibility. This feature is not implemented in older software revisions.

2.4.2 MNET Client x

This section defines general configuration for the MNET Client (Master).

Error/Status Pointer

-1 to 4990 Starting register location in virtual database for the error/status table for this

Client. If a value of -1 is entered, the error/status data will not be placed in the database. All other valid values determine the starting location of the data.

Command Error Pointer

-1 to 4999 This parameter sets the address in the internal database where the Command

Error List data will be placed so that it may be moved to the processor and placed into the ReadData array. Therefore, the value entered should be a module memory address in the Read Data area. If the value is set to -1, the Command Error List data will not be stored in the module's internal database and will not be transferred to the processor's ReadData array.

Minimum Command Delay

0 to 65535 milliseconds This parameter specifies the number of milliseconds to wait between the initial

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

Response Timeout

0 to 65535 milliseconds This is the 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 upon the type of communication network used, and the expected response time of the slowest device on the network.

Page 44 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Retry Count

0 to 10 This parameter specifies the number of times a command will be retried if it fails.

Float Flag

YES or NO

This flag specifies how the Server driver will respond to Function Code 3, 6, and 16 commands (read and write Holding Registers) from a remote Client when it is moving 32-bit floating-point data.

If the remote Client expects to receive or will send one complete 32-bit floatingpoint value for each count of one (1), then set this parameter to YES. When set to

YES, the Server driver will return values from two consecutive 16-bit internal

memory registers (32 total bits) for each count in the read command, or receive 32-bits per count from the Client for write commands. Example: Count = 10, Server driver will send 20 16-bit registers for 10 total 32-bit floating-point values.

If, however, the remote Client sends a count of two (2) for each 32-bit floatingpoint value it expects to receive or send, or, if you do not plan to use floatingpoint data in your application, then set this parameter to NO, which is the default setting.

You will also need to set the Float Start and Float Offset parameters to appropriate values whenever the Float Flag parameter is set to YES.

Float Start

0 to 65535

This parameter defines the first register of floating-point data. All requests with register values greater than or equal to this value will be considered floating-point data requests. This parameter is only used if the Float Flag is enabled. For example, if a value of 7000 is entered, all requests for registers 7000 and above will be considered as floating-point data.

Float Offset

0 to 9999 This parameter defines the start register for floating-point data in the internal

database. This parameter is used only if the Float Flag is enabled. For example, if the Float Offset value is set to 3000 and the Float Start parameter is set to 7000, data requests for register 7000 will use the internal Modbus register 3000.

ARP Timeout

1 to 60 This parameter specifies the number of seconds to wait for an ARP reply after a

request is issued.

ProSoft Technology, Inc. Page 45 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Command Error Delay

0 to 300 This parameter specifies the number of 100 millisecond intervals to turn off a

command in the error list after an error is recognized for the command. If this parameter is set to 0, there will be no delay.

MBAP Port Override

or NO

If this parameter is set to YES, all messages generated by the Client driver will be MBAP format messages to all Service Port values.

If this parameter is set to NO (default value), or is omitted from the configuration file, all messages sent to Service Port 502 will be MBAP format messages, and all other Service Ports values will use the encapsulated Modbus message format (MNET).

Each Client is configured independently in the configuration file. This parameter applies to firmware version 1.05 and above. For downward

compatibility, you may omit this parameter from the Client's configuration.

MNET Client x Commands

The MNET Client x Commands section of the configuration sets the Modbus TCP/IP Client command list. This command list polls Modbus TCP/IP server devices attached to the Modbus TCP/IP Client port. The module supports numerous commands. This permits the module to interface with a wide variety of Modbus TCP/IP protocol devices.

The function codes used for each command are those specified in the Modbus protocol. Each command list record has the same format. The first part of the record contains the information relating to the MVI56-MNETCR communication module, and the second part contains information required to interface to the Modbus TCP/IP server device.

Command List Overview

In order to interface the module with Modbus TCP/IP Server devices, you must construct a command list. The commands in the list specify the server device to be addressed, the function to be performed (read or write), the data area in the device to interface with and the registers in the internal database to be associated with the device data. The Client command list supports up to 16 commands.

The command list is processed from top (command #1) to bottom. A poll interval parameter is associated with each command to specify a minimum delay time in tenths of a second between the issuance of a command. If the user specifies a value of 10 for the parameter, the command will be executed no more frequently than every 1 second.

Page 46 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Commands Supported by the Module

The format of each command in the list depends on the Modbus Function Code being executed.

The following table lists the functions supported by the module.

Function Code Definition

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 Register 15 Force (Write) Multiple Coils 16 Preset (Write) Multiple Registers

Each command list record has the same general format. The first part of the record contains the information relating to the communication module and the second part contains information required to interface to the Modbus TCP/IP server device.

Command Entry Formats

The following table shows the structure of the configuration data necessary for each of the supported commands.

1 2 3 4 5 6 7 8 9 10

Enable Code

Code Register

Code Register 1/10th Seconds Word

Code 1 bit 1/10th Seconds Bit

Code 1 bit 1/10th Seconds Word

Code Register

Code Register 1/10th Seconds Word

Internal Address

(bit)

Poll Interval Time

1/10th Seconds Bit

Count Swap

Count

IP Address Serv

Code

0 IP Address Port # Address Read Coil (0x) Register

0 IP Address Port # Address Read Input (1x) Register

Code IP Address Port # Address Read Holding

0 IP Address Port # Address Read Input Registers

0 IP Address Port # Address Force (Write) Single

0 IP Address Port # Address Preset (Write) Single

0 IP Address Port # Address Force (Write)

0 IP Address Port # Address Preset (Write)

Port

Slave Node

Function Code Device Modbus

Address

Registers (4x)

(3x)

Coil (0x)

Multiple Coil (0x)

Multiple Register (4x)

ProSoft Technology, Inc. Page 47 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

The first part of the record is the module information, which relates to the MVI56 module and the second part contains information required to interface to the server device.

Command list example:

Enable

NO (0) or YES (1)

This field defines whether or not the command is to be executed.

Value Description

NO (0)

YES (1)

The command is disabled and will not be executed in the normal polling sequence. The command is executed each scan of the command list if the Poll Interval Time is

set to zero. If the Poll Interval time is set, the command will be executed when the interval timer expires.

Internal Address

0 to 4999 (for word-level addressing) or 0 to 65535 (for bit-level addressing) This field specifies the database address in the module's internal database to use

as the destination for data brought in by a read command or as the source for data to be sent out by a write command. The database address is interpreted as a bit address or a 16-bit word (register) address, depending on the Modbus Function Code used in the command.

 For Modbus functions 1, 2, 5, and 15, this parameter is interpreted as a bit-

level address.

 For Modbus functions 3, 4, 6, and 16, this parameter is interpreted as a word-

or register-level address.

Page 48 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Poll Interval

0 to 65535 This parameter specifies the minimum interval to execute continuous commands

(Enable code of 1). The parameter is entered in tenths of a second. Therefore, if a value of 100 is entered for a command, the command executes no more frequently than every 10 seconds.

Reg Count

Regs: 1 to 125 Coils: 1 to 800 This parameter specifies the number of 16-bit registers or binary bits to be

transferred by the command.

 Functions 5 and 6 ignore this field as they apply only to a single data point.  For functions 1, 2, and 15, this parameter sets the number of bits (inputs or

coils) to be transferred by the command.

 For functions 3, 4, and 16, this parameter sets the number of registers to be

transferred by the command.

Swap Code

ONE

WAP WORDS

WAP WORDS & BYTES

WAP BYTES

This parameter defines if and how the order of bytes in data received or sent is to be rearranged. This option exists to allow for the fact that different manufacturers store and transmit multi-byte data in different combinations. This parameter is helpful when dealing with floating-point or other multi-byte values, as there is no one standard method of storing these data types. The parameter can be set to rearrange the byte order of data received or sent into an order more useful or convenient for other applications. The following table defines the valid Swap Code values and the effect they have on the byte-order of the data.

Swap Code Description

ONE

WAP WORDS

WAP WORDS & BYTES

WAP BYTES

No change is made in the byte ordering (1234 = 1234) The words are swapped (1234=3412) The words are swapped, then the bytes in each word are swapped

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

These swap operations affect 4-byte (or 2-word) groups of data. Therefore, data swapping using these Swap Codes should be done only when using an even number of words, such as when 32-bit integer or floating-point data is involved.

ProSoft Technology, Inc. Page 49 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Node IP Address

xxx.xxx.xxx.xxx The IP address of the device being addressed by the command.

Service Port

502 or other supported ports on server

Use a value of 502 when addressing Modbus TCP/IP servers that are compatible with the Schneider Electric MBAP specifications (this will be most devices). If a server implementation supports another service port, enter the value here.

Slave Address

0 - Broadcast to all nodes 1 to 255

Use this parameter to specify the slave address of a remote Modbus Serial device through a Modbus Ethernet to Serial converter.

Note: Use the Node IP Address parameter (page 50) to address commands to a remote Modbus TCP/IP device. Note: Most Modbus devices accept an address in the range of only 1 to 247, so check with the slave device manufacturer to see if a particular slave can use addresses 248 to 255. If the value is set to zero, the command will be a broadcast message on the network. The Modbus protocol permits broadcast commands for write operations. Do not use node address 0 for read operations.

Modbus Function

1, 2, 3, 4, 5, 6, 15, or 16 This parameter specifies the Modbus Function Code to be executed by the

command. These function codes are defined in the Modbus protocol. The following table lists the purpose of each function supported by the module. More information on the protocol is available from www.modbus.org.

Modbus Function Code 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 Register 15 Force Multiple Coils 16 Preset Multiple Registers

Page 50 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

MB Address in Device

This parameter specifies the starting Modbus register or bit address in the Server to be used by the command. Refer to the documentation of each Modbus Server device for the register and bit address assignments valid for that device.

The Modbus Function Code determines whether the address will be a registerlevel or bit-level OFFSET address into a given data type range. The offset will be the target data address in the Server minus the base address for that data type. Base addresses for the different data types are:

 00001 or 000001 (0x0001) for bit-level Coil data (Function Codes 1, 5, and

15).

 10001 or 100001 (1x0001) for bit-level Input Status data (Function Code 2)  30001 or 300001 (3x0001) for Input Register data (Function Code 4)  40001 or 400001 (4x0001) for Holding Register data (Function Codes 3, 6,

and 16). Address calculation examples:  For bit-level Coil commands (FC 1, 5, or 15) to read or write a Coil 0X

address 00001, specify a value of 0 (00001 - 00001 = 0).  For Coil address 00115, specify 114

(00115 - 00001 = 114)  For register read or write commands (FC 3, 6, or 16) 4X range, for 40001,

specify a value of 0

(40001 - 40001 = 0).  For 01101, 11101, 31101 or 41101, specify a value of 1100.

(01101 - 00001 = 1100)

(11101 -10001 = 1100)

(31101 - 30001 = 1100)

(41101 - 40001 = 1100)

Note: If the documentation for a particular Modbus Server device lists data addresses in hexadecimal (base16) notation, you will need to convert the hexadecimal value to a decimal value to enter in this parameter. In such cases, it is not usually necessary to subtract 1 from the converted decimal number, as this addressing scheme typically uses the exact offset address expressed as a hexadecimal number.

Comment

0 to 35 alphanumeric characters

ProSoft Technology, Inc. Page 51 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.4.3 Static ARP Table

The Static ARP Table defines a list of static IP addresses that the module will use when an ARP (Address Resolution Protocol) is required. The module will accept up to 40 static IP/MAC address data sets.

Use the Static ARP table to reduce the amount of network traffic by specifying IP addresses and their associated MAC (hardware) addresses that the MVI56MNETCR module will be communicating with regularly.

Important: If the device in the field is changed, this table must be updated to contain the new MAC address for the device and downloaded to the module. If the MAC is not changed, no communications with the module will be provided.

IP Address

Dotted notation This table contains a list of static IP addresses that the module will use when an

ARP is required. The module will accept up to 40 static IP/MAC address data sets.

Hardware MAC Address

Hex value This table contains a list of static MAC addresses that the module will use when

an ARP is required. The module will accept up to 40 static IP/MAC address data sets.

Page 52 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Configuring the MVI56-MNETCR Module Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

2.4.4 Ethernet Configuration

Use this procedure to configure the Ethernet settings for your module. You must assign an IP address, subnet mask and gateway address. After you complete this step, you can connect to the module with an Ethernet cable.

1 Determine the network settings for your module, with the help of your network

administrator if necessary. You will need the following information:

IP address (fixed IP required) _____ . _____ . _____ . _____

Subnet mask _____ . _____ . _____ . _____

Gateway address _____ . _____ . _____ . _____

Note: The gateway address is optional, and is not required for networks that do not use a default gateway.

2 Double-click the E

dialog box.

THERNET CONFIGURATION

icon. This action opens the Edit

3 Edit the values for my_ip, netmask (subnet mask) and gateway (default

gateway). 4 When you are finished editing, click OK to save your changes and return to

the ProSoft Configuration Builder window.

ProSoft Technology, Inc. Page 53 of 127 February 14, 2011

Configuring the MVI56-MNETCR Module MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

2.5 Downloading the Project to the Module Using a Serial COM port

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

1 In the tree view in ProSoft Configuration Builder, click once to select the

module.

2 Open the Project menu, and then choose M

will scan your PC for a valid com port (this may take a few seconds). When PCB has found a valid COM port, the Download dialog box will open.

ODULE/DOWNLOAD

. The program

3 Choose the COM port to use from the dropdown list, and then click the

OWNLOAD

button.

The module will perform a platform check to read and load its new settings. When the platform check is complete, the status bar in the Download dialog box will display the message Module Running.

Page 54 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Ladder Logic Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

3 Ladder Logic

In This Chapter

 Module Data Object (MNETCRMODULEDEF) ...................................... 56

Ladder logic is required for application of the MVI56-MNETCR module. Tasks that must be handled by the ladder logic are module data transfer, special block handling, and status data receipt. Additionally, a power-up handler may be needed to handle the initialization of the module’s data and to clear any processor fault conditions.

The sample ladder logic, on the ProSoft Solutions CD-ROM, is extensively commented, to provide information on the purpose and function of each rung. For most applications, the sample ladder will work without modification.

ProSoft Technology, Inc. Page 55 of 127 February 14, 2011

Ladder Logic MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

3.1 Module Data Object (MNETCRMODULEDEF)

All data related to the MVI56-MNETCR is stored in a user defined data type. An instance of the data type is required before the module can be used. This is done by declaring a variable of the data type in the C dialog box. The following table describes the structure of this object.

Name Data Type Description

DATA MNETCRDATA (page

57)

CONTROL MNETCRCONTROL

(page 58)

STATUS MNETCRSTATUS

(page 59)

UTIL MNETCRUTIL (page

61)

This object contains objects that define the configuration, user data, status and command control data related to the module.

ONTROLLER TAGS EDIT TAGS

Data read from module

MNETCR Module control

Client ,Server Status and blocks status

Block statistics

Page 56 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Ladder Logic Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

3.1.1 User Data Object (MNETCRDATA)

These objects hold data to be transferred between the processor and the MVI56MNETCR module. The user data is the read and write data transferred between the processor and the module as "pages" of data up to 200 words long.

Name Data Type Description

ReadData INT[600] Data Read from the Module. Set array equal to

the size set in the Configuration file.

WriteData INT[600] Data Write to the Module. Set array equal to

the size set in the Configuration file.

ReadData is a controller tag array that should be sized to match the value entered in the R Configuration Builder (PCB) (page 42). For ease of use, both this array and the

EAD REGISTER COUNT

This data is paged up to 40 words at a time from the module to the processor. The ReadData ladder logic task places the data received into the proper position in the MNETCR.DATA.ReadData array. The data received in the ReadData array will contain status and control information sent by other nodes on the network for use by processor logic. The ReadData array may also be used to hold certain module status and error data which can then be monitored by processor logic.

WriteData is a controller tag array that should be sized to match the value entered in the W (page 43). For ease of use, both this array and the W parameter should be dimensioned in even increments of 40 words. This data is paged up to 40 words at a time from the processor to the module. The WriteData ladder logic task gets the data from the proper position in the MNETCR.DATA.WriteData and puts that data into the output image for transfer to the module. Once the data has been stored in the module's database, it is available for use as status and control information by other nodes on the network.

EAD REGISTER COUNT

should be dimensioned in even increments of 40 words.

RITE REGISTER COUNT

parameter of the .CFG file or in ProSoft

parameter of the .CFG file or in PCB

RITE REGISTER COUNT

ProSoft Technology, Inc. Page 57 of 127 February 14, 2011

Ladder Logic MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

3.1.2 Command Control Data Object (MNETCCONTROL)

Values used by program for data transfer operation between the module and the processor.

Name Data Type Description

BootTimer TIMER Timer used to clear both cold and warm

boot requests WarmBoot BOOL Hardware reset of the Module ColdBoot BOOL Configuration data reset in the Module EventCmdTrigger BOOL Initiates Event Command. EventCmdPending BOOL Allows Event Command. ClientID INT Client ID to poll a server with the Event

Command. EventCmd MNETCREVENTCMD

(page 58)

CmdControl MNETCRCMDCONTROL

(page 59) CmdControlTrigger BOOL Initiates Command Control. CmdControlPending BOOL Halts rung until Module is ready IPAddress MNETCRIPADDRESS

(page 59) WriteCmdBits INT[30] Selects individual clients to to activate its

Holds Event Command configuration

Holds Command Control status

IP address statistics including triggers

commands.

Event Command Data Object (MNETCREVENTCMD)

The Event object is not placed in the module definition object and is only required when event commands are utilized in the application. This structure holds the information required for an event command. An array of these objects should be defined and hold the event command set to be employed in the application. The following illustration shows the structure of the object.

Name Data Type Description

IP0 INT First digit of IP address IP1 INT Second digit of IP address IP2 INT Third digit of IP address IP3 INT Last digit of IP address ServPort INT TCP Service Port number (0-65535), 502 for MBAP,

2000 for MNET SlvAddrNode INT Modbus slave node address (0 to 247) DBAddress INT Module internal database to use with message Count INT Register or data point count Swap INT Swap code to use with functions 3 and 4 MBFunction INT Modbus function code for message Address INT Address to interface with in device

Page 58 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Ladder Logic Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Command Control Data Object (MNETCRCMDCONTROL)

MVI56-MNETCR Command Control

Name Data Type Description

ClientIDreq INT Requested Client ID. CmdQty INT Command Quantity for the Client. CmdIndex INT[16] Command Index per client. (0 to 15)

IP Address Object (MNETCRIPADDRESS)

This object holds IP address status with set IP & get IP triggers.

Name Data Type Description

IPgetTrigger BOOL Triggers get IP address. IPreceived INT[4] Displays received IP address. IPsetTrigger BOOL Triggers set IP address IPrequested INT[4] Displays requested IP address

3.1.3 Status Object (MNETCRSTATUS)

This object contains the status of the module. The MNETCRSTATUS object is updated each time a read block is received by the processor. Use this data to monitor the state of the module at a "real-time rate".

Name Data Type Description

PassCnt INT Program cycle counter BlockStats MNETCRBLOCKSTATS

(page 60)

CmdBits INT[30] Commands bits array to be used for 30

ClientStatsTrigger BOOL Get Client Status ClientIDReq INT Client ID requested. ClientStatus MNETCRCLIENTSTATS[30]

(page 60) ClientIDRec INT Client ID received. CmdErrorList INT[16] Command Error List ClientStatsPending BOOL Allows Get Client Status

Block Statistics

clients

Client Status requests

ProSoft Technology, Inc. Page 59 of 127 February 14, 2011

Ladder Logic MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Block Statistics Object (MNETCRBLOCKSTATS)

This object contains a structure that includes the status information for the data transfer operations between the processor and the module. The following table describes the structure of this object.

Name Data Type Description

Read INT Total number of read block transfers Write INT Total number of write block transfers Parse INT Total number of blocks parsed Event INT Total number of event blocks received Cmd INT Total number of command blocks received Err INT Total number of block transfer errors

Client Statistics Object (MNETCRCLIENTSTATS)

This block also contains a structure that includes Client statistics. The following table describes the structure of this object.

Name Data Type Description

CmdReq INT Total number of command list requests sent CmdResp INT Total number of command list responses received CmdErr INT Total number of command list errors Requests INT Total number of requests for port Responses INT Total number of responses for port ErrSent INT Total number of errors sent ErrRec INT Total number of errors received CfgErrWord INT Configuration Error Word CurErr INT Current Error code LastErr INT Last recorded error code

Refer to MVI56-MNETCR Status Data Definition (page 92, page 99) for a complete listing of the data stored in the status object.

Page 60 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Ladder Logic Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

3.1.4 Backplane Control Object (MNETCRUTIL)

This data object stores the variables required for the data transfer between the processor and the MVI56-MNETCR module. The following table shows the structure of the object.

Name Data Type Description

LastRead INT Index of last read block LastWrite INT Index of last write block BlockIndex INT Computed block offset for data table ReadDataSizeGet INT Gets ReadData Array Length. WriteDataSizeGet INT Gets WriteData Array Length. ReadDataBlkCount INT Holds the value of the Block Counts of the Read Data

Array.

WriteDataBlkCount INT Holds the value of the Block Counts of the Write Data

Array.

RBTSremainder INT Holds remainder calculation value from the read

array.

WBTSremainder INT Holds remainder calculation value from the write

array. IPgetPending BOOL Allows setting module IP address IPsetPending BOOL Allows getting module IP address

The LastRead tag stores the latest Read Block ID received from the module. The LastWrite tag stores the latest Write Block ID to be sent to the module. The Block Index tag is an intermediate variable used during the block calculation.

ProSoft Technology, Inc. Page 61 of 127 February 14, 2011

Ladder Logic MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Page 62 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

4 Diagnostics and Troubleshooting

In This Chapter

 LED Status Indicators ............................................................................ 64

 Using ProSoft Configuration Builder (PCB) for Diagnostics................... 68

 Reading Status Data from the Module .................................................. 79

The module provides information on diagnostics and troubleshooting in the following forms:

 LED status indicators on the front of the module provide general information

on the module's status.

 Status data contained in the module can be viewed through the

Configuration/Debug port, using the troubleshooting and diagnostic capabilities of ProSoft Configuration Builder (PCB).

 Status data values can be transferred from the module to processor memory

and can be monitored there manually or by customer-created logic. For details on Status Data values, see MVI56-MNETCR Status Data Area.

ProSoft Technology, Inc. Page 63 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4.1 LED Status Indicators

The LEDs indicate the module’s operating status as follows:

LED Color Status Indication

CFG Green On Data is being transferred between the module and a remote

Off No data is being transferred on the Configuration/Debug port. EP Green On Indicator not used Off Indicator not used APP Amber Off The MVI56-MNETCR is working normally. On The MVI56-MNETCR module program has recognized a

BP Amber On The LED is on when the module is performing a write operation

Off The LED is off when the module is performing a read operation

OK Red/

Green

Green The module is operating normally.

BAT Red Off The battery voltage is OK and functioning. On The battery voltage is low or battery is not present. Allow

Red The program has detected an error or is being configured. If

Off The card is not receiving any power and is not securely

terminal using the Configuration/Debug port.

communication error with a server on the network.

on the backplane.

on the backplane. Under normal operation, the LED should blink rapidly on and off.

plugged into the rack.

the LED remains red for over 10 seconds, the program has probably halted. Remove the card from the rack and re-insert the card to restart the module’s program.

battery to charge by keeping module plugged into rack for 24 hours. If BAT LED still does not go off, contact ProSoft Technology, as this is not a user serviceable item.

Page 64 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

If a configuration error is found for the client, the client configuration error word will have a value other than zero. The configuration error word bits have the following definitions:

Bit Description Value

0 0x0001 1 0x0002 2 0x0004 3 0x0008 4 Invalid retry count parameter 0x0010 5 The float flag parameter is not valid. 0x0020 6 The float start parameter is not valid. 0x0040 7 The float offset parameter is not valid. 0x0080 8 ARP Timeout is not in range (ARP Timeout <= 0 || ARP

Timeout > 60) and will default to 5 9 Command Error Delay is > 300 and will default to 300 0x0200 10 0x0400 11 0x0800 12 0x1000 13 0x2000 14 0x4000 15 0x8000

0x0100

Correct any invalid data in the configuration for proper module operation. When the configuration contains a valid parameter set, all the bits in the configuration word will be clear. This does not indicate that the configuration is valid for the user application. Make sure each parameter is set correctly for the specific application.

If the APP, BP ACT and OK LEDs blink at a rate of every one-second, call ProSoft Technology support. There is a serious problem with the module, and it will have to be sent back to ProSoft.

ProSoft Technology, Inc. Page 65 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4.1.1 Ethernet LED Indicators

LED State Description

Data OFF No activity on the Ethernet port.

GREEN Flash The Ethernet port is actively transmitting or receiving data.

Link OFF No physical network connection is detected. No Ethernet

communication is possible. Check wiring and cables.

GREEN Solid Physical network connection detected. This LED must be ON

solid for Ethernet communication to be possible.

4.1.2 Clearing a Fault Condition

Typically, if the OK LED on the front of the module turns RED for more than ten seconds, a hardware problem has been detected in the module or the program has exited.

To clear the condition, follow these steps:

1 Turn off power to the rack. 2 Remove the card from the rack. 3 Verify that all jumpers are set correctly. 4 If the module requires a Compact Flash card, verify that the card is installed

correctly.

5 Re-insert the card in the rack and turn the power back on. 6 Verify correct configuration data is being transferred to the module from the

ControlLogix controller.

If the module's OK LED does not turn GREEN, verify that the module is inserted completely into the rack. If this does not cure the problem, contact ProSoft Technology Technical Support.

4.1.3 Troubleshooting

Use the following troubleshooting steps if you encounter problems when the module is powered up. If these steps do not resolve your problem, please contact ProSoft Technology Technical Support.

Processor Errors

Problem description Steps to take

Processor fault Verify that the module is plugged into the slot that has been configured

for the module in the I/O Configuration of RSLogix.

Verify that the slot location in the rack has been configured correctly in

the ladder logic.

Processor I/O LED flashes

Page 66 of 127 ProSoft Technology, Inc. February 14, 2011

This indicates a problem with backplane communications. A problem

could exist between the processor and any installed I/O module, not just

the MVI56-MNETCR. Verify that all modules in the rack are correctly

configured in the ladder logic.

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Module Errors

Problem description Steps to take

BP ACT LED (not present on MVI56E modules) remains OFF or blinks slowly

MVI56E modules with scrolling LED display: <Backplane Status> condition reads ERR

OK LED remains RED The program has halted or a critical error has occurred. Connect to the

This indicates that backplane transfer operations are failing. Connect to the module’s Configuration/Debug port to check this.

To establish backplane communications, verify the following items:

 The processor is in RUN or REM RUN mode.  The backplane driver is loaded in the module.  The module is configured for read and write data block transfer.  The ladder logic handles all read and write block situations.  The module is properly configured in the processor I/O configuration

and ladder logic.

Configuration/Debug port to see if the module is running. If the program has halted, turn off power to the rack, remove the card from the rack and re-insert it, and then restore power to the rack.

ProSoft Technology, Inc. Page 67 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4.2 Using ProSoft Configuration Builder (PCB) for Diagnostics

The Configuration and Debug menu for this module is arranged as a tree structure, with the Main menu at the top of the tree, and one or more submenus for each menu command. The first menu you see when you connect to the module is the Main menu.

Because this is a text-based menu system, you enter commands by typing the [command letter] from your computer keyboard in the Diagnostic window in ProSoft Configuration Builder (PCB). The module does not respond to mouse movements or clicks. The command executes as soon as you press the

[

COMMAND LETTER

[

COMMAND LETTER

] — you do not need to press [E

NTER].

When you type a

], a new screen will be displayed in your terminal application.

4.2.1 Using the Diagnostic Window in ProSoft Configuration Builder

To connect to the module’s Configuration/Debug serial port 1 Start PCB, and then select the module to test. Click the right mouse button to

open a shortcut menu.

2 On the shortcut menu, choose D

IAGNOSTICS

This action opens the Diagnostics dialog box.

Page 68 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

3 Press [?] to open the Main menu.

If there is no response from the module, follow these steps: 1 Click to configure the connection. On the Connection Setup dialog box, select

a valid com port or other connection type supported by the module.

2 Verify that the null modem cable is connected properly between your

computer’s serial port and the module. A regular serial cable will not work.

3 On computers with more than one serial port, verify that your communication

program is connected to the same port that is connected to the module.

If you are still not able to establish a connection, contact ProSoft Technology for assistance.

ProSoft Technology, Inc. Page 69 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4.2.2 Navigation

All of the submenus for this module contain commands to redisplay the menu or return to the previous menu. You can always return from a submenu to the next higher menu by pressing [M] on your keyboard.

The organization of the menu structure is represented in simplified form in the following illustration:

The remainder of this section shows the menus available for this module, and briefly discusses the commands available to you.

Keystrokes

The keyboard commands on these menus are usually not case sensitive. You can enter most commands in lowercase or uppercase letters.

The menus use a few special characters (?, -, +, @) that must be entered exactly as shown. Some of these characters will require you to use the SHIFT, CTRL, or

ALT keys to enter them correctly. For example, on US English keyboards, enter

the ? command as SHIFT and /. Also, take care to distinguish the different uses for uppercase letter "eye" (I),

lowercase letter "el" (L), and the number one (1). Likewise, uppercase letter "oh" (O) and the number zero (0) are not interchangeable. Although these characters look alike on the screen, they perform different actions on the module and may not be used interchangeably.

Page 70 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

4.2.3 Main Menu

When you first connect to the module from your computer, your terminal screen will be blank. To activate the main menu, press the [?] key on your computer’s keyboard. If the module is connected properly, the following menu will appear.

Caution: Some of the commands available to you from this menu are designed for advanced debugging and system testing only, and can cause the module to stop communicating with the processor or with other devices, resulting in potential data loss or other failures. Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff. Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command.

Viewing Block Transfer Statistics

Press [B] from the Main menu to view the Block Transfer Statistics screen. Use this command to display the configuration and statistics of the backplane

data transfer operations between the module and the processor. The information on this screen can help determine if there are communication problems between the processor and the module.

Tip: To determine the number of blocks transferred each second, mark the numbers displayed at a specific time. Then some seconds later activate the command again. Subtract the previous numbers from the current numbers and divide by the quantity of seconds passed between the two readings.

Viewing Module Configuration

Press [C] to view the Module Configuration screen. Use this command to display the current configuration and statistics for the

module.

ProSoft Technology, Inc. Page 71 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Opening the Database View Menu

Press [D] to open the Database View menu. Use this menu command to view the current contents of the module’s database.

For more information about this submenu, see Database View Menu (page 74).

Opening the Command List Menu

Press [L] to open the Command List menu. Use this command to view the configured command list for the module.

Opening the Command Error List Menu

Press [I] to open the Command Error List. This list consists of multiple pages of command list error/status data. Press [?] to view a list of commands available on this menu.

Receiving the Configuration File

Press [R] to download (receive) the current configuration file from the module.

Sending the Configuration File

Press [S] to upload (send) a configuration file from the module to your PC.

Resetting Diagnostic Data

Press [U] to reset the status counters for the Client and/or servers in the module.

Viewing Version Information

Press [V] to view version information for the module. Use this command to view the current version of the software for the module, as

well as other important values. You may be asked to provide this information when calling for technical support on the product.

Values at the bottom of the display are important in determining module operation. The Program Scan Counter value is incremented each time a module’s program cycle is complete.

Tip: Repeat this command at one-second intervals to determine the frequency of program execution.

Viewing Client Status

Press [0] (zero) to display the statistics of the Client.

Viewing NIC Status

Press [4] to view NIC status. Use this command to view the communication status for the Network Interface Card.

Page 72 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Viewing Client Configuration

Press [5] to display the configuration information for the Client.

Viewing the Static ARP Table

Press [7] to view the Static ARP Table. Use this command to view the list of IP and MAC addresses that are configured not to receive ARP messages from the module.

Opening the Network Menu

Press [@] to open the Network menu. The Network menu allows you to send, receive and view the WATTCP.CFG file

that contains the IP, gateway and other network specification information. For more information about this submenu, see Network Menu (page 77).

Warm Booting the Module

Press [W] from the Main menu to warm boot (restart) the module. This command will cause the program to exit and reload, refreshing configuration

parameters that must be set on program initialization. Only use this command if you must force the module to reboot.

Exiting the Program

Press [ESC] to restart the module and force all drivers to be loaded. The module will use the configuration stored in the module's Flash memory to configure the module.

ProSoft Technology, Inc. Page 73 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

4.2.4 Modbus Database View Menu

Press [D] to open the Modbus Database View menu. Use this command to view the module’s internal database values. Press [?] to view a list of commands on this menu.

All data contained in the module’s database is available for viewing using the commands. Refer to the Modbus Protocol Specification for information on the structure of Modbus messages. Each option available on the menu is discussed in the following topics.

Viewing Register Pages

To view sets of register pages, use the keys described below:

Command Description [0] [1] [2]

Display registers 0 to 99 Display registers 1000 to 1099 Display registers 2000 to 2099

And so on. The total number of register pages available to view depends on your module’s configuration.

Redisplaying the Current Page

Press [S] to display the current page of data.

Moving Back Through 5 Pages of Registers

Press [-] from the Database View menu to skip five pages back in the database to see the 100 registers of data starting 500 registers before the currently displayed page.

Viewing the Previous Page of Registers

Press [P] from the Database View menu to display the previous page of data.

Page 74 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Moving Forward Through 5 Pages of Registers

Press [+] from the Database View menu to skip five pages ahead in the database to see 100 registers of data 500 registers ahead of the currently displayed page.

Viewing the Next Page of Registers Press [N] from the Database View menu to display the next page of data.

Viewing Data in Decimal Format

Press [D] from the Database View menu to display the data on the current page in decimal format.

Viewing Data in Hexadecimal Format

Press [H] from the Database View menu to display the data on the current page in hexadecimal format.

Viewing Data in Floating-Point Format

Press [F] from the Database View menu to display the data on the current page in floating-point format. The program assumes that the values are aligned on even register boundaries. If floating-point values are not aligned as such, they are not displayed properly.

Viewing Data in ASCII (Text) Format

Press [A] from the Database View menu to display the data on the current page in ASCII format. This is useful for regions of the database that contain ASCII data.

Returning to the Main Menu Press [M] to return to the Main menu.

4.2.5 Command List Menu

Use this menu to view the configured command list for the module. Press [?] to view a list of commands available on this menu.

ProSoft Technology, Inc. Page 75 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Redisplaying the Menu

Press [?] to display the current menu. Use this command when you are looking at a screen of data, and want to view the menu choices available to you.

Viewing the Previous Page of Commands

Press [P] to display the previous page of commands.

Viewing the Next Page of Commands

Press [N] to display the next page of commands.

Returning to the Main Menu Press [M] to return to the Main menu.

4.2.6 Master Command Error List Menu

Use this menu to view the command error list for the module. Press [?] to view a list of commands available on this menu.

Redisplaying the Menu

Press [?] to display the current menu. Use this command when you are looking at a screen of data, and want to view the menu choices available to you.

Viewing the Previous Page of Commands

Press [P] to display the previous page of commands.

Viewing the Next Page of Commands

Press [N] to display the next page of commands.

Returning to the Main Menu

Press [M] to return to the Main menu.

Page 76 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

4.2.7 Network Menu

From the IEC-870-5-104 Server menu press [@] to display the IEC-870-5-104 Network menu screen. The Network menu allows you to send, receive, and view

the WATTCP.CFG file that contains the IP and module addresses, and other network information.

Transferring WATTCP.CFG to the Module

Press [R] to transfer a new WATTCP.CFG file from the PC to the module. Use this command to change the network configuration for the module (for example, the module’s IP address).

Press [Y] to confirm the file transfer, and then follow the instructions on the terminal screen to complete the file transfer process.

Transferring WATTCP.CFG to the PC

Press [S] to transfer the WATTCP.CFG file from the module to your PC. Press [Y] to confirm the file transfer, and then follow the instructions on the

terminal screen to complete the file transfer process. After the file has been successfully transferred, you can open and edit the file to

change the module’s network configuration.

ProSoft Technology, Inc. Page 77 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Viewing the WATTCP.CFG File on the module

Press [V] to view the module’s WATTCP.CFG file. Use this command to confirm the module’s current network settings.

Returning to the Main Menu

Press [M] to return to the Main menu.

Page 78 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Diagnostics and Troubleshooting Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

4.3 Reading Status Data from the Module

The MVI56-MNETCR module maintains a Status Data Table that can be used to determine the module’s operating status. This data is located in the module’s database at the location specified by the Error Status Pointer configuration parameter (page 42). This data is transferred to the processor continuously. For a complete listing of the status data object, refer to Status Data Definition (page 92, page 99).

The Configuration/Debug port provides the following functionality:

 Full view of the module’s configuration data  View of the module’s status data  Complete display of the module’s internal database (registers 0 to 3999)  Version Information  Control over the module (warm boot, cold boot, transfer configuration)  Facility to upload and download the module’s configuration file

ProSoft Technology, Inc. Page 79 of 127 February 14, 2011

Diagnostics and Troubleshooting MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Page 80 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

5 Reference

In This Chapter

 Product Specifications ........................................................................... 82

 Functional Overview .............................................................................. 85

 Data Flow between MVI56-MNETCR Module, Processor, and Network98

 Cable Connections .............................................................................. 106

 Adding the Module to an Existing Project ............................................ 110

 Using the Sample Program - RSLogix 5000 Version 15 and earlier .... 113

ProSoft Technology, Inc. Page 81 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

5.1 Product Specifications

The MVI56 Modbus TCP/IP Multi Client Communication Module for Remote Chassis allows Rockwell Automation® ControlLogix® Programmable Automation Controllers (PACs) to interface easily with multiple Modbus TCP/IP servercompatible instruments and devices. The multi-Client module improves performance when controlling multiple servers on a Modbus TCP/IP network, by supporting up to 30 Clients.

MVI56E enhancements include configuration and management through the module’s Ethernet port, CIPconnect® technology for bridging though ControlNet™ and EtherNet/IP™ networks, and a web server to access on-board documentation, Add-On Instructions, and sample program files.

This module uses a small I/O data image for transfer of data between the module and the ControlLogix processor, making it ideal for ControlNet or Ethernet applications with the module in a remote rack.

5.1.1 General Specifications

 Backward compatible with previous MVI56-MNETC versions  Single-slot 1756 ControlLogix backplane compatible  10/100 Mbps auto crossover detection Ethernet configuration and application

port

 User-definable module data memory mapping of up to 5000 16-bit registers  CIPconnect-enabled network configuration and diagnostics monitoring using

ControlLogix 1756-ENxT and 1756-CNB modules

 ProSoft Configuration Builder (PCB) software supported, a Windows-based

graphical user interface providing simple product and network configuration

 Sample ladder logic and Add-On Instructions (AOI) are used for data transfer

between module and processor

 Internal web server provides access to product documentation, module

status, diagnostics, and firmware updates

 4-character, alpha-numeric, scrolling LED display of status and diagnostics

data in plain English – no cryptic error or alarm codes to decipher

 ProSoft Discovery Service (PDS) software used to locate the module on the

network and assign temporary IP address

 Personality Module - a non-volatile industrial-grade Compact Flash (CF) card

used to store network and module configuration for easy disaster recovery, allowing quick in-the-field product replacement by transferring the CF card

Page 82 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Modbus TCP/IP Client (Master)

The MVI56-MNETCR is a Client-only module that will operate on a local or remote rack. This module was created to improve performance when controlling multiple servers on a Modbus TCP/IP network. The module supports up to 30 Clients with up to 16 commands for each Client.

 Actively reads data from and writes data to Modbus TCP/IP devices, using

MBAP or Encapsulated Modbus message formats

 Transmits Modbus Function Codes 1, 2, 3, 4, 5, 6, 7, 15, and 16  Offers 30 Client connections with up to 16 commands each to talk to multiple

servers

 ControlLogix processor can be programmed to use special functions to

control the activity on the Client by actively selecting commands to execute from the command list (Command Control) or by issuing commands directly from the ladder logic (Event Commands)

5.1.2 Functional Specifications

 Modbus data types overlap in the module's memory database, so the same

data can be conveniently read or written as bit-level or register-level data.

 Configurable floating point data movement is supported, including support for

Enron or Daniel® floating point formats

 Special functions (command control, event commands, status, etc.) are

supported by message transfer (unscheduled) using the MSG instruction

 Configurable parameters for the Client including a minimum response delay

of 0 to 65535 ms and floating point support

 Supports up to 30 Clients with up to 16 commands for each Client  Error codes, counters, and module status available from module memory

through the Clients, or through the ladder logic and controller tags in RSLogix 5000

ProSoft Technology, Inc. Page 83 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

5.1.3 Hardware Specifications

Specification Description

Backplane Current Load 800 mA @ 5 Vdc

3 mA @ 24 Vdc Operating Temperature 32°F to 140°F (0° C to 60°C) Storage Temperature -40°F to 185°F (-40° C to 85°C) Shock 30 g operational

50 g non-operational

Vibration: 5 g from 10 Hz to 150 Hz Relative Humidity 5% to 95% (without condensation) LED Indicators Module Status

Backplane Transfer Status

Application Status

Serial Activity

Application port (Ethernet)

Ethernet Port (Ethernet modules) 10/100 Base-T

RJ45 Connector

Link and activity LED indicators

Electrical Isolation 1500 V rms at 50 Hz to 60 Hz

for 60 s, 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 Unit RJ45 to DB-9M cables for each port

6-foot RS-232 configuration cable

Debug/Configuration port (CFG)

CFG Port (CFG) RJ45 (DB-9M with supplied cable)

No hardware handshaking

Page 84 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

5.2 Functional Overview

5.2.1 About the MODBUS/TCP Protocol

MODBUS is a widely-used protocol originally developed by Modicon in 1978. Since that time, the protocol has been adopted as a standard throughout the automation industry.

The original MODBUS specification uses a serial connection to communicate commands and data between client and server devices on a network. Later enhancements to the protocol allow communication over Ethernet networks using TCP/IP as a "wrapper" for the MODBUS protocol. This protocol is known as MODBUS/TCP.

MODBUS/TCP is a client/server protocol. The client establishes a connection to the remote server. When the connection is established, the client sends the MODBUS/TCP commands to the server. The MVI56-MNETCR module simulates up to 30 clients.

Aside from the benefits of Ethernet versus serial communications (including performance, distance, and flexibility) for industrial networks, the MODBUS/TCP protocol allows for remote administration and control of devices over an Internet connection. It is important to note that not all Internet protocols are implemented in the module, for example, HTTP and SMTP protocols are not available. Nevertheless, the efficiency, scalability, and low cost of a MODBUS/TCP network make this an ideal solution for industrial applications.

The MVI56-MNETCR module acts as an input/output module between devices on a MODBUS/TCP network and the Rockwell Automation backplane. The module uses an internal database to pass data and commands between the processor and the server devices on the MODBUS/TCP network.

5.2.2 Backplane Data Transfer

The MVI56-MNETCR module communicates directly over the ControlLogix backplane. Data is paged between the module and the ControlLogix processor across the backplane using the module's input and output images. The update frequency of the images is determined by the scheduled scan rate defined by the user for the module and the communication load on the module. Typical updates are in the range of 1 to 10 milliseconds.

This bi-directional transference of data is accomplished by the module filling in data in the module's input image to send to the processor. Data in the input image is placed in the Controller Tags in the processor by the ladder logic. The input image for the module is set to 42 words. This data is transferred in the scheduled I/O timeslot.

The processor inserts data to the module's output image to transfer to the module. The module's program extracts the data and places it in the module's internal database. The output image for the module is set to 42 words. This data is transferred in the scheduled I/O timeslot.

ProSoft Technology, Inc. Page 85 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

The following illustration shows the data transfer method used to move data between the ControlLogix processor, the MVI56-MNETCR module and the Modbus TCP/IP Network.

All data transferred between the module and the processor over the backplane is through the input and output images. Ladder logic must be written in the ControlLogix processor to interface the input and output image data with data defined in the Controller Tags. All data used by the module is stored in its internal database. This database is defined as a virtual Modbus data table with addresses from 0 (40001 Modbus) to 4999 (45000 Modbus). The following illustration shows the layout of the database:

Module’s Internal Database Structure

5000 registers for user data

4999

Data contained in this database is paged through the input and output images by coordination of the ControlLogix ladder logic and the MVI56-MNETCR module's program. Up to 40 words of data can be transferred from the module to the processor at a time. Up to 40 words of data can be transferred from the processor to the module. Each image has a defined structure depending on the data content and the function of the data transfer. The module uses the following block numbers:

Page 86 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference

Block Range

Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Descriptions

-1 Null block 0 Null block 1 to 125 Read or write data 1000 to 1124 Output Initialization Blocks 2000 to 2029 Event Command Block (page 90) 3000 to 3029 Client status request/response blocks (page 92) 5001 to 5016 Command Control (page 93, page 90) 9990 Set new module IP address (page 94) 9991 Get module IP address 9998 Warm-boot control block (page 96, page 73) 9999 Cold-boot control block

These block identification codes can be broken down into a few groups: Normal data transfer blocks (-1 to 125), Initialization blocks (1000 to 1124), and Command control blocks (2000, 5000 to 5016, 9998 and 9999).

Normal Data Transfers

Normal data transfer includes the paging of the user data and status data found in the module’s internal database in registers 0 to 4999. These data are transferred through read (input image) and write (output image) blocks. The following topics describe the function and structure of each block.

Block Response from Module to Processor

These blocks of data transfer information from the module to the ControlLogix processor. The following table describes the structure of the input image.

Offset Description Length

0 Write Block ID 1 1 to 40 Read Data 40 41 Read Block ID 1

The Read Block ID is an index value used to determine the location of where the data will be placed in the ControlLogix processor controller tag array of module read data. Each transfer can move up to 40 words (block offsets 1 to 40) of data. In addition to moving user data, the block also contains status data for the module.

The Write Block ID associated with the block requests data from the ControlLogix processor. Under normal program operation, the module sequentially sends read blocks and requests write blocks.

For example, if the application uses three read and two write blocks, the sequence will be as follows:

R1W1→R2W2→R3W1→R1W2→R2W1→R3W2→R1W1→

ProSoft Technology, Inc. Page 87 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

This sequence will continue until interrupted by other write block numbers sent by the controller or by a command request from a node on the Modbus network or operator control through the module’s Configuration/Debug port.

Block Request from Processor to Module

These blocks of data transfer information from the ControlLogix processor to the module. The following table describes the structure of the output image.

Offset Description Length

0 Write Block ID 1 1 to 40 Write Data 40 41 Spare 1

The Write Block ID is an index value used to determine the location in the module’s database where the data will be placed. Each transfer can move up to 40 words (block offsets 1 to 40) of data.

Status Read Data Block IDs 0 and -1

This block is automatically copied from the module into the MNETCR.STATUS array when the block ID is 0 or -1, and contains status information about the module.

Offset Description Length

0 Write Block ID 1 1 Program Scan Counter 1 2 to 7 Block Transfer Status; Read, Write, Parse, Command,

Event and Error Counts 8 to 37 Client 0 to Client 29 Command Execution Control Bits 2 38 to 40 Reserved 17 41 Read Block ID (-1 or 0) 1

Page 88 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Status Data Block Structure

This section contains a description of the members present in the MNETCR.STATUS array. This data is transferred from the module to the processor as part of each read block.

Offset Content Description

1 Pass Count This value is incremented each time a complete program

cycle occurs in the module.

2 Read Block Count This field contains the total number of read blocks

transferred from the module to the processor.

3 Write Block Count This field contains the total number of write blocks

transferred from the processor to the module.

4 Parse Block Count This field contains the total number of blocks successfully

parsed that were received from the processor.

5 Command Event Block

Count

6 Command Block Count This field contains the total number of command blocks

7 Error Block Count This field contains the total number of block errors

8 to 37 Enable/Disable

Command Bits

This field contains the total number of command event blocks received from the processor.

received from the processor.

recognized by the module. Each bit in each word is used to enable or disable individual

commands in each client

Initialize Output Data

When the module performs a restart operation, it will request blocks of output data from the processor to initialize the module’s output data (Read Data Area). Use the Initialize Output Data parameter in the configuration file to bring the module to a known state after a restart operation. The following table describes the structure of the request block.

Offset Description Length

0 1000 to 1124 1 1 to 40 Spare 40 41 1000 to 1124 1

The block number in word 20 of the block determines the data set of up to 40 output words to transfer from the processor. Ladder logic in the processor must recognize these blocks and place the correct information in the output image to be returned to the module. The following table describes the structure of the response block.

Offset Description Length

0 1000 to 1124 1 1 to 40 Output Data to preset in module. 40 41 Spare 1

ProSoft Technology, Inc. Page 89 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

5.2.3 Special Function Blocks

Special function blocks are special optional blocks used to request special tasks from the module. The MVI56-MNETCR supports the following special function blocks:

 Initialize Output Data  Event Command  Client Status request  Client Status response  Command Control  Set new module IP address  Get module IP address  Warm-boot  Cold-boot

Important: Each command defined in the command list is controlled by the ladder logic. The Write Command Bits parameter must be set in ladder logic to allow the command to be sent out on the Modbus TCP/IP network.

Event Command Blocks (2000 to 2029)

Event command control blocks send Modbus TCP/IP commands directly from the ladder logic to one of the clients on the module. The following table describes the format of these blocks.

Offset Description Length

0 2000 to 2029 1 1 to 4 IP Address 4 5 Service Port 1 6 Slave Address 1 7 Internal DB Address 1 8 Point Count 1 9 Swap Code 1 10 Modbus Function Code 1 11 Device Database Address 1 12 to 41 Spare 30

Use the parameters passed with the block to construct the command. The IP Address for the node to reach on the network is entered in four registers (1 to 4). Each digit of the IP address is entered in the appropriate register.

Page 90 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

For example, to interface with node 192.168.0.100, enter the values 192, 168, 0 and 100 in registers 1 to 4. The Service Port field selects the TCP service port on the server to connect. If the parameter is set to 502, a standard MBAP message will be generated. All other service port values will generate a Modbus command message encapsulated in a TCP/IP packet.

The Internal DB Address parameter specifies the module’s database location to associate with the command. The Point Count parameter defines the number of points or registers for the command. The Swap Code is used with Modbus functions 3 and 4 requests to change the word or byte order. The Modbus

Function Code has one of the following values 1, 2, 3, 4, 5, 6, 15 or 16. The Device Database Address is the Modbus register or point in the remote slave

device to be associated with the command. When the module receives the block, it will process it and place it in the

command queue. The following table describes the format of this block.

Word Description

0 This word contains the block 2000 identification code to indicate that this

block contains a command to execute by the Client Driver.

1 to 4 These words contain the IP address for the server the message is intended.

Each digit (0 to 255) of the IP address is placed in one of the four registers. For example, to reach IP address 192.168.0.100, enter the following values in words 1 to 4 → 192, 168, 0 and 100. The module will construct the normal dotted IP address from the values entered. The values entered will be anded with the mask 0x00ff to insure the values are in the range of 0 to 255.

5 This word contains the TCP service port the message will be interfaced. For

example, to interface with a MBAP device, the word should contain a value of

502. To interface with a MNET device, a value of 2000 should be utilized. Any value from 0 to 65535 is permitted. A value of 502 will cause a MBAP formatted message to be generated. All other values will generate an encapsulated Modbus message.

6 This word contains the Modbus node address for the message. This field

should have a value from 0 to 41.

7 This word contains the internal Modbus address in the module to use with the

command. This word can contain a value from 0 to 4999.

8 This word contains the count parameter that determines the number of digital

points or registers to associate with the command.

9 The parameter specifies the swap type for the data. This function is only valid

for function codes 3 and 4. 10 This word contains the Modbus function code for the command. 11 This word contains the Modbus address in the slave device to be associated

with the command. 12 to 41 Spare

ProSoft Technology, Inc. Page 91 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

The module will respond to each command block with a read block. The following table describes the format of this block.

Offset Description Length

0 Write Block ID 1 1 0=Fail, 1=Success 1 2 to 40 Spare 39 41 2000 to 2029 1

Word two of the block can be used by the ladder logic to determine if the command was added to the command queue of the module. The command will only fail if the command queue for the port is full (16 commands for each queue).

Client Status Request Blocks (3000 to 3029)

Offset Description

Length 0 3000 to 3029 (last digits indicate which client to consider) 1 1 to 41 Spare 40

Client Status Response

Offset Description Length

0 Write Block ID 1 1 3000 to 3029 number requested 1 2 to 11 Client status data 10 12 to 27 Command error list data for client 16 28 to 40 Reserved 13 41 3000 to 3029 1

Client Status Data

Word Offset Client Status

3 Total number of command list requests 4 Total number of command list responses 5 Total number of command list errors 6 Total number of requests of slave 7 Total number of responses 8 Total number of errors sent 9 Total number of errors received 10 Configuration Error Word 11 Current Error 12 Last Error

Page 92 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Command Control Blocks (5001 to 5016)

Command control blocks place commands in the command list into the command queue. The client has a command queue of up to 16 commands. The module services commands in the queue before the user defined command list. This gives high priority to commands in the queue. Commands placed in the queue through this mechanism must be defined in the module's command list. Under normal command list execution, the module will only execute commands with the Enable parameter set to one. If the value is set to zero, the command is skipped. Commands may be placed in the command queue with an Enable parameter set to zero using this feature. These commands can then be executed using the command control blocks.

One to six commands can be placed in the command queue with a single request. The following table describes the format for this block.

Offset Description Length

0 5001 to 5016 1 1 Client to Utilize 1 2 Command index 1 3 Command index 1 4 Command index 1 5 Command index 1 6 Command index 1 7 Command index 1 8 Command index 1 9 Command index 1 10 Command index 1 11 Command index 1 12 Command index 1 13 Command index 1 14 Command index 1 15 Command index 1 16 Command index 1 17 Command index 1 18 to 41 Spare 24

The last digit in the block code defines the number of commands to process in the block. For example, a block code of 5003 contains 3 command indexes that are to be placed in the command queue. The Command index parameters in the block have a range of 0 to 15 and correspond to the module's command list entries.

ProSoft Technology, Inc. Page 93 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

The module responds to a command control block with a block containing the number of commands added to the command queue for the port. The following table describes the format for this block.

Offset Description Length

0 Write Block ID 1 1 Number of commands added to command queue 1 2 to 40 Spare 39 41 5001 to 5016 1

Reset Module Status Block (9971)

This block allows the processor to reset all status values available from the module to the processor or through the PCB diagnostics menu. This block is triggered through the following data type and controller tag elements:

Page 94 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Block 9990: Set Module IP Address

IP Set Request (Write Block)

Offset Description Length

0 9990 1 1 First digit of dotted IP address 1 2 Second digit of dotted IP address 1 3 Third digit of dotted IP address 1 4 Last digit of dotted IP address 1 5 to 41 Reserved 36

IP Set Response (Read Block)

Offset Description Length

0 0 1 1 Write Block ID 1 2 First digit of dotted IP address 1 3 Second digit of dotted IP address 1 4 Third digit of dotted IP address 1 5 Last digit of dotted IP address 1 6 to 41 Spare data area 35

Block 9991: Get Module IP Address

IP Get Request (Write Block)

Offset Description Length

0 9991 1 1 to 41 Spare data area 40

IP Get Response (Read Block)

Offset Description Length

0 0 1 1 Write Block ID 1 2 First digit of dotted IP address 1 3 Second digit of dotted IP address 1 4 Third digit of dotted IP address 1 5 Last digit of dotted IP address 1 6 to 41 Spare data area 35

ProSoft Technology, Inc. Page 95 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

Block 9998: Warm Boot

This block is equivalent to performing a software reset, and causes the module to exit the program, reload the configuration file, and then restart the program. The Warm Boot control block also initializes the application port(s) and status data, and resets all internal registers to zero.

Note: In some cases, the read section of the module database (transferred from module to processor) must keep its values after a reboot. To repopulate the module's registers with the last values the module sent to the processor, set the I

NITIALIZE OUTPUT DATA

parameter in the module

configuration to YES.

The following table describes the format of the control block.

Offset Description Length

0 9998 1 1 to 41 Spare 41

The module does not send a response block for this command.

Page 96 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

Block 9999: Cold Boot

This block is equivalent to performing a hardware reset, and causes the module to restart in the same way as if the power was cycled. The Cold Boot control block also reloads the module's backplane and application port drivers, restarts the program, and resets all internal registers to zero.

NITIALIZE OUTPUT DATA

parameter in the module

configuration to YES.

The following table describes the format of the control block.

Offset Description Length

0 9999 1 1 to 41 Spare 41

The module does not send a response block for this command.

ProSoft Technology, Inc. Page 97 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

5.3 Data Flow between MVI56-MNETCR Module, Processor, and Network

The following topics describe the flow of data between the two pieces of hardware (processor and MVI56-MNETCR module) and other nodes on the Modbus TCP/IP network. The module contains up to 30 clients, which can generate either MBAP (Modbus API for network communications) or MNET requests dependent on the service port selected in the command.

The following topics discuss the operation of the client drivers.

Page 98 of 127 ProSoft Technology, Inc. February 14, 2011

MVI56-MNETCR ♦ ControlLogix Platform Reference Modbus TCP/IP Multi Client Communication Module for Remote Chassis User Manual

5.3.1 Client Driver

In the client driver, the MVI56-MNETCR module issues read or write commands to servers on the Modbus TCP/IP network using 30 simulated clients. These commands are user configured in the module via the Client Command List for each client received from the module's configuration file (MNET.CFG) or issued directly from the processor (event command control). Command status is returned to the processor for each individual command in the command list status block. The location of this status block in the module's internal database is user defined. The following flow chart and associated table describe the flow of data into and out of the module.

Step Description

1 The client driver obtains configuration data from the MNET.CFG file when the module

restarts. The configuration data obtained includes the timeout parameters and the Command List. These values are used by the driver to determine the type of commands to be issued to the other nodes on the Modbus TCP/IP network.

2 When configured, the client driver begins transmitting read and/or write commands to the

other nodes on the network. If writing data to another node, the data for the write command is obtained from the module's internal database to build the command.

3 Presuming successful processing by the node specified in the command, a response

message is received into the client driver for processing.

4 Data received from the node on the network is passed into the module's internal

database, assuming a read command.

5 Status data is returned to the processor for the client and a Command List error table

can be established in the module's internal database.

ProSoft Technology, Inc. Page 99 of 127 February 14, 2011

Reference MVI56-MNETCR ♦ ControlLogix Platform User Manual Modbus TCP/IP Multi Client Communication Module for Remote Chassis

5.3.2 Client Command List

In order for the Client to function, the module's Client Command List must be defined in the MNET Client x Commands section of the configuration. This list contains up to 16 individual entries, with each entry containing the information required to construct a valid command. This includes the following:

 Command enable mode: (0) disabled or (1) continuous  IP address and service port to connect to on the remote server  Slave Node Address  Command Type - Read or Write up to 100 words per command  Database Source and Destination Register Address - Determines where data

will be placed and/or obtained

 Count - Select the number of words to be transferred - 1 to 100  Poll Delay - 1/10th seconds

5.3.3 Client Command Errors

You can use the Client Command Error Pointer, which is separately configured for each Client, to reference the offset register where all command error codes will be stored. This means that the first register refers to command 1 and so on.

Offset Description

1 Command 1 Error 2 Command 2 Error 3 Command 3 Error … …. … …

For every command that has an error, the module automatically sets the poll delay parameter to 30 seconds. This instructs the module to wait 30 seconds until it attempts to issue the command again.

As the list is read in from the configuration file and as the commands are processed, an error value is maintained in the module for each command. This error list can be transferred to the processor. The errors generated by the module are displayed in the following table.

Standard Modbus Exception Code Errors

Code Description

1 Illegal function 2 Illegal data address 3 Illegal data value 4 Failure in associated device 5 Acknowledge 6 Busy; message was rejected

Page 100 of 127 ProSoft Technology, Inc. February 14, 2011

ProSoft inRAx MVI56-MNETCR User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual