MVI56E-MCM / MCMXT

ControlLogix Platform Modbus Communication Module

April 18, 2011

SETUP GUIDE

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 [email protected] Copyright 2011 ProSoft Technology, Inc., all rights reserved. MVI56E-MCM / MCMXT Setup Guide April 18, 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 Safety Information - MVI56E-MCM/XT

North America Warnings
A B C D Warning - Explosion Hazard - Substitution of components may impair suitability for Class I, Division 2. Warning - Explosion Hazard - When in Hazardous Locations, turn off power before replacing or rewiring modules. Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is known to be nonhazardous. 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. DO NOT OPEN WHEN ENERGIZED.

Markings Agency Approvals and Certifications

Agency RoHS ATEX CSA CE CSA CB Safety cULus GOST-R Lloyds EN61010 Lloyds Register Test Specification Number 1,2002 EN60079-0 July 2006 EN60079-15 October 2005 IEC61010 EMC-EN61326-1:2006 EN61000-6-4:2007 CA/10533/CSA IEC 61010-1 Ed. 2 CB 243333-2056722 (2090408) Applicable Standards

243333

E183151

ME06

Label Markings
<Ex> II 3 G Ex nA T5 0 <= Ta <= 60 C C -25 <= Ta <= 70 (XT models only) C C II Equipment intended for above ground use (not for use in mines). 3 Category 3 equipment, investigated for normal operation only. G Equipment protected against explosive gasses. <cULus> E183151 Class I, DIV 2, groups A,B,C,D T5 for all models 0 to +60 C C -25 to +70 (XT models only) C C

Battery Life Advisory

Note: Modules manufactured after April 1st, 2011 do not contain a battery. For modules manufactured before that date the following applies:
The module uses a rechargeable Lithium Vanadium Pentoxide battery to back up the real-time clock and CMOS settings. The battery itself should last for the life of the module. However, if left in an unpowered state for 14 to 21 days, the battery may become fully discharged and require recharging by being placed in a powered-up ControlLogix chassis. The time required to fully recharge the battery may be as long as 24 hours. Once it is fully charged, the battery provides backup power for the CMOS setup and the real-time clock for approximately 21 days. Before you remove a module from its power source, ensure that the battery within the module is fully charged (the BATT LED on the front of the module goes OFF when the battery is fully charged). If the battery is allowed to become fully discharged, the module will revert to the default BIOS and clock settings.

Note: The battery is not user-replaceable or serviceable.

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Contents Setup Guide

Contents
Your Feedback Please ........................................................................................................................ 2 How to Contact Us .............................................................................................................................. 2 ProSoft Technology Product Documentation .................................................................................... 2 Important Safety Information - MVI56E-MCM/XT ............................................................................... 3 Battery Life Advisory ........................................................................................................................... 4

1
1.1 1.2 1.3 1.4

Scope

7
What's New? ............................................................................................................. 8 Learning Objectives ................................................................................................... 9 ProSoft Technology Documentation ....................................................................... 10 Prerequisites ........................................................................................................... 11

2
2.1 2.2 2.3

Before You Begin

13

System Requirements ............................................................................................. 14 Required Items ........................................................................................................ 15 Sample Files ............................................................................................................ 16

3
3.1 3.2

The Sample Application

17

3.2.1 3.3 3.4

About the MODBUS Protocol .................................................................................. 18 General Overview.................................................................................................... 19 Required Steps ........................................................................................................ 19 Architecture ............................................................................................................. 20 Memory Map ........................................................................................................... 21

4
4.1 4.2 4.3

Procedures

23

4.3.1 4.3.2 4.3.3 4.4 4.4.1 4.4.2 4.4.3 4.5 4.6 4.7 4.7.1 4.7.2 4.7.3 4.8 4.9 4.10

Setting Module Jumpers.......................................................................................... 24 Installing the Module in the Rack ............................................................................ 25 Using ProSoft Configuration Builder Software ........................................................ 27 Setting Up the Project ............................................................................................. 28 Connecting Your PC to the Module's Ethernet Port ................................................ 29 Setting Up a Permanent IP Address ....................................................................... 33 Importing the Sample Add-On Instruction ............................................................... 45 Creating a New RSLogix 5000 Project.................................................................... 45 Creating the Module ................................................................................................ 46 Import the Ladder Rung .......................................................................................... 49 Connecting Your PC to the ControlLogix Processor ............................................... 53 Downloading the Sample Program to the Processor .............................................. 54 Setting up the Read and Write Database Areas ..................................................... 55 Configuring Modbus Port 1 (P1) .............................................................................. 56 Configuring the Modbus Master Read Command ................................................... 58 Configuring the Modbus Master Write Command ................................................... 59 Rebooting the Module to Transfer New Parameter Values .................................... 60 Configuring the Quantum Processor as a Modbus Slave ....................................... 61 Connecting the MVI56E-MCM Module to the Quantum Processor ........................ 62

ProSoft Technology, Inc. April 18, 2011

Page 5 of 78

Contents Setup Guide

4.11 4.11.1 4.11.2 4.11.3 4.11.4

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Verifying Communication ........................................................................................ 63 Viewing Exchanged Data ........................................................................................ 63 Checking Module Status through ControlLogix Controller Tags ............................ 66 Scrolling LED Status Indicators .............................................................................. 67 Non-Scrolling LED Status Indicators ...................................................................... 68

5
5.1

Building on Success

69

Frequently Asked Questions................................................................................... 70 5.1.1 What are the differences between the MVI56 and the MVI56E modules? What does the "E" stand for? ................................................................................................................ 70 5.1.2 Is the MVI56E product a direct replacement to my existing MVI56 product? ......... 70 5.1.3 How is the MVI56E-MCM configured? ................................................................... 70 5.1.4 What is ProSoft Configuration Builder (PCB)? ....................................................... 71 5.1.5 What is ProSoft Discovery Service (PDS)? ............................................................ 71 5.1.6 What is the purpose of the MVI56E-MCM Ethernet Config (E1) Port? .................. 71 5.1.7 How do I change the modules IP address? ........................................................... 71 5.1.8 Does the MVI56E-MCM module require processor logic? ..................................... 71 5.1.9 What is the purpose of the Optional MVI56E-MCM Add-On Instruction? .............. 72 5.1.10 How do I monitor MVI56E-MCM operation? ........................................................... 72 5.1.11 Are there any other ways to monitor module diagnostics besides being connected to the modules network (subnet)? .............................................................................................. 72

Glossary of Terms Index

73 77

Page 6 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Scope Setup Guide

Scope
In This Chapter
What's New? ........................................................................................... 8 Learning Objectives ................................................................................. 9 ProSoft Technology Documentation ...................................................... 10 Prerequisites ......................................................................................... 11

This document acts as a tutorial, providing step-by-step instructions on how to read and write bi-directional data from one network device to another network device using the MVI56E-MCM / MCMXT.

ProSoft Technology, Inc. April 18, 2011

Page 7 of 78

Scope Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

1.1

What's New?
MVI56E products are backward compatible with existing MVI56 products, ladder logic, and module configuration files already in use. Easily swap and upgrade to benefit from an array of new features designed to improve interoperability and enhance ease of use. ProSoft Configuration Builder (PCB): Microsoft Windows-based utility software for diagnostics. Connect through the module's Ethernet port or use CIPconnect to access troubleshooting features and functions. ProSoft Discovery Service (PDS): New Windows-based utility software to find and display a list of MVI56E modules on the network and to temporarily change a module's IP address to be able to connect with a module's web page. CIPconnect-enabled: Allows PC-to-module diagnostics from the Ethernet network through a ControlLogix 1756-ENxT EtherNet/IP module. Personality Card: An industrial-grade compact flash memory card storing the modules Ethernet settings, allowing quick and easy replacement. LED Scrolling Diagnostic Display: 4-character, alphanumeric display, providing English messages for status and alarm data, and for processor and network communication status. XT series for Extreme Environments: The MVI56E-MCMXT is part of the new XT series, designed to work at extreme temperatures and in harsh or caustic environments. XT series modules operate over a wider temperature range than the standard MVI56E series. The XT series also comes with conformal coating to protect module components from corrosive environmental elements.

Page 8 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Scope Setup Guide

1.2

Learning Objectives
When you have completed all the steps in this Setup Guide, you will have learned how to Use the sample application (page 17) Install the MVI56E-MCM setup and diagnostic software Install the MVI56E-MCM module Import the Add-On Instruction to the processor (page 54) Configure the Modbus Master using the sample Add-On Instruction Configure the Modbus Slave (page 61) Verify the MVI56E-MCM module communication status (page 63)

ProSoft Technology, Inc. April 18, 2011

Page 9 of 78

Scope Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

1.3

ProSoft Technology Documentation

ProSoft Technology provides the following documentation (manuals) with your MVI56E-MCM.
Documentation, tools, and product support

Web Site Support: Visit the ProSoft Technology web site at www.prosoft-technology.com to download additional documentation, tools, and application information. Email Technical Support: Send your support questions to [email protected]. Telephone Support: Please call ProSoft Technology Technical Support at: (Country Code 1+) 661-716-5100. Support is available 24 hours a day, 7 days a week. ProSoft Technology telephone support is free and unlimited.

Page 10 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Scope Setup Guide

1.4

Prerequisites
To get the most benefit from this Setup Guide, you should have the following skills: Rockwell Automation RSLogix 5000 software: launch the program, configure, and transfer the Add-On Instruction (or ladder logic) Sample Application program to the processor Microsoft Windows: install and launch programs, execute menu commands, navigate dialog boxes and enter data. Serial data communication: correctly configure data communication parameters such as baud rate, parity, data bits, and so on, using the documentation for the devices connected to the network Ethernet networking: connect the MVI56E-MCM module to an Ethernet network using a valid IP address and subnet mask Hardware installation and wiring: install the module and safely connect Modbus Master/Slave and ControlLogix devices to a power source and to the MVI56E-MCM modules serial ports

ProSoft Technology, Inc. April 18, 2011

Page 11 of 78

Scope Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Page 12 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Before You Begin Setup Guide

Before You Begin

In This Chapter
System Requirements ........................................................................... 14 Required Items ...................................................................................... 15 Sample Files.......................................................................................... 16

ProSoft Technology, Inc. April 18, 2011

Page 13 of 78

Before You Begin Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

2.1

System Requirements
The MVI56E-MCM module requires the following minimum hardware and software components: Rockwell Automation ControlLogix processor (firmware version 10 or higher), with compatible power supply, and one free slot in the rack for the MVI56E-MCM module. The module requires 800 mA of available 5 Vdc power Rockwell Automation RSLogix 5000 programming software o Version 16 or higher required for Add-On Instruction o Version 15 or lower must use Sample Ladder, available from www.prosoft-technology.com Rockwell Automation RSLinx communication software version 2.51 or higher ProSoft Configuration Builder (PCB) (included) ProSoft Discovery Service (PDS) (included in PCB) Pentium II 450 MHz minimum. Pentium III 733 MHz (or better) recommended Supported operating systems: o Microsoft Windows Vista o Microsoft Windows XP Professional with Service Pack 1 or 2 o Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3 o 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

Note: The Hardware and Operating System requirements in this list are the minimum recommended to install and run software provided by ProSoft Technology. Other third party applications may have different minimum requirements. Refer to the documentation for any third party applications for system requirements. 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 14 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Before You Begin Setup Guide

2.2

Required Items
This Setup Guide uses a sample application that shows you how to establish communication between the MVI56E-MCM module (Master Port) and a Modbus Slave device. The sample application requires the following equipment.
Item MVI56E-MCM 1756-L63 1756-A7/B 1756-PA72/B CPU434 12A CPS 114 20 140XBP01000 Ethernet cable Serial cable Description Modbus Communication Module ControlLogix processor ControlLogix rack ControlLogix rack power supply Quantum processor (Modbus device) Quantum power supply Quantum rack Ethernet cable to connect MVI56E-MCM module to Ethernet network for diagnostics (supplied with the module) Serial cable to connect MVI56E-MCM module to Modbus serial network

ProSoft Technology, Inc. April 18, 2011

Page 15 of 78

Before You Begin Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

2.3

Sample Files

Note: This procedure requires RSLogix 5000 version 16 (or later), which supports Add-On Instructions. For RSLogix version 15 (or older) applications, please refer to the MVI56E-MCM User Manual for information on how to use the sample ladder logic.

The sample MVI56(E)MCM_AddOn_Rung_v2_2.L5X Add-On Instruction file contains all elements required for the MVI56E-MCM module to function. User-defined Data Types (UDTs) Add-On Instruction (AOI) Ladder rung with AOI Controller tags
Item MVI56(E)MCM_AddOn_Rung_v2_2.L5X Description Sample rung import file containing Add-On Instruction

Copy the file from the ProSoft Solutions CD-ROM, or download them from www.prosoft-technology.com. Save it to a convenient location in your PC, such as Desktop or My Documents.

Page 16 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

The Sample Application Setup Guide

The Sample Application

In This Chapter
About the MODBUS Protocol ................................................................ 18 General Overview.................................................................................. 19 Architecture ........................................................................................... 20 Memory Map ......................................................................................... 21

ProSoft Technology, Inc. April 18, 2011

Page 17 of 78

The Sample Application Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

3.1

About the MODBUS 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 Master and Slave devices on a network. Later enhancements to the protocol allow communication over other types of networks. MODBUS is a Master/Slave protocol. The Master establishes a connection to the remote Slave. When the connection is established, the Master sends the MODBUS commands to the Slave. The MVI56E-MCM module can work as a Master and as a Slave. The MVI56E-MCM module also works as an input/output module between itself and the Rockwell Automation backplane and processor. The module uses an internal database to pass data and commands between the processor and Master and Slave devices on MODBUS networks.

Page 18 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

The Sample Application Setup Guide

3.2

General Overview
This Setup Guide shows you how to configure the MVI56E-MCM module and establish communication with a Modbus device (a Quantum processor, for this example). The MVI56E-MCM Port 1 (P1) will be configured as a Modbus Master device. The Quantum processor will operate as a Modbus Slave device (Modbus Comm 1). The MVI56E-MCM will be configured to send two Master commands to the Modbus Slave device: Write 10 words (Modbus Function 16 - Preset [Write] Multiple Registers Read 10 words (Modbus Function 3 -Read Holding Registers

When you finish the steps in this Setup Guide, you will have enough information to set up your own application.

3.2.1 Required Steps

This Setup Guide will take you through the following steps: 1 Install the ProSoft Module in the rack 2 Use the Add-On Instruction to Configure the Module (page 45) 3 Connect your PC to the Processor (page 53) 4 Download the Sample Program to the Processor (page 54) 5 Set up the Read and Write Database Areas a Configure Modbus Port 1 (P1) (page 56) b Configure the Modbus Master Read Command (page 58, page 59) c Configure the Modbus Master Write Command (page 59) 6 Reboot the module (page 60) 7 Set up the Quantum Processor Modbus Slave Port (page 61) 8 Verify Communication (page 63) ProSoft Technology, Inc. April 18, 2011 Page 19 of 78

The Sample Application Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

3.3

Architecture
The sample application uses the following hardware and connections. A Personal Computer running a supported version of Microsoft Windows, with a web browser, RSLogix 5000, ProSoft Discovery Service and an Ethernet port A ControlLogix processor with MVI56E-MCM module acting as a Modbus Master A Quantum processor acting as a Modbus Slave An Ethernet network connecting the PC with the MVI56E-MCM, either directly or through an Ethernet hub or switch. An RS-232 serial cable connecting the MVI56E-MCM Modbus Master Port 1 to the Quantum processor Modbus Slave Port. The following illustration shows the sample application.

Note: The illustration does not show the required Ethernet connection for processor programming.

Page 20 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

The Sample Application Setup Guide

3.4

Memory Map
The memory map consists of the starting addresses for Read Data and Write Data areas in the MVI56E-MCM module and in the Quantum processor. The sample application reads and writes 10 words between the Modbus Master and the Modbus Slave. The following table describes the memory map for data transfer between the MVI56E-MCM module and the Quantum processor.
Function Read Write MVI56E-MCM Database Start Address (Master) 1000 0 Quantum Memory Start Word Count Address (Slave) 400801 400401 10 10

ProSoft Technology, Inc. April 18, 2011

Page 21 of 78

The Sample Application Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Page 22 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

Procedures
In This Chapter
Setting Module Jumpers ........................................................................ 24 Installing the Module in the Rack........................................................... 25 Using ProSoft Configuration Builder Software ....................................... 27 Importing the Sample Add-On Instruction.............................................. 45 Connecting Your PC to the ControlLogix Processor.............................. 53 Downloading the Sample Program to the Processor ............................. 54 Setting up the Read and Write Database Areas .................................... 55 Rebooting the Module to Transfer New Parameter Values ................... 60 Configuring the Quantum Processor as a Modbus Slave ...................... 61 Connecting the MVI56E-MCM Module to the Quantum Processor ....... 62 Verifying Communication....................................................................... 63

ProSoft Technology, Inc. April 18, 2011

Page 23 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.1

Setting Module Jumpers

There are three jumpers located at the bottom of the module. The first two jumpers (PRT1 and PRT2) set the serial communication mode: RS-232, RS-422, or RS-485. The following illustration shows the MVI56E-MCM jumper configuration.

1 2

The sample application will connect the MVI56E-MCM application port P1 to the target device using the supplied null-modem cable (RS-232). Set the PRT1 jumper for RS-232. The Setup Jumper acts as "write protection" for the modules flash memory. In "write protected" mode, the Setup pins are not connected, and the modules firmware cannot be overwritten. The module is shipped with the Setup pins jumpered, so that you can update the modules firmware if necessary. As you will not be updating the firmware for this procedure, remove the setup jumper and store it in a safe place (for example, on only one of the pins).

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 modules firmware without requiring physical access to the module.

Page 24 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.2

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 MVI56E-MCM 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 the MVI56E-MCM into the ControlLogix chassis. Use the same technique recommended by Rockwell Automation to remove and install ControlLogix modules. You can install or remove ControlLogix system components while chassis power is applied and the system is operating. However, please note the following warning.

Warning: When you insert or remove the module while backplane power is on, an electrical arc can occur. An electrical arc can cause personal injury or property damage by sending an erroneous signal to your systems actuators. This can cause unintended machine motion or loss of process control. Electrical arcs may also cause an explosion when they happen in a hazardous environment. 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.

ProSoft Technology, Inc. April 18, 2011

Page 25 of 78

Procedures Setup Guide 1

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module Align the module with the top and bottom guides, and then slide it into the rack until the module is firmly against the backplane connector.

2 3 4

With a firm, steady push, snap the module into place. Check that the holding clips on the top and bottom of the module are securely in the locking holes of the rack. 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. Turn power ON.

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

Note: When using the MVI56EMCMXT, you must use the 1756-A5XT or 1756-A7LXT chassis. In these chassis, modules are spaced further apart than in standard ControlLogix chassis. Blank spacers are inserted between active modules.

Page 26 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.3

Using ProSoft Configuration Builder Software

ProSoft Configuration Builder (PCB) provides a quick and easy way to manage gateway configuration files customized to meet your application needs. PCB is not only a powerful solution for new configuration files, but also allows you to import information from previously installed (known working) configurations to new projects. The ProSoft Discovery Service (PDS) is available as a stand-alone application, or as part of ProSoft Configuration Builder. ProSoft Discovery Service shows you all the MVI56E modules available on your local area network.

Note: The MVI56E-MCM module receives its protocol and backplane configuration information from the Ladder Logic. Use ProSoft Configuration Builder to configure the modules Ethernet settings.
To install ProSoft Configuration Builder from the CD-ROM

Insert the ProSoft Solutions CD-ROM into the CD drive of your PC. Wait for the startup screen to appear.

2 3

On the startup screen, click INSTALL PROSOFT CONFIGURATION BUILDER. This action starts the installation wizard for ProSoft Configuration Builder. Click NEXT on each page of the installation wizard. Click FINISH on the last page of the wizard.

ProSoft Technology, Inc. April 18, 2011

Page 27 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.3.1 Setting Up the Project

To begin, start PROSOFT CONFIGURATION BUILDER (PCB).

If you have used other Windows configuration tools before, you will find the screen layout familiar. PCBs 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.

Your first task is to add the MVI56E-MCM module to the project. 1 Use the mouse to select DEFAULT MODULE in the tree view, and then click the right mouse button to open a shortcut menu.

Page 28 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module 2

Procedures Setup Guide

On the shortcut menu, select CHOOSE MODULE TYPE. This action opens the Choose Module Type dialog box.

In the Product Line Filter area of the dialog box, select MVI56E. In the Select Module Type dropdown list, select MVI56E-MCM, and then click OK to save your settings and return to the ProSoft Configuration Builder window.

4.3.2 Connecting Your PC to the Module's Ethernet Port

ith the module securely mounted, connect one end of the Ethernet cable to the CONFIG (E1) Port, and the other end to an Ethernet hub or switch accessible from the same network as your PC. Or, you can connect directly from the Ethernet Port on your PC to the CONFIG (E1) Port on the module.

ProSoft Technology, Inc. April 18, 2011

Page 29 of 78

Procedures Setup Guide Setting Up a Temporary IP Address

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Important: ProSoft Configuration Builder locates MVI56E-MCM modules through UDP broadcast messages. These messages may be blocked by routers or layer 3 switches. In that case, ProSoft Discovery Service will be unable to locate the modules. To use ProSoft Configuration Builder, arrange the Ethernet connection so that there is no router/ layer 3 switch between the computer and the module OR reconfigure the router/ layer 3 switch to allow routing of the UDP broadcast messages.

In the tree view in ProSoft Configuration Builder, select the MVI56E-MCM module.

Click the right mouse button to open a shortcut menu. On the shortcut menu, choose DIAGNOSTICS.

Page 30 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module 3 In the Diagnostics window, click the SET UP CONNECTION button.

Procedures Setup Guide

In the Connection Setup dialog box, click the BROWSE DEVICE(S) button to open the ProSoft Discovery Service. Select the module, then right-click and choose ASSIGN TEMPORARY IP.

The modules default IP address is usually 192.168.0.250. Choose an unused IP within your subnet, and then click OK.

Important: The temporary IP address is only valid until the next time the module is initialized. For information on how to set the modules permanent IP address, see Setting Up a Permanent IP Address (page 33).

ProSoft Technology, Inc. April 18, 2011

Page 31 of 78

Procedures Setup Guide 6

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module Close the ProSoft Discovery Service window. Enter the temporary IP in the Ethernet address field of the Connection Setup dialog box, then click the TEST CONNECTION button to verify that the module is accessible with the current settings.

If the Test Connection is successful, click CONNECT. The Diagnostics menu will display in the Diagnostics window.

Page 32 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.3.3 Setting Up a Permanent IP Address

Note: For alternative methods of connecting to the module with your PC, refer to Using CIPconnect to Connect to the Module (page 35) or Using RSWho to Connect to the Module (page 44).

These steps show you how to set a permanent IP address on the module. The modules default IP address is 192.168.0.250. 1 Start ProSoft Configuration Builder. 2 Select the MVI56E-MCM icon, and then click the [+] symbol to expand the MVI56E-MCM tree. 3 Select ETHERNET CONFIGURATION, and then click the right mouse button to open a shortcut menu. 4 On the shortcut menu, select CONFIGURE.

This action opens the EDIT-WATTCP dialog box. Use this dialog box to enter the MVI56E-MCM modules permanent IP Address (MY_IP), SUBNET MASK (NETMASK) and DEFAULT GATEWAY (GATEWAY).

ProSoft Technology, Inc. April 18, 2011

Page 33 of 78

Procedures Setup Guide 5 6

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module Click OK to save the updated Ethernet configuration. Next, select the MVI56E-MCM icon, and then click the right mouse button to open a shortcut menu. On the shortcut menu, choose DOWNLOAD FROM PC TO DEVICE.

This action opens the DOWNLOAD dialog box. Notice that the Ethernet address field contains the temporary IP address you assigned previously. ProSoft Configuration Builder will use this temporary IP address to connect to the module.

Click TEST CONNECTION to verify that the temporary IP address is correct. 7 If the connection succeeds, click DOWNLOAD to transfer the Ethernet configuration to the module. If the Test Connection procedure fails, you will an error message. To correct the error, follow these steps. 1 Click OK to dismiss the error message.

Page 34 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module 2 On the DOWNLOAD dialog box, click BROWSE DEVICES to open PROSOFT DISCOVERY SERVICe.

Procedures Setup Guide

3 4 5

Select the module, and then click the right mouse button to open a shortcut menu. On the shortcut menu, choose SELECT FOR PCB. Close Prosoft Discovery Service. Click DOWNLOAD to transfer the Ethernet configuration to the module.

Using CIPconnect to Connect to the Module You can use CIPconnect to connect a PC to the ProSoft Technology MVI56EMCM module over Ethernet using Rockwell Automations 1756-ENBT EtherNet/IP module. This allows you to configure the MVI56E-MCM network settings and view module diagnostics from a PC. RSLinx is not required when you use CIPconnect. All you need are: The IP addresses and slot numbers of any 1756-ENBT modules in the path The slot number of the MVI56E-MCM in the destination ControlLogix chassis (the last ENBTx and chassis in the path). To use CIPconnect, follow these steps.

ProSoft Technology, Inc. April 18, 2011

Page 35 of 78

Procedures Setup Guide 1

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module In the Select Port dropdown list, choose 1756-ENBT. The default path appears in the text box, as shown in the following illustration.

Click CIP PATH EDIT to open the CIPconnect Path Editor dialog box.

The CIPconnect Path Editor allows you to define the path between the PC and the MVI56E-MCM module. The first connection from the PC is always a 1756ENBT (Ethernet/IP) module. Each row corresponds to a physical rack in the CIP path. If the MVI56E-MCM module is located in the same rack as the first 1756ENBT module, select RACK NO. 1 and configure the associated parameters. Page 36 of 78 ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

If the MVI56E-MCM is available in a remote rack (accessible through ControlNet or Ethernet/IP), include all racks (by using the ADD RACK button).
Parameter Source Module Description Source module type. This field is automatically selected depending on the destination module of the last rack (1756CNB or 1756-ENBT). IP address of the source module (only applicable for 1756ENBT) Node address of the source module (only applicable for 1756CNB) Select the destination module associated to the source module in the rack. The connection between the source and destination modules is performed through the backplane. The slot number where the destination MVI56E module is located.

Source Module IP Address Source Module Node Address Destination Module

Destination Module Slot Number

To use the CIPconnect Path Editor, follow these steps. 1 Configure the path between the 1756-ENBT connected to your PC and the MVI56E-MCM module. o If the module is located in a remote rack, add more racks to configure the full path. o The path can only contain ControlNet or Ethernet/IP networks. o The maximum number of supported racks is six. 2 Click CONSTRUCT CIP PATH to build the path in text format 3 Click OK to confirm the configured path. The following examples should provide a better understanding on how to set up the path for your network. Example 1: Local Rack Application For this example, the MVI56E-MCM module is located in the same rack as the 1756-ENBT that is connected to the PC.

ProSoft Technology, Inc. April 18, 2011

Page 37 of 78

Procedures Setup Guide Rack 1

Slot 0 1 2 3 Module ControlLogix Processor Any MVI56E-MCM 1756-ENBT

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Network Address IP=192.168.0.100

In the Download dialog box, click CIP PATH EDIT.

Configure the path as shown in the following illustration, and click CONSTRUCT CIP PATH to build the path in text format.

Click OK to close the CIPconnect Path Editor and return to the Download dialog box.

Page 38 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module 3 Check the new path in the Download dialog box.

Procedures Setup Guide

Click TEST CONNECTION to verify that the physical path is available. The following message should be displayed upon success.

ProSoft Technology, Inc. April 18, 2011

Page 39 of 78

Procedures Setup Guide 5

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module Click OK to close the Test Connection pop-up and then click DOWNLOAD to download the configuration files to the module through the path.

Example 2: Remote Rack Application For this example, the MVI56E-MCM module is located in a remote rack accessible through ControlNet, as shown in the following illustration.

Rack 1
Slot 0 1 2 3 Module ControlLogix Processor 1756-CNB 1756-ENBT Any Network Address Node = 1 IP=192.168.0.100 -

Page 40 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

Rack 2
Slot 0 1 2 3 4 5 6 Module Any Any Any Any Any 1756-CNB MVI56E-MCM Network Address Node = 2 -

In the Download dialog box, click CIP PATH EDIT.

Configure the path as shown in the following illustration and click CONSTRUCT CIP PATH to build the path in text format.

Click OK to close the CIPconnect Path Editor and return to the Download dialog box. ProSoft Technology, Inc. April 18, 2011 Page 41 of 78

Procedures Setup Guide 3

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module Check the new path in the Download dialog box.

Click TEST CONNECTION to verify that the physical path is available. The following message should be displayed upon success.

Page 42 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module 5 Click DOWNLOAD to download the configuration files to the module through the path.

Procedures Setup Guide

ProSoft Technology, Inc. April 18, 2011

Page 43 of 78

Procedures Setup Guide Using RSWho to Connect to the Module

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

You need to have RSLinx installed on your PC to use this feature. You also need an ENBT module set up in the rack. For information on setting up the ENBT module, see Using CIPconnect to Connect to the Module (page 35).

1 2 3

In the tree view in ProSoft Configuration Builder, right-click the MVI56E-MCM module. From the shortcut menu, choose DOWNLOAD FROM PC TO DEVICE. In the Download dialog box, choose 1756 ENBT from the Select Connection Type dropdown box.

Click RSWHO to display modules on the network. The MVI56E-MCM module will automatically be identified on the network.

5 6

Select the module, and then click OK. In the Download dialog box, click DOWNLOAD.

You will need the User Manual and the Add-On Software to complete the steps in the following sections of this Setup Guide.

Page 44 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.4

Importing the Sample Add-On Instruction

Note: This section only applies if your processor is using RSLogix 5000 version 16 or higher. If you have an earlier version, please see Using the Sample Program.

Before You Begin Two Add-On Instructions are provided for the MVI56E-MCM module. The first is required for setting up the module; the second is optional. Copy the files from the ProSoft Solutions CD-ROM, or download them from www.prosoft-technology.com. Save them to a convenient location in your PC, such as Desktop or My Documents.
File Name MVI56(E)MCM_AddOn_Rung_v2_2.L5X Description L5X file containing Add-On Instruction, user defined data types, controller tags and ladder logic required to configure the MVI56E-MCM module

MVI56(E)MCM_Optional_AddOn_Rung_v1_0 Optional L5X file containing additional Add-On .L5X Instruction with logic for changing Ethernet configuration and clock settings.

4.4.1 Creating a New RSLogix 5000 Project

1 Open the FILE menu, and then choose NEW.

2 3 4 5

Select your ControlLogix controller model. Select REVISION 16. Enter a name for your controller, such as My_Controller. Select your ControlLogix chassis type.

ProSoft Technology, Inc. April 18, 2011

Page 45 of 78

Procedures Setup Guide 6 Select SLOT 0 for the controller.

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.4.2 Creating the Module

1 Add the MVI56E-MCM module to the project. In the CONTROLLER ORGANIZATION window, select I/O CONFIGURATION and click the right mouse button to open a shortcut menu. On the shortcut menu, choose NEW MODULE...

Page 46 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module This action opens the SELECT MODULE dialog box.

Procedures Setup Guide

Select the 1756-MODULE (GENERIC 1756 MODULE) from the list and click OK. This action opens the NEW MODULE dialog box.

ProSoft Technology, Inc. April 18, 2011

Page 47 of 78

Procedures Setup Guide 3

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module In the NEW MODULE dialog box, enter the following values.
Value MCM Enter a description for the module. Example: Modbus Communication Module Select DATA-INT Enter the slot number in the rack where the MVI56E-MCM module is located 1 250 2 248 0

Parameter NAME DESCRIPTION COMM FORMAT SLOT INPUT ASSEMBLY INSTANCE INPUT SIZE OUTPUT ASSEMBLY INSTANCE OUTPUT SIZE CONFIGURATION SIZE

CONFIGURATION ASSEMBLY INSTANCE 4

Important: You must select the COMM FORMAT as DATA - INT in the dialog box, otherwise the module will not communicate over the backplane of the ControlLogix rack. 4 5 Click OK to continue. Edit the Module Properties. Select the REQUESTED PACKET INTERVAl value for scanning the I/O on the module. This value represents the minimum frequency at which the module will handle scheduled events. This value should not be set to less than 1 millisecond. The default value is 5 milliseconds. Values between 1 and 10 milliseconds should work with most applications.

Save the module

Page 48 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

Click OK to close the dialog box. Notice that the module now appears in the CONTROLLER ORGANIZATION window.

4.4.3 Import the Ladder Rung

1 2 In the CONTROLLER ORGANIZATION window, expand the TASKS folder and subfolders until you reach the MAINPROGRAM folder. In the MAINPROGRAM folder, double-click to open the MAINROUTINE ladder.

ProSoft Technology, Inc. April 18, 2011

Page 49 of 78

Procedures Setup Guide 3

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module Select an empty rung in the routine, and then click the right mouse button to open a shortcut menu. On the shortcut menu, choose IMPORT RUNG

Navigate to the location on your PC where you saved (page 45) the Add-On Instruction (for example, My Documents or Desktop). Select the MVI56(E)MCM_ADDON_RUNG_V2_2.L5X file

Page 50 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module This action opens the IMPORT CONFIGURATION dialog box, showing the controller tags that will be created.

Procedures Setup Guide

If you are using the module in a different slot (or remote rack), select the correct connection input and output variables that define the path to the module. If your module is located in Slot 1 of the local rack, this step is not required. Click OK to confirm the import. RSLogix will indicate that the import is in progress:

ProSoft Technology, Inc. April 18, 2011

Page 51 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module When the import is completed, the new rung with the Add-On Instruction will be visible as shown in the following illustration.

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

Save the application and then download the sample ladder logic into the processor.

Page 52 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.5

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.

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

ProSoft Technology, Inc. April 18, 2011

Page 53 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.6

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.

If you are not already online with the processor, open the Communications menu, and then choose DOWNLOAD. 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. When communication is established, RSLogix 5000 will open a confirmation dialog box. Click the DOWNLOAD button to transfer the sample program to the processor.

3 4

RSLogix 5000 will compile the program and transfer it to the processor. This process may take a few minutes. 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 54 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.7

Setting up the Read and Write Database Areas

The next part of this tutorial is to configure the MVI56E-MCM database read and write areas to define how data will be transferred between the processor and the MVI56E-MCM module.
Description Start Register Database Address Parameter Register Count Database Parameter MCM.CONFIG.ModDef. WriteRegCnt MCM.CONFIG.ModDef. ReadRegCnt Data Controller Tag Array Name MCM.DATA.WriteData

Write Area

Database area transferred MCM.CONFIG.ModDef. WriteStartReg from processor to the module Database area transferred MCM.CONFIG.ModDef. ReadStartReg from module to the processor

Read Area

MCM.DATA.ReadData

The Write Data and Read Data areas are configured through the following controller tags.

The settings in the sample application above correspond with the following memory diagram.

ProSoft Technology, Inc. April 18, 2011

Page 55 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.7.1 Configuring Modbus Port 1 (P1)

The sample application uses the following configuration settings for Modbus Port 1 (Master) on the MVI56E-MCM module.
Parameter Modbus Protocol Baud Rate Parity Data Bits Stop Bits Value RTU 19200 None 8 1

The MODBUS PORT X configuration parameters are used when the module is configured as a Modbus Master device. Port 1 and Port 2 each have their own set of parameters to configure.

Page 56 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

In RSLogix 5000, expand the MCM.CONFIG.MODDEF controller tag, and navigate to MCM.CONFIG.PORT1. Any parameters not mentioned in this section are not used or not essential when the module is configured as a Modbus Master. The following table describes the relevant parameters in the MCM.CONFIG.MODDEF.PORT1 tag array.
Parameter Enabled Type Protocol Baudrate Description 1 = ENABLE PORT, 0 = disable port 0=MASTER, 1=Slave, 2=Slave: pass-through, 3=Slave: formatted passthrough/data swapped, 4=Slave: form. Pass-through 0 = Modbus RTU mode, 1 = Modbus ASCII mode Sets the baud rate for the port. Valid values for this field are 110, 150, 300, 600, 1200, 4800, 9600, 19200, 384 or 3840 (for 38,400 baud), 576 or 5760 (for 57,600 baud) and 115,1152, or 11520 (for 115,200 baud) 0 = None, 1 = Odd, 2 = Even Modbus RTU mode = 8 Modbus ASCII mode = 8 or 7 Valid values are 1 or 2. No or Yes This parameter is used to enable or disable hardware handshaking. The default setting is No hardware handshaking, CTS Line not used. Set to No if the connected devices do not need hardware handshaking. Set to Yes if the devices connected to the port require hardware handshaking (most modern devices do not) If you set this parameter to Yes, be sure to pay attention to the pinout and wiring requirements to be sure the hardware handshaking signal lines are properly connected; otherwise communication will fail. 0 to 65535 milliseconds response timeout for command Note: 1000 = 1000 milliseconds (1 second) before it will either reissue the command, if RETRYCOUNT > 0, or, if the RetryCount =0 or has already been met, then it will move on to the next command in the list. Number of times to retry a failed request before moving to the next command on the list. 0-65535 milliseconds The amount of delay in milliseconds to be inserted after receiving a slave response or encountering a response timeout before retrying the command or sending the next command on the list. Use this parameter to slow down overall polling speed and spread out commands on networks with slaves that require additional gaps between messages. Internal DB location to place command error list Note: Set Master Command Errors location. Each command will reserve one word for the command error code for that command. See Verify Communication. CMDERRPTR value should be within the range of the READDATA array. See Backplane Configuration.

Parity DataBits StopBits UseCts

RespTO

RetryCount MinCmdDelay

CmdErrPtr

ProSoft Technology, Inc. April 18, 2011

Page 57 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.7.2 Configuring the Modbus Master Read Command

The Modbus Read Command reads 10 words of data from the Quantum processor (Modbus Slave) and transfers it to the MVI56E-MCM module's internal database. The following table describes the relationship between memory addresses in the Modbus Master (MVI56E-MCM) and the Modbus Slave (Quantum processor).
MVI56E-MCM Database Address 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 Quantum Memory Address 400801 400802 400803 400804 400805 400806 400807 400808 400809 400810

In the sample program, the Modbus Read Command is present, but disabled. To enable the command, change the 0 (zero) to 1 (one) in the MCM.CONFIG.PORT1MASTERCMD[0].ENABLE tag. Be sure the tag MCM.CONFIG.PORT1MASTERCMD[0].DEVADDRESS, is set to 800, as shown in the following illustration.

Notes: Func 3 represents Modbus Function Code 3, the command code to Read Holding Registers The DevAddress parameter is 0-based so 800 = 400801, 801 = 400802, and so on. The Enable code must be set to 1 to enable the command (0 = disable) The destination Slave node address must be set as 1 (Node parameter)

Page 58 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.7.3 Configuring the Modbus Master Write Command

The Modbus Write Command will write data from the MVI56E-MCM module to the Quantum processor as follows.
MVI56E-MCM Database Address 0 1 2 3 4 5 6 7 8 9 Quantum Memory Address 400401 400402 400403 400404 400405 400406 400407 400408 400409 400411

In the sample program, a Modbus Write Command is present, but disabled. To enable this command, change the 0 (zero) to 1 (one) in the MCM.CONFIG.PORT1MASTERCMD[1].ENABLE tag. Be sure the tag, MCM.CONFIG.PORT1MASTERCMD[1].NODE, is set to 400 as shown in the following illustration.

Notes: FUNC 16 represents Modbus Function Code 16, the command code to Preset (Write) Holding Registers The DEVADDRESS parameter is 0-based so 400 = 400401, 401 = 400402, and so on. The ENABLE code must be set to 1 to enable the command (0 = disable). The destination Slave node address must be set as 1 (NODE parameter)

ProSoft Technology, Inc. April 18, 2011

Page 59 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.8

Rebooting the Module to Transfer New Parameter Values

The changes you made in the sample program do not take effect until you reboot the module. 1 Locate the MCM.CONTROL.WARMBOOT controller tag.

Enter a value of 1 into this controller tag.

Verify that the tag value is automatically reset to zero (0) after a short delay.

The module is now configured with the new parameters, and will begin exchanging data with the processor.

Page 60 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.9

Configuring the Quantum Processor as a Modbus Slave

The next part of this tutorial is to configure the remote Modbus Slave. For this example, the Modbus Slave will be a Quantum processor. The communication port settings for the Modbus Slave must match the Port 1 settings for the Modbus Master. Use the values in the following table to configure the Quantum processor with Schneider Electric's Concept programming software (version 2.6 or higher).
Parameter Node Address Modbus Protocol Baud Rate Parity Data Bits Stop Bits Value 1 RTU 19200 None 8 1

The following illustration shows the MODBUS PORT SETTINGS dialog box in Concept version 2.6.

ProSoft Technology, Inc. April 18, 2011

Page 61 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.10

Connecting the MVI56E-MCM Module to the Quantum Processor

The final part of this tutorial is to connect the supplied RJ45 to DB9 adaptor and the supplied null modem cable to Port 1 on the MVI56E-MCM module, and Modbus Comm1 on the Quantum processor. The following illustration shows the serial connection between the MVI56E-MCM module and the Quantum processor.

Page 62 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.11

Verifying Communication
There are several ways to verify that the MVI56E-MCM module is communicating with the processor and with the Modbus Master/Slave network. You can: View Exchanged Data (page 63) View the Module Status in the RSLogix 5000 Controller Tags (page 66) View the LED Status Indicators

4.11.1 Viewing Exchanged Data

The following illustration describes the source and destination for the data exchanged by the two Modbus Master Commands.

ProSoft Technology, Inc. April 18, 2011

Page 63 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Checking Write Data The following steps show you how to verify that the WriteData Command is working. 1 In RSLogix, navigate to the processor controller tags MCM.DATA.WRITEDATA[0] through MCM.DATA.WRITEDATA[9]. 2 For words [0] through [9], enter the numbers shown in the following illustration.

This action sends the values you entered to the Modbus Master Port on the MVI56E-MCM, and then to the Quantum processor, where you will be able to see the data in Concept. In Concept, navigate to the REFERENCE DATA EDITOR to monitor the processor memory addresses from 400401 through 400410. The data should match the data you sent from RSLogix 5000.

Page 64 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

Checking Read Data The following steps show you how to verify that the ReadData Command is working. 1 In Concept, navigate to the REFERENCE DATA EDITOR, and enter the following values in processor memory addresses from 400801 through 400810 as shown in the following illustration.

This action populates the memory addresses in the Quantum processor that the MVI56E-MCM will attempt to retrieve with the ReadData Command. In RSLogix 5000, the values in MCM.DATA.READDATA[0] through [9] should match the data you entered in Concept.

Tip: Repeat these tests, using different values each time, to verify that the same data appears in the proper place in each processor.

ProSoft Technology, Inc. April 18, 2011

Page 65 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.11.2 Checking Module Status through ControlLogix Controller Tags

You can view network status through the ControlLogix controller tags that are updated through the MVI56E-MCM sample ladder. To verify that the Modbus Master is communicating with one or more Modbus Slaves, view the contents of the two ReadData array elements beginning at the address you used for MCM.CONFIG.PORTX.CMDERRPTR parameter, minus the value of the MCM.CONFIG.MODDEF.READSTARTREG tag. In this case, the CmdErrPtr was set to 1500 and the ReadStartReg to 1000. This means that (1500 1000 = 500); so READDATA[500] and READDATA[501] will tell you the individual status of each of the two commands issued by the module. To verify that the Modbus Slave is communicating with a Modbus Master, view the contents of the MCM.STATUS.PRTXERRS tag for total commands issued, responses received, errors, and so on.

The following controller tags should continuously increment indicating that Port 1 is continuously sending commands and receiving responses: MCM.STATUS.PRT1ERRS.CMDREQ MCM.STATUS.PRT1ERRS.CMDRESP MCM.STATUS.PRT1ERRS.REQUESTS MCM.STATUS.PRT1ERRS.RESPONSES If the error counters continuously increment, the LASTERROR controller tag value shows the command index which caused the latest failure. You can refer to the command error pointer feature to read the command error codes as previously discussed.

Page 66 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Procedures Setup Guide

4.11.3 Scrolling LED Status Indicators

The scrolling LED display indicates the modules operating status as follows: Initialization Messages
Code Boot / DDOK Ladd Waiting for Processor Connection Message Module is initializing Module is waiting for required module configuration data from ladder logic to configure the Modbus ports Module did not connect to processor during initialization Sample ladder logic or AOI is not loaded on processor Module is located in a different slot than the one configured in the ladder logic/AOI Processor is not in RUN or REM RUN mode Indicates the last date when the module changed its IP address. You can update the module date and time through the modules web page, or with the MVI56E Optional Add-On Instruction. After power up and every reconfiguration, the module will display the configuration of both ports. The information consists of: Modbus mode: RTU/ASCII Port type: Master/Slave Baud: 115200 / 57600 / 38400 / 19200 / 9600/ 4800 / 2400 / 1200 / 600 / 300 Parity: None / Even / Odd Data bits: 7 / 8 Stop bits: 1 / 2 RS Interface: RS-232 / RS-422 / RS-485 ID: Slave Modbus Address Cmds: Configured Modbus Master Commands

Last config: <date>

Config P1/P2 <Modbus mode> <Port type> <Baud> <Parity> <Data bits> <Stop Bits> <RS Interface> <ID (Slave)> <Cmds: (Master)>

Operation Messages After the initialization step, the following message pattern will be repeated.
<Backplane Status> <IP Address> <Backplane Status> <Port Status> Code <Backplane Status> Message OK: Module is communicating with processor ERR: Module is unable to communicate with processor. For this scenario, the <Port Status> message above is replaced with "Processor faulted or is in program mode". Module IP address OK: Port is communicating without error Master/Slave Communication Errors: port is having communication errors. Refer to PCB diagnostics for further information about the error.

<IP Address> <Port Status>

ProSoft Technology, Inc. April 18, 2011

Page 67 of 78

Procedures Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

4.11.4 Non-Scrolling LED Status Indicators

The non-scrolling LEDs indicate the modules operating status as follows:
LED Label APP Color Red or Green Status OFF Indication The module is not receiving adequate power or is not securely plugged into the rack. May also be OFF during configuration download. The MVI56E-MCM is working normally. The most common cause is that the module has detected a communication error during operation of an application port. The following conditions may also cause a RED LED: The firmware is initializing during startup The firmware detects an on-board hardware problem during startup Failure of application port hardware during startup The module is shutting down The module is rebooting due to a ColdBoot or WarmBoot request from the ladder logic or Debug Menu The module is not receiving adequate power or is not securely plugged into the rack. The module is operating normally. The module has detected an internal error or is being initialized. If the LED remains RED for over 10 seconds, the module is not working. Remove it from the rack and re-insert it to restart its internal program. The battery voltage is OK and functioning. The battery voltage is low or battery is not present. Allow battery to charge by keeping module plugged into rack for 24 hours. If ERR LED still does not go off, contact ProSoft Technology, as the battery is not a user-serviceable item.

GREEN RED

OK

Red or Green

OFF GREEN RED

ERR

Red

OFF ON

Page 68 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Building on Success Setup Guide

Building on Success
In This Chapter
Frequently Asked Questions ................................................................. 70

Now that you have successfully installed, configured, and verified operation of the MVI56E-MCM module, you should have a better understanding of how to make it work for your specific application. The following resources are available to help you build on your success. For more information about the MVI56E-MCM module, including detailed hardware and software configuration, troubleshooting, and application information, refer to the MVI56E-MCM User Manual. For technical support and warranty information for your MVI56E-MCM module, refer to Support, Service, and Warranty in the MVI56E-MCM User Manual. For more information on ProSoft Technology products and services, please visit www.prosoft-technology.com.

ProSoft Technology, Inc. April 18, 2011

Page 69 of 78

Building on Success Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

5.1

Frequently Asked Questions 5.1.1 What are the differences between the MVI56 and the MVI56E modules? What does the "E" stand for?
The "E" stands for Enhanced with Ethernet communication capabilities. The new enhancements are: PCB: MVI56E-MCM products now use PCB (ProSoft Configuration Builder) software; a Windows-based configuration utility providing a new graphic user interface for module diagnostics with screen navigation, improving interoperability with the module. Seamless Migration: MVI56E products are backward compatible with existing ladder logic and module configuration files, allowing for a smooth "plug and play" transition when replacing the earlier version MVI56-MCM product. Personality Memory Module: The module incorporates a non-volatile compact flash (CF) memory card for storing the modules network configuration data (or personality). This feature allows quick replacement of faulted modules and restoration of systems by a simple exchange of the Personality Memory Module, with absolutely no other PC or configuration requirements. Ethernet Configuration Port: Allows for remote module connectivity. Replaces serial communication and becomes the primary configuration port, as well as providing a web server interface. LED Display: The 4-character, scrolling, alphanumeric LED display provides additional detailed plain English diagnostic and error information, backplane communication, and network conditions for the module, . Discovery Service: Allows PCB configuration software (or separate utility) to find and display products located on the network using key product attributes such as name, serial number, and IP address. The user will be able to change IP address, upload/download, and enter into diagnostics from the list. CIPconnect enabled: Allows end-users to connect from remote locations to local- and remote-chassis-installed MVI56E modules from anywhere on a Rockwell Automation EtherNet/IP or ControlNet process network, up to six remote links away.

5.1.2 Is the MVI56E product a direct replacement to my existing MVI56 product?

Yes

5.1.3 How is the MVI56E-MCM configured?

The module is configured with ladder logic controller tags. A warm boot operation is required to transfer all parameters from the processor to the module.

Page 70 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Building on Success Setup Guide

5.1.4 What is ProSoft Configuration Builder (PCB)?

ProSoft Configuration Builder (PCB) provides a quick and easy way to manage module diagnostics and troubleshooting operations. Built-in module diagnostics menus and the serial port data stream analyzer can be accessed using PCB through the module's high-speed Ethernet configuration port (E1) or though Rockwell Automation 1756-ENxT or 1756-CNBx communications interfaces using CIPconnect.

5.1.5 What is ProSoft Discovery Service (PDS)?

ProSoft Discovery Service (PDS) is Windows-based software that connects to the Ethernet port of the module for the following purposes: Automatic module discovery on the Ethernet network Set a temporary IP address for the module for easy commissioning Allow PCB to select the module for monitoring and IP address reconfiguration The ProSoft Discovery Service software is supplied as a stand-alone utility, as well as being integrated into PCB.

5.1.6 What is the purpose of the MVI56E-MCM Ethernet Config (E1) Port?
The MVI56E-MCM Ethernet Port (E1) allows a remote PC to set the modules IP address, as well as monitor module operation using ProSoft Configuration Builder (PCB) diagnostics. You can also set the IP address with ladder logic. Refer to the MVI56E-MCM User Manual for more information on this option.

5.1.7 How do I change the modules IP address?

1 2 3 Use ProSoft Discovery Service to temporarily change a MVI56E module's configuration port IP address. Use ProSoft Configuration Builder to edit and download the Ethernet configuration to the module. Use the Optional Add-On Instruction (AOI). The AOI file is available on the ProSoft Solutions CD-ROM, or can be downloaded from www.prosoft-technology.com.

5.1.8 Does the MVI56E-MCM module require processor logic?

Yes, ladder logic is required for data transfer between the MVI56E module and the ControlLogix processor. For RSLogix 5000 version 16 applications (or later), the included Add-On Instruction encapsulates the entire ladder logic into one single instruction. For RSLogix 5000 version 15 and older, sample ladder logic is available from the ProSoft Technology website at www.prosoft-technology.com.

ProSoft Technology, Inc. April 18, 2011

Page 71 of 78

Building on Success Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

5.1.9 What is the purpose of the Optional MVI56E-MCM Add-On Instruction?

The Optional Add-On Instruction (AOI) allows the processor to perform the following tasks: 1 Set the MVI56E Ethernet settings 2 Read the MVI56E Ethernet settings 3 Set MVI56E date/time information 4 Read the MVI56E date/time information Items 1 and 2 can also be performed through ProSoft Configuration Builder (PCB) for permanent IP address changes or through ProSoft Discovery Service for temporary changes. Items 3 and 4 can also be performed through the module's built-in web page. The Optional AOI is needed only for specific applications where Ethernet or CIPconnect access from a programmer's personal computer (PC) to the module is not possible.

5.1.10 How do I monitor MVI56E-MCM operation?

Module operation can be monitored either through the processor controller tags or through the ProSoft Configuration Builder diagnostic window. Available status information includes number of messages sent, number of messages received, number of errors, and error codes.

5.1.11 Are there any other ways to monitor module diagnostics besides being connected to the modules network (subnet)?
PCB can monitor the module via ControlLogix backplanes and process networks using CIPconnect. The PC running PCB can use its Ethernet port to connect to any 1756-ENxT EtherNet/IP interface module which is on the same Ethernet subnet. Through this connection, PCB can use CIPconnect to route through the ControlLogix backplane to other 1756-ENxT or 1756-CNBx modules, for up to five more route links, to reach an MVI56E module in a chassis connected on EtherNet/IP or ControlNet process networks.

Page 72 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Glossary of Terms Setup Guide

Glossary of Terms
A ASCII American Standard Code for Information Interchange. A communication mode in which each eight-bit byte in a message contains one ASCII character code. ASCII characters (or hexadecimal characters) are sometimes used as a key to encrypt data and ensure its secure transmission. B Baud Rate The speed of communication between devices on the network. All devices must communicate at the same rate. C Client A client is a software program, or the device on which that program runs, that makes requests for information from a software program, or the device on which that program runs, in a client-server relationship. A Client on an Ethernet network is equivalent to a Master on a serial network. D DCE Data communications equipment. A modem, for example. Default Gateway The IP address of a network router where data is sent if the destination IP address is outside the local subnet. The gateway is the device that routes the traffic from the local area network to other networks such as the Internet. DTE Data terminal equipment. A computer or terminal, for example. E ESD Electrostatic Discharge. Can cause internal circuit damage to the coprocessor. Ethernet A set of network cabling and network access (CSMA/CD) protocol standards for bus topology computer networks invented by Xerox but now controlled by the 802.3 subcommittee of the IEEE.

ProSoft Technology, Inc. April 18, 2011

Page 73 of 78

Glossary of Terms Setup Guide F Firmware Software for embedded computers.

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Full-Duplex A communications circuit or system designed to simultaneously transmit and receive two different streams of data. Telephones are an example of a full-duplex communication system. Both parties on a telephone conversation can talk and listen at the same time. If both talk at the same time, their two signals are not corrupted. H Half-Duplex A communications circuit or system designed to transmit and receive data, but not both simultaneously. CB or walkie-talkie radios are an example of a halfduplex communication system. Either parties on a radio conversation may talk or listen; but both cannot talk at the same time without corrupting each other's signal. If one operator is "talking", the other must be "listening" to have successful communication. I IP Address A 32-bit identification number for each node on an Internet Protocol network. These addresses are represented as four sets of 8-bit numbers (numbers from 0 to 255), separated by periods ("dots"). Networks using the TCP/IP Protocol route messages based on the IP address of the destination. Each number can be 0 to 255. For example, 192.168.0.100 could be an IP address. Each node on the network must have a unique IP address. L LED Light-emitting diode. M MAC ID A hexadecimal number that uniquely identifies an Ethernet device. Master A Master is a device that makes requests for information from a software program, or the device on which that program runs, in a Master-Slave relationship. A Client on an Ethernet network is equivalent to a Master on a Serial network.

Page 74 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module N

Glossary of Terms Setup Guide

Network A series of stations or nodes connected by some type of communication medium. A network may consist of a single link or multiple links. Node An address or software location on the network. P Peer-to-Peer A network relationship between devices where each device can send commands as a master or client, and respond to commands as a slave or server. Power Supply Device that supplies electrical power to the I/O chassis containing the processor, coprocessor, or other modules. Protocol The language or packaging of information that is transmitted between nodes on a network. R RS-232 Recommended Standard 232; the standard for serial binary signals between DTE and DCE devices. S Serial Data/Serial Data Transmission Data that is transferred one bit at a time. Serial data transmission involves changing a carrier signal line between two possible states to indicate a binary 0 or binary 1 value. Successive data bits are rapidly transmitted one after the other with a fixed time allowed for each bit. Data bits are usually grouped into "packets", which contain a specific amount of data bits, along with extra bits included to provide error-checking capability. Server A Server is a software program, or the device on which that program runs, that provides a specific kind of service to a Client software program, or the device on which that program runs, on an Ethernet network. A Server on an Ethernet network is equivalent to a Slave on a Serial network.

ProSoft Technology, Inc. April 18, 2011

Page 75 of 78

Glossary of Terms Setup Guide

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

Simplex A communications circuit or system designed to either transmit data or receive data, but not both. Broadcast television is an example of simplex communication system. A television station sends a TV signal but cannot receive responses back from the television sets to which it is transmitting. The TV sets can receive the signal from the TV station but cannot transmit back to the station. Slave A Slave is a software program, or the device on which that program runs, which provides a specific kind of service to a Master software program, or the device on which that program runs, on a serial network. A Slave on a Serial network is equivalent to a Server on an Ethernet network. Subnet Mask A mask used to determine what subnet an IP address belongs to. An IP address has two components: the network address, and the host (node or device) address. For example, consider the IP address 150.215.017.009. Assuming this is part of a Class B network (with a subnet mask of 255.255.0.0), the first two numbers (150.215) represent the Class B network address, and the second two numbers (017.009) identify a particular host on this network.

Page 76 of 78

ProSoft Technology, Inc. April 18, 2011

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module F

Index Setup Guide

Index
A
About the MODBUS Protocol 18 Architecture 20 Are there any other ways to monitor module diagnostics besides being connected to the modules network (subnet)? 72 ASCII 73

Firmware 74 Frequently Asked Questions 70 Full-Duplex 74

G
General Overview 19

H
Half-Duplex 74 How do I change the modules IP address? 71 How do I monitor MVI56E-MCM operation? 72 How is the MVI56E-MCM configured? 70 How to Contact Us 2

B
Battery Life Advisory 4 Baud Rate 73 Before You Begin 13 Building on Success 69

I
Import the Ladder Rung 49 Important Safety Information - MVI56E-MCM/XT 3 Importing the Sample Add-On Instruction 45, 50 Installing the Module in the Rack 25 IP Address 74 Is the MVI56E product a direct replacement to my existing MVI56 product? 70

C
Checking Module Status through ControlLogix Controller Tags 63, 66 Checking Read Data 65 Checking Write Data 64 Client 73 Configuring Modbus Port 1 (P1) 19, 56 Configuring the Modbus Master Read Command 19, 58 Configuring the Modbus Master Write Command 19, 59 Configuring the Quantum Processor as a Modbus Slave 9, 19, 61 Connecting the MVI56E-MCM Module to the Quantum Processor 62 Connecting Your PC to the ControlLogix Processor 19, 53 Connecting Your PC to the Module's Ethernet Port 29 Creating a New RSLogix 5000 Project 19, 45 Creating the Module 46

L
Learning Objectives 9 LED 74

M
MAC ID 74 Master 74 Memory Map 21

N
Network 75 Node 75 Non-Scrolling LED Status Indicators 68

P
Peer-to-Peer 75 Power Supply 75 Prerequisites 11 Procedures 23 ProSoft Technology Documentation 10 ProSoft Technology Product Documentation 2 Protocol 75

D
DCE 73 Default Gateway 73 Does the MVI56E-MCM module require processor logic? 71 Downloading the Sample Program to the Processor 9, 19, 54 DTE 73

R
Rebooting the Module to Transfer New Parameter Values 19, 60 Required Items 15 Required Steps 19 RS-232 75

E
ESD 73 Ethernet 73 Example 1 Local Rack Application 37 Example 2 Remote Rack Application 40

ProSoft Technology, Inc. April 18, 2011

Page 77 of 78

Index Setup Guide S

Sample Files 16 Scope 7 Scrolling LED Status Indicators 67 Serial Data/Serial Data Transmission 75 Server 75 Setting Module Jumpers 24 Setting Up a Permanent IP Address 31, 33 Setting Up a Temporary IP Address 30 Setting Up the Project 28 Setting up the Read and Write Database Areas 55 Simplex 76 Slave 76 Subnet Mask 76 System Requirements 14

MVI56E-MCM / MCMXT ControlLogix Platform Modbus Communication Module

T
The Sample Application 9, 17

U
Using CIPconnect to Connect to the Module 33, 35, 44 Using ProSoft Configuration Builder Software 27 Using RSWho to Connect to the Module 33, 44

V
Verifying Communication 9, 19, 63 Viewing Exchanged Data 63

W
What are the differences between the MVI56 and the MVI56E modules? What does the 70 What is ProSoft Configuration Builder (PCB)? 71 What is ProSoft Discovery Service (PDS)? 71 What is the purpose of the MVI56E-MCM Ethernet Config (E1) Port? 71 What is the purpose of the Optional MVI56E-MCM Add-On Instruction? 72 What's New? 8

Y
Your Feedback Please 2

Page 78 of 78

ProSoft Technology, Inc. April 18, 2011