MVI69-MNET

CompactLogix and MicroLogix 1500

Platform
Modbus TCP/IP Communication
Module

October 17, 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
[email protected]

Copyright © 2011 ProSoft Technology, Inc., all rights reserved.

MVI69-MNET User Manual

October 17, 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 in
Adobe® Acrobat Reader file format (.PDFs). These product documentation files may also be freely downloaded 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:

WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR CLASS
I, DIV. 2;
WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE
REPLACING OR WIRING MODULES
WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.

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.
Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is
known to be non-hazardous.
C 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.

Warning: This module is not hot-swappable! Always remove power from the rack before inserting or removing this
module, or damage may result to the module, the processor, or other connected devices.
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
 Power Supply Distance Rating: 2
 Operating Temperature: 0°C to 60°C (32°F to 140°F)
 Storage Temperature: -40°C to 85°C (-40°F to 185°F)
 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
<cULus>
E193122
Class I Div 2
Groups A,B,C,D T6
-30°C <= Ta <= 60°C
<ATEX>
II 3 G
Ex nA IIC T6 X
0°C <= Ta <= +60°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.

Agency Approvals and Certifications

Agency Applicable Standard(s)
ATEX EN 60079-0:2006, EN 60079-15:2005
DNV DET NORSKE VERITAS Test 2.4
CE EN61000-6-4:2007
CB Safety CA/10533/CSA, IEC 61010-1 Ed. 2, CB 243333-2056722
(2090408)
GOST-R EN 61010
CSA 61010
cULus UL508, UL1604, CSA 22.2 No 142 & 213

ME06 E193122
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Contents
Modbus TCP/IP Communication Module 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 ........................................................................................................................... 4 
Markings.............................................................................................................................................. 4 

Guide to the MVI69-MNET User Manual 9 

1  Start Here 11 

1.1  System Requirements ............................................................................................. 12 
1.2  Package Contents ................................................................................................... 13 
1.3  Installing ProSoft Configuration Builder Software ................................................... 14 
1.4  Setting Jumpers ...................................................................................................... 15 
1.5  Installing the Module ............................................................................................... 16 

2  Configuring the MVI69-MNET Module 19 

2.1  MVI69-MNET Add-On Instruction Rung Import Procedure ..................................... 20 
2.1.1  Creating a New RSLogix 5000 Project.................................................................... 21 
2.1.2  Creating the Module ................................................................................................ 22 
2.1.3  Importing the Ladder Rung ..................................................................................... 24 
2.1.4  Setting the Read and Write Data Array Sizes ......................................................... 29 
2.1.5  Setting the Block Transfer Size ............................................................................... 31 
2.1.6  Setting the Connection Input and Output Sizes ...................................................... 32 
2.1.7  Adding Multiple Modules (Optional) ........................................................................ 34 
2.2  Connecting Your PC to the Processor .................................................................... 40 
2.3  Downloading the Sample Program to the Processor .............................................. 41 
2.3.1  Configuring the RSLinx Driver for the PC COM Port .............................................. 42 
2.4  Connecting Your PC to the Module......................................................................... 44 
2.5  Using ProSoft Configuration Builder ....................................................................... 45 
2.5.1  Setting Up the Project ............................................................................................. 45 
2.5.2  Setting Module Parameters ..................................................................................... 47 
2.6  Module Configuration .............................................................................................. 49 
2.6.1  Module ..................................................................................................................... 49 
2.6.2  MNET Client x ......................................................................................................... 52 
2.6.3  MNET Client x Commands ...................................................................................... 55 
2.6.4  MNET Servers ......................................................................................................... 62 
2.6.5  Static ARP Table ..................................................................................................... 65 
2.6.6  Ethernet Configuration ............................................................................................ 66 
2.7  Downloading the Project to the Module Using a Serial COM Port .......................... 67 

3  Ladder Logic 69 

3.1  Controller Tags ........................................................................................................ 69 

ProSoft Technology, Inc. Page 5 of 159

October 17, 2011
Contents MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

3.1.1  MVI69-MNET Controller Tags ................................................................................ 70 

3.2  User-Defined Data Types (UDTs)........................................................................... 71 
3.2.1  MVI69-MNET User-Defined Data Types ................................................................ 71 
3.3  Using Controller Tags ............................................................................................. 73 
3.4  Adding the Module to an Existing CompactLogix Project ....................................... 73 
3.5  Adding the Module to an Existing MicroLogix Project ............................................ 77 

4  Diagnostics and Troubleshooting 79 

4.1  LED Status Indicators ............................................................................................. 80 
4.1.1  Ethernet LED Indicators.......................................................................................... 80 
4.1.2  Clearing a Fault Condition ...................................................................................... 81 
4.1.3  Troubleshooting ...................................................................................................... 81 
4.2  Using ProSoft Configuration Builder (PCB) for Diagnostics ................................... 82 
4.2.1  Using the Diagnostic Window in ProSoft Configuration Builder ............................. 82 
4.2.2  Navigation ............................................................................................................... 85 
4.2.3  Main Menu .............................................................................................................. 86 
4.2.4  Modbus Database View Menu ................................................................................ 89 
4.2.5  Network Menu ......................................................................................................... 91 
4.3  Reading Status Data from the Module ................................................................... 92 
4.3.1  Status Data Definition ............................................................................................. 93 
4.3.2  Configuration Error Word ........................................................................................ 95 
4.3.3  Client Command Errors .......................................................................................... 96 

5  Reference 99 
5.1  Product Specifications ............................................................................................ 99 
5.1.1  Modbus TCP/IP....................................................................................................... 99 
5.1.2  Functional Specifications ...................................................................................... 100 
5.1.3  Hardware Specifications ....................................................................................... 101 
5.2  Functional Overview ............................................................................................. 102 
5.2.1  Module Power Up ................................................................................................. 102 
5.2.2  Backplane Data Transfer ...................................................................................... 102 
5.2.3  Data Flow between MVI69-MNET Module and Processor ................................... 123 
5.3  Cable Connections ............................................................................................... 128 
5.3.1  Ethernet Connection ............................................................................................. 128 
5.3.2  RS-232 Configuration/Debug Port ........................................................................ 130 
5.3.3  DB9 to RJ45 Adaptor (Cable 14) .......................................................................... 132 
5.4  Modbus Protocol Specification ............................................................................. 133 
5.4.1  About the MODBUS TCP/IP Protocol ................................................................... 133 
5.4.2  Read Coil Status (Function Code 01) ................................................................... 134 
5.4.3  Read Input Status (Function Code 02) ................................................................. 135 
5.4.4  Read Holding Registers (Function Code 03) ........................................................ 136 
5.4.5  Read Input Registers (Function Code 04) ............................................................ 137 
5.4.6  Force Single Coil (Function Code 05) .................................................................. 138 
5.4.7  Preset Single Register (Function Code 06) .......................................................... 139 
5.4.8  Diagnostics (Function Code 08) ........................................................................... 140 
5.4.9  Force Multiple Coils (Function Code 15) .............................................................. 142 
5.4.10  Preset Multiple Registers (Function Code 16) ...................................................... 143 
5.4.11  Modbus Exception Responses ............................................................................. 144 

Page 6 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Contents
Modbus TCP/IP Communication Module User Manual

6  Support, Service & Warranty 147 

Contacting Technical Support ......................................................................................................... 147 
6.1  Return Material Authorization (RMA) Policies and Conditions.............................. 149 
6.1.1  Returning Any Product .......................................................................................... 149 
6.1.2  Returning Units Under Warranty ........................................................................... 149 
6.1.3  Returning Units Out of Warranty ........................................................................... 150 
6.2  LIMITED WARRANTY........................................................................................... 151 
6.2.1  What Is Covered By This Warranty ....................................................................... 151 
6.2.2  What Is Not Covered By This Warranty ................................................................ 152 
6.2.3  Disclaimer Regarding High Risk Activities ............................................................ 152 
6.2.4  Intellectual Property Indemnity .............................................................................. 153 
6.2.5  Disclaimer of all Other Warranties ........................................................................ 153 
6.2.6  Limitation of Remedies ** ...................................................................................... 154 
6.2.7  Time Limit for Bringing Suit ................................................................................... 154 
6.2.8  No Other Warranties ............................................................................................. 154 
6.2.9  Allocation of Risks ................................................................................................. 154 
6.2.10  Controlling Law and Severability ........................................................................... 155 

Index 157 

ProSoft Technology, Inc. Page 7 of 159

October 17, 2011
Contents MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Page 8 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Guide to the MVI69-MNET User Manual
Modbus TCP/IP Communication Module User Manual

Guide to the MVI69-MNET User Manual

Function Section to Read Details

Introduction  Start Here (page 11) This section introduces the customer to the
(Must Do) module. Included are: package contents,
system requirements, hardware installation, and
basic configuration.

Diagnostic and  Diagnostics and This section describes Diagnostic and

Troubleshooting Troubleshooting Troubleshooting procedures.
(page 79)

Reference  Reference (page 99) These sections contain general references

associated with this product and its
Product Specifications Product Specifications..
Specifications (page
99)

Support, Service, and  Support, Service This section contains Support, Service and
Warranty and Warranty (page Warranty information.
147)
Index Index of chapters.
Index

ProSoft Technology, Inc. Page 9 of 159

October 17, 2011
Start Here MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Page 10 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Start Here
Modbus TCP/IP Communication Module User Manual

1 Start Here

In This Chapter
 System Requirements ........................................................................... 12
 Package Contents ................................................................................. 12
 Installing ProSoft Configuration Builder Software .................................. 14
 Setting Jumpers .................................................................................... 15
 Installing the Module ............................................................................. 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 CompactLogix or MicroLogix devices to a power source
and to the MVI69-MNET module’s application port(s)

ProSoft Technology, Inc. Page 11 of 159

October 17, 2011
Start Here MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

1.1 System Requirements

The MVI69-MNET module requires the following minimum hardware and
software components:
 Rockwell Automation CompactLogix processors or MicroLogix 1500 LRP
processor, with compatible power supply and one free slot in the rack, for the
MVI69-MNET module. The module requires 800 mA of available power.

Important: The MVI69-MNET module has a power supply distance rating of 2 (L43 and L45
installations on first 2 slots of 1769 bus).
Important: For 1769-L23x processors, please make note of the following limitations.
 1769-L23-QBFC1B = 800 mA at 5 Vdc (One MVI69-MNET will use all 800 mA of available
power. No other modules can be used with an MVI69 module connected to this processor.)
 1769-L23E-QB1B = 1000 mA at 5 Vdc (One MVI69-MNET will use 800 mA of available power.
One other module can be used on this rack provided it consumes less than 200 mA at 5 Vdc.)
 1769-L23E-QBFC1B = 450 mA at 5 Vdc (No MVI69 module can be used with this processor.)

 Rockwell Automation RSLogix 5000 (CompactLogix) or RSLogix 500

(MicroLogix) programming software
 Rockwell Automation RSLinx communication software
 Pentium® II 450 MHz minimum. Pentium III 733 MHz (or better)
recommended
 Supported operating systems:
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
 HyperTerminal or other terminal emulator program capable of file transfers
using Ymodem protocol.

NOTE: MVI69/PS69 modules will not work with CompactLogix L4x processors using RSLogix 5000
v17. All other processor combinations and RSLogix versions will work correctly.

Page 12 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Start Here
Modbus TCP/IP Communication Module User Manual

1.2 Package Contents

The following components are included with your MVI69-MNET 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 MVI69-MNET Module MVI69-MNET Modbus TCP/IP Communication Module
1 Cable Cable #15 - RS232 For RS232 between a Personal Computer
Null Modem (PC) and the CFG port of the module
1 Cable Cable #14 - RJ45 For connecting the module’s port to Cable
to DB9 Male #15 for RS-232 connections
Adapter
1 inRAx Solutions CD Contains sample programs, utilities and
documentation for the MVI69-MNET
module.

If any of these components are missing, please contact ProSoft Technology

Support for replacement parts.

ProSoft Technology, Inc. Page 13 of 159

October 17, 2011
Start Here MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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.

To install ProSoft Configuration Builder from the ProSoft Technology website

1 Open your web browser and navigate to http://www.prosoft-
technology.com/pcb
2 Click the link at the Current Release Version section to download the latest
version of ProSoft Configuration Builder.
3 Choose SAVE or SAVE FILE when prompted.
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.

To install 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 PRODUCT DOCUMENTATION. This action opens a
Windows Explorer file tree window.
3 Click to open the UTILITIES folder. This folder contains all of the applications
and files you will need to set up and configure your module.
4 Double-click the SETUP CONFIGURATION TOOL folder, double-click the
PCB_*.EXE file and follow the instructions on your screen to install the
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.

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 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Start Here
Modbus TCP/IP Communication Module 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 MVI69-MNET 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 159

October 17, 2011
Start Here MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

1.5 Installing the Module

Before you attempt to install the module, make sure that the bus lever of the
adjacent module is in the unlocked (fully right) position.

Warning: This module is not hot-swappable! Always remove power from the rack before
inserting or removing this module, or damage may result to the module, the processor, or other
connected devices.

1 Align the module using the upper and lower tongue-and-groove slots with the
adjacent module and slide forward in the direction of the arrow.

2 Move the module back along the tongue-and-groove slots until the bus
connectors on the MVI69 module and the adjacent module line up with each
other.

Page 16 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Start Here
Modbus TCP/IP Communication Module User Manual

3 Push the module’s bus lever back slightly to clear the positioning tab and
move it firmly to the left until it clicks. Ensure that it is locked firmly in place.

4 Close all DIN-rail latches.

ProSoft Technology, Inc. Page 17 of 159

October 17, 2011
Start Here MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5 Press the DIN-rail mounting area of the controller against the DIN-rail. The
latches will momentarily open and lock into place.

Page 18 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2 Configuring the MVI69-MNET Module

In This Chapter
 MVI69-MNET Add-On Instruction Rung Import Procedure .................... 20
 Connecting Your PC to the Processor ................................................... 40
 Downloading the Sample Program to the Processor ............................. 41
 Connecting Your PC to the Module ....................................................... 44
 Using ProSoft Configuration Builder ...................................................... 45
 Module Configuration ............................................................................ 49
 Downloading the Project to the Module Using a Serial COM Port ......... 67

The MVI69-MNET module works on both the CompactLogix and the MicroLogix
platform. The ladder logic you should import for the module depends on what
type of processor you have, and what RSLogix software you are running.

If you have ... ... use this ProSoft ladder File Instructions
import. ext.
CompactLogix processor Add-On Instruction rung .L5X MVI69-MNET Add-On
with RSLogix 5000 MVI69MNET_AddOn_Rung_<Ve Instruction Rung Import
Version 16 or higher rsion #>.L5X Procedure (page 20)
CompactLogix processor Sample Ladder program. Use the .ACD Adding the Module to an
with RSLogix 5000 version number that matches the Existing CompactLogix
Version 15 or earlier version number of your RSLogix Project (page 73)
5000 software.
MicroLogix processor Sample Ladder program for .RSS Adding the Module to an
(uses RSLogix 500) MicroLogix Existing MicroLogix
Project (page 77)

All of these ladder files can be downloaded from www.prosoft-technology.com or

copied from the ProSoft Solutions CD-ROM.

ProSoft Technology, Inc. Page 19 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.1 MVI69-MNET Add-On Instruction Rung Import Procedure

Note: This section only applies if you are using a CompactLogix processor running RSLogix 5000
version 16 or higher. If you are configuring the MVI69-MNET module with an earlier version of
RSLogix 5000, please refer to Adding the Module to an Existing CompactLogix Project (page 73). If
you are using a MicroLogix processor, please see Adding the Module to an Existing MicroLogix
Project (page 77).

The following file is required before you start this procedure. Copy the file from
the ProSoft Solutions CD-ROM, or download it from
www.prosoft-technology.com.

File Name Description

MVI69MNET_AddOn_Rung_<Version L5X file contains the Add-On instruction, the user
#>.L5X defined data types, data objects and ladder logic
required to set up the MVI69-MNET module.

Page 20 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.1.1 Creating a New RSLogix 5000 Project

1 Open the FILE menu, and then choose NEW.

2 Select REVISION 16.

ProSoft Technology, Inc. Page 21 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.1.2 Creating the Module

1 Right-click I/O CONFIGURATION and choose NEW MODULE.

2 Select 1769-MODULE.

3 Set the Module Properties values as follows:

Parameter Value
Name Enter a module identification string. Example: MNET
Description Enter a description for the module. Example: MODBUS
TCP/IP COMMUNICATION MODULE
Comm Format Select DATA-INT
Slot Enter the slot number in the rack where the MV69-MNET
module will be installed.
Input Assembly Instance 101
Input Size 62 / 122 / 242
Output Assembly Instance 100
Output Size 61 / 121 / 241
Configuration Assembly Instance 102
Configuration Size 0

Page 22 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

4 The following illustration shows an example where the module was

configured for a block transfer size of 60 words (input block size = 62 words,
output block size = 61 words):

The following options are available for the user:

Block Transfer Size Input Block Size Output Block Size

60 62 61
120 122 121
240 242 241

5 On the CONNECTION tab, check or un-check the Major fault option as

applicable.

ProSoft Technology, Inc. Page 23 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

The MVI69-MNET module is now visible in the I/O Configuration pane.

2.1.3 Importing the Ladder Rung

1 In the Controller Organization window, expand the TASKS folder and
subfolder until you reach the MAINPROGRAM folder.
2 In the MAINPROGRAM folder, double-click to open the MAINROUTINE ladder.
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 IMPORT RUNG.

Page 24 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

4 Navigate to the location on your PC where you saved (page 20) the Add-On
Instruction (for example, My Documents or Desktop). Select the
MVI69MNET_ADDON_RUNG_<VERSION #>.L5X file.

This action opens the Import Configuration dialog box, showing the controller
tags that will be created.

ProSoft Technology, Inc. Page 25 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5 Verify that the slot number is correct for the module.

6 Click OK to confirm the import. RSLogix will indicate that the import is in
progress:

Page 26 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

When the import is completed, the new Add-On Instruction rung will appear in
the ladder.

The procedure has also imported new user-defined data types, controller tags
and the Add-On instruction for your project.

ProSoft Technology, Inc. Page 27 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

7 The imported rung will contain the Add-On instruction with two CPS
instructions as shown below. The CPS instructions are set by default for a
length of 62/61 words as follows:

Edit the above CPS instructions Length field values according to the following
table.

"Block Transfer Size Parameter" – Ladder Routine window:

60/120/240 options)
Connection Parameters: CPS instructions Length field values:
Input Size: Output Size:

62 61 62 61
122 121 122 121
242 241 242 241

Page 28 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.1.4 Setting the Read and Write Data Array Sizes

1 The imported rung contains the MNET.DATA controller tag arrays ReadData
and WriteData, which are set to the factory default sizes of 600 elements.
These tags will contain:
o Read Data - data copied from the module to the processor
o Write Data - data copied from the processor to the module
2 If you have changed the Read Register Count and Write Register Count
values in the Module section of the module’s configuration, you must adjust
the ReadData and WriteData array sizes to match those values. Enter the
new values in the MNETDATA user-defined data type in the User-Defined
folder.

ProSoft Technology, Inc. Page 29 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Example: If the Read Register Count parameter in the configuration is set to

1440, then set the ReadData tag array size to INT[1440].

Example: If the Write Register Count parameter in the configuration is set to

1880, then set the WriteData tag array size to INT[1880].

You will be prompted to confirm the changes. Click YES to continue.

Page 30 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.1.5 Setting the Block Transfer Size

The MNET.CONFIG.BlockTransferSize controller tag is set to 60 in the Add-On
Instruction. If you have configured a different block transfer size in the module’s
configuration file, you must change this value to match.

Edit the tag values according to the following table.

Module Properties dialog box: Controller Organizer's Controller Tags folder:
Connection Parameters: MNET.CONFIG.BlockTransferSize tag value:
Input Size: Output Size:
62 61 60
122 121 120
242 241 240

ProSoft Technology, Inc. Page 31 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.1.6 Setting the Connection Input and Output Sizes

The following user-defined data types must also be configured to match the block
transfer size value used for your project:
 MNETConnectionInput – Data type used for the Connection Input pin in the
Add-On instruction.
 MNETConnectionOutput – Data type used for the Connection Output pin in
the Add-On instruction.

1 Access the user-defined data type definition MNETConnectionInput as shown

below.

2 Edit the tag values according to the following table.

Module Properties dialog box: Controller Organizer’s Controller Tags folder:

Connection Parameters: Input Size: MNETConnectionInput.Data tag value:
62 62
122 122
242 242

Page 32 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

3 Access the user-defined data type definition MNETConnectionOutput as

shown below.

4 Edit the tag values according to the following table.

Module Properties dialog box: Controller Organizer’s Controller Tags folder:

Connection Parameters: Output Size: MNETConnectionOutput.Data tag value:
61 61
121 121
241 241

ProSoft Technology, Inc. Page 33 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.1.7 Adding Multiple Modules (Optional)

Important: If your application requires more than one MVI69-MNET module in the same project,
follow the steps below and make certain that both modules are assigned identical Block Transfer
Sizes.

1 In the I/O CONFIGURATION folder, click the right mouse button to open a
shortcut menu, and then choose NEW MODULE.

2 Select 1769-MODULE.

Page 34 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

3 Fill the module properties as follows:

Parameter Value
Name Enter a module identification string. Example: MVI69MNET_2
Description Enter a description for the module. Example: PROSOFT
COMMUNICATION MODULE FOR MODBUS COMMUNICATIONS

Comm Format Select DATA-INT

Slot Enter the slot number in the rack where the MVI69-MNET
module will be installed.
Input Assembly Instance 101
Input Size 62 / 122 / 242
Output Assembly Instance 100
Output Size 61 / 121 / 241
Configuration Assembly Instance 102
Configuration Size 0

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

5 In the Controller Organization window, expand the TASKS folder and

subfolder until you reach the MAINPROGRAM folder.
6 In the MAINPROGRAM folder, double-click to open the MAINROUTINE ladder.

ProSoft Technology, Inc. Page 35 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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

8 Navigate to the location on your PC where you saved (page 20) the Add-On
Instruction (for example, My Documents or Desktop). Select the
MVI69MNET_ADDON_RUNG_<VERSION #>.L5X file.

Page 36 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

This action opens the Import Configuration dialog box, showing the controller
tags that will be created.

ProSoft Technology, Inc. Page 37 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

9 Associate the I/O connection variables to the correct module. The default
values are Local:1:I and Local:1:O. These require re-assignment to the new
module's location.

Page 38 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

10 Change the default tags MNET and AOI69MNET to avoid conflict with
existing tags. In this step, you should append a string to the default tag
names, such as "_2", as shown in the following illustration.

11 Click OK to continue.

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

ProSoft Technology, Inc. Page 39 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.2 Connecting Your PC to the Processor

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.

Page 40 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.3 Downloading the Sample Program to the Processor

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

1 If you are not already online to the processor, open the COMMUNICATIONS
menu, and then choose DOWNLOAD. RSLogix will establish communication
with the processor.
2 When communication is established, RSLogix will open a confirmation dialog
box. Click the DOWNLOAD button to transfer the sample program to the
processor.

3 RSLogix will compile the program and transfer it to the processor. This
process may take a few minutes.
4 When the download is complete, RSLogix will open another confirmation
dialog box. 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.

ProSoft Technology, Inc. Page 41 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.3.1 Configuring the RSLinx Driver for the PC COM Port

If RSLogix is unable to establish communication with the processor, follow these
steps.
1 Open RSLinx.
2 Open the COMMUNICATIONS menu, and choose CONFIGURE DRIVERS.

This action opens the Configure Drivers dialog box.

Note: If the list of configured drivers is blank, you must first choose and configure a driver from the
Available Driver Types list. The recommended driver type to choose for serial communication with
the processor is RS-232 DF1 Devices.

Page 42 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

3 Click to select the driver, and then click CONFIGURE. This action opens the
Configure RS-232 DF1 Devices dialog box.

4 Click the AUTO-CONFIGURE button. RSLinx will attempt to configure your

serial port to work with the selected driver.
5 When you see the message Auto Configuration Successful, click the OK
button to dismiss the dialog box.

Note: If the auto-configuration procedure fails, verify that the cables are connected correctly
between the processor and the serial port on your computer, and then try again. If you are still
unable to auto-configure the port, refer to your RSLinx documentation for further troubleshooting
steps.

ProSoft Technology, Inc. Page 43 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.4 Connecting Your PC to the Module

With the module securely mounted, connect your PC to the CFG
(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 CFG port of the module.
3 Attach the other end to the serial port on your PC.

Page 44 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.5 Using ProSoft Configuration Builder

ProSoft Configuration Builder (PCB) provides a convenient 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.5.1 Setting Up the Project

To begin, start ProSoft Configuration Builder. If you have used other Windows
configuration tools before, you will find the screen layout familiar. ProSoft
Configuration Builder’s window consists of a tree view on the left, an information
pane and a configuration pane on the right side of the window. When you first
start ProSoft Configuration Builder, 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 ProSoft Configuration Builder window
with a new 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.

ProSoft Technology, Inc. Page 45 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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

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

Page 46 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.5.2 Setting Module Parameters

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

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

Renaming an Object
1 Select the object, and then click the right mouse button to open a shortcut
menu. From the shortcut menu, choose RENAME.
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 the [+] sign next to the module icon to expand module information.
2 Click 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.

ProSoft Technology, Inc. Page 47 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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 VIEW CONFIGURATION. This action opens the
View Configuration window.
3 In the View Configuration window, open the FILE menu, and choose PRINT.
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.

Page 48 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.6 Module Configuration

2.6.1 Module
This section of the configuration describes the database setup and module-level
parameters.

Backplane Error/Status Pointer

1 to 4955
This parameter sets the address in the internal database where the backplane
error/status data will be placed. If you want the error/status data to be moved to
the processor and placed into the ReadData array, the value entered should be a
module memory address in the Read Data area. If the value is set to -1, the
error/status data will not be stored in the module's internal database and will not
be transferred to the processor's ReadData array.
Enabling the Error/Status Pointer is optional. The error/status data is routinely
returned as part of the input image, which is continually being transferred from
the module to the processor. For more information, see Normal Data Transfer
Blocks (page 105).

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.

ProSoft Technology, Inc. Page 49 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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.

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.

Failure Flag Count

0 through 65535
This parameter specifies the number of successive transfer errors that must
occur before halting communication on the application port(s). If the parameter is
set to 0, the application port(s) will continue to operate under all conditions. If the
value is set larger than 0 (1 to 65535), communications will cease if the specified
number of failures occur.

Block Transfer Size

60, 120 or 240
This read-only parameter specifies the number of words of user data transferred
in each block between the module and processor.

Page 50 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

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.

Pass-Through Mode
0, 1, 2 or 3
This parameter specifies the pass-through mode for write messages received by
the MNET and MBAP server ports.
 If the parameter is set to 0, all write messages will be placed in the module’s
virtual database.
 If a value of 1 is entered, write messages received will be sent to the
processor as unformatted messages.
 If a value of 2 is entered, write messages received will be sent to the
processor with the bytes swapped in formatted messages.
 If a value of 3 is entered, write messages received will be sent to the
processor as formatted messages with no byte swapping.

Note: If pass-through mode is used, the module's Write Data area must begin at 0 (Write Register
Start = 0).

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.

ProSoft Technology, Inc. Page 51 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.6.2 MNET Client x

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

Client Error/Status Pointer

1 to 4990
This parameter sets the address in the internal database where the Client
error/status data will be placed. If you want the error/status data to be moved to
the processor and placed into the ReadData array, the value entered should be a
module memory address in the Read Data area. If the value is set to -1, the
error/status data will not be stored in the module's internal database and will not
be transferred to the processor's ReadData array.
Enabling the Error/Status Pointer is optional. The error/status data is routinely
returned as part of the input image, which is continually being transferred from
the module to the processor. For more information, see Normal Data Transfer
Blocks (page 105).

Command Error Pointer

-1 to 4999
This parameter sets the address in the internal database where the Command
Error List data will be placed. If you want the Command Error List data to be
moved to the processor and placed into the ReadData array, 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 on the type of communication network used, and the expected
response time of the slowest device on the network.

Page 52 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module 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 Client driver will issue Function Code 3, 6, and 16
commands (read and write Holding Registers) to a remote server when it is
moving 32-bit floating-point data.
If the remote server expects to receive or will send one complete 32-bit floating-
point value for each count of one (1), then set this parameter to YES. When set to
YES, the Client driver will send values from two consecutive 16-bit internal
memory registers (32 total bits) for each count in a write command, or receive 32
bits per count from the server for read commands. Example: Count = 10, Client
driver will send 20 16-bit registers for 10 total 32-bit floating-point values.
If, however, the remote server expects to use a count of two (2) for each 32-bit
floating-point value it sends or receives, or if you do not plan to use floating-point
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
Whenever the Float Flag parameter is set to YES, this parameter determines the
lowest Modbus Address, used in commands to a remote server, to consider as
commands to read or write floating-point data. All commands with address values
greater than or equal to this value will be considered floating-point data
commands. All commands with address values less than this value will be
considered normal 16-bit register data commands.
This parameter is used only if the Float Flag is set to YES. For example, if a value
of 7000 is entered, all commands sent with addresses of 47001 (or 407001) and
above will be considered as floating-point data commands and 32 bits of data will
be sent or received for each count of one in the command.
You will also need to set the Float Offset parameter to an appropriate value
whenever the Float Flag parameter is set to YES.

ProSoft Technology, Inc. Page 53 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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.

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.

Page 54 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.6.3 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 MVI69-MNET 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 MVI69-MNET 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 100 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 issuances 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.
Write commands have a special feature, as they can be set to execute only if the
data in the write command changes. If the register data values in the command
have not changed since the command was last issued, the command will not be
executed.
If the data in the command has changed since the command was last issued, the
command will be executed. Use of this feature can lighten the load on the
network. To implement this feature, set the enable code for the command to
CONDITIONAL (2).

ProSoft Technology, Inc. Page 55 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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 Supported in Client Supported in Server

1 Read Coil Status X X
2 Read Input Status X X
3 Read Holding Registers X X
4 Read Input Registers X X
5 Set Single Coil X X
6 Single Register Write X X
7 Read Exception Status X
8 Diagnostics X
15 Multiple Coil Write X X
16 Multiple Register Write X X
22 Mask Write 4X X
23 Read/Write X

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 Internal Poll Interval Count Swap IP Address Serv Slave Function Code Device Modbus
Code Address Time Code Port Node Address
Code Register 1/10th Seconds Bit 0 IP Address Port # Address Read Coil (0x) Register
(bit) Count
Code Register 1/10th Seconds Bit 0 IP Address Port # Address Read Input (1x) Register
(bit) Count
Code Register 1/10th Seconds Word Code IP Address Port # Address Read Holding Register
Count Registers (4x)
Code Register 1/10th Seconds Word 0 IP Address Port # Address Read Input Registers Register
Count (3x)
Code 1 bit 1/10th Seconds Bit 0 IP Address Port # Address Force (Write) Single Register
Count Coil (0x)
Code 1 bit 1/10th Seconds Word 0 IP Address Port # Address Preset (Write) Single Register
Count Register (4x)
Code Register 1/10th Seconds Bit 0 IP Address Port # Address Force (Write) Register
(bit) Count Multiple Coil (0x)
Code Register 1/10th Seconds Word 0 IP Address Port # Address Preset (Write) Register
Count Multiple Register (4x)

Page 56 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

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

Command list example:

Enable
NO (0), YES (1), or CONDITIONAL (2)
This field defines whether the command is to be executed and under what
conditions.

Value Description
NO (0) The command is disabled and will not be executed in the normal polling
sequence.
YES (1) 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 to a nonzero value, the
command will be executed when the interval timer expires.
CONDITIONAL (2) The command will execute only if the internal data associated with the
command changes. This value is valid only for write commands.

ProSoft Technology, Inc. Page 57 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Internal Address
0 to 65535 (for bit-level addressing)
or
0 to 4999 (for word-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-
level or register-level address.

Poll Interval
0 to 65535
This parameter specifies the minimum interval between issuances of a command
during continuous command execution (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.

Page 58 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

Swap Code
NONE
SWAP WORDS
SWAP WORDS & BYTES
SWAP 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

NONE No change is made in the byte ordering (1234 = 1234)
SWAP WORDS The words are swapped (1234=3412)
SWAP WORDS & BYTES The words are swapped, then the bytes in each word are swapped
(1234=4321)
SWAP BYTES 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.

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

Service Port
502 or other port numbers supported on a 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.

ProSoft Technology, Inc. Page 59 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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 59) 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 60 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module 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 register-
level 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 61 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.6.4 MNET Servers

This section contains database offset information used by the server when
accessed by external Clients. These offsets can be utilized to segment the
database by data type.

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 floating-
point 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 floating-
point value it expects to receive or send, or, if you do not plan to use floating-
point 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.

Page 62 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

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.

Output Offset
0 to 4999
This parameter defines the start register for the Modbus command data in the
internal database. This parameter is enabled when a value greater than 0 is set.
For example, if the Output Offset value is set to 3000, data requests for Modbus
Coil Register address 00001 will use the internal database register 3000, bit 0. If
the Output Offset value is set to 3000, data requests for Modbus Coil register
address 00016 will use the internal database register 3000, bit 15. Function
codes affected are 1, 5, and 15.

Bit Input Offset

0 to 4999
This parameter defines the start register for Modbus command data in the
internal database. This parameter is enabled when a value greater than 0 is set.
For example, if the Bit Input Offset value is set to 3000, data requests for Modbus
Input Register address 10001 will use the internal database register 3000, bit 0. If
the Bit Input Offset is set to 3000, data requests for Modbus Coil register address
10016 will use the internal database register 3000, bit 15. Function code 2 is
affected.

ProSoft Technology, Inc. Page 63 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Holding Register Offset

0 to 4999
This parameter defines the start register for the Modbus Command data in the
internal database. This parameter is enabled when a value greater than 0 is set.
For example, if the Holding Register Offset value is set to 4000, data requests for
Modbus Word register 40001 will use the internal database register 4000.
Function codes affected are 3, 6, 16, & 23.

Word Input Offset

0 to 4999
This parameter defines the start register for Modbus Command data in the
internal database. This parameter is enabled when a value greater than 0 is set.
For example, if the Word Input Offset value is set to 4000, data requests for
Modbus Word register address 30001 will use the internal database register
4000. Function code 4 is affected.

Connection Timeout
0 to 1200 seconds
This is the number of seconds the server will wait to receive new data. If the
server does not receive any new data during this time, it will close the
connection.

Page 64 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

2.6.5 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 MVI69-
MNET 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.

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

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.

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

ProSoft Technology, Inc. Page 65 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

2.6.6 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:
o IP address (fixed IP required) _____ . _____ . _____ . _____
o Subnet mask _____ . _____ . _____ . _____
o 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 ETHERNET CONFIGURATION icon. This action opens the Edit
dialog box.

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.

Page 66 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Configuring the MVI69-MNET Module
Modbus TCP/IP Communication Module User Manual

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

To download the project file

1 In the tree view in ProSoft Configuration Builder, click once to select the
module.
2 Right-click the module icon to open a shortcut menu. From the shortcut
menu, choose DOWNLOAD FROM PC TO DEVICE. The program 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.

3 Choose the COM port to use from the dropdown list, and then click the
DOWNLOAD 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.

ProSoft Technology, Inc. Page 67 of 159

October 17, 2011
Configuring the MVI69-MNET Module MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Page 68 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Ladder Logic
Modbus TCP/IP Communication Module User Manual

3 Ladder Logic

In This Chapter
 Controller Tags ...................................................................................... 69
 User-Defined Data Types (UDTs) ......................................................... 71
 Using Controller Tags ............................................................................ 73
 Adding the Module to an Existing CompactLogix Project ...................... 73
 Adding the Module to an Existing MicroLogix Project ............................ 77

Ladder logic is required for the MVI69-MNET module to work. 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 inRAx 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.

3.1 Controller Tags

Data related to the MVI69-MNET is stored in the ladder logic in variables called
controller tags. Individual controller tags can be grouped into collections of
controller tags called controller tag structures. A controller tag structure can
contain any combination of:
 Individual controller tags
 Controller tag arrays
 Lower-level controller tag structures
The controller tags for the module are pre-programmed into the Add-On
Instruction Import Rung ladder logic. You can find them in the Controller Tags
subfolder, located in the Controller folder in the Controller Organizer pane of the
main RSLogix 5000 window.
This controller tag structure is arranged as a tree structure. Individual controller
tags are found at the lowest level of the tree structure. Each individual controller
tag is defined to hold data of a specific type, such as integer or floating-point
data. Controller tag structures are declared with user-defined data types, which
are collections of data types.

ProSoft Technology, Inc. Page 69 of 159

October 17, 2011
Ladder Logic MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

3.1.1 MVI69-MNET Controller Tags

The main controller tag structure, MNET, is broken down into five lower-level
controller tag structures.

The five lower-level controller tag structures contain other controller tags and
controller tag structures. Click the [+] sign next to any controller tag to expand it
and view the next level in the structure.
For example, if you expand the MNET.DATA controller tag structure, you will see
that it contains two controller tag arrays, MNET.DATA.ReadData and
MNET.DATA.WriteData, which are 600-element integer arrays by default.

Notice that the Data Type column displays the data types used to declare each
controller tag, controller tag array or controller tag structure. Individual controller
tags are declared with basic data types, such as INT and BOOL. Controller tag
arrays are declared with arrays of basic data types. Controller tag structures are
declared with user-defined data types (UDTs).

Page 70 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Ladder Logic
Modbus TCP/IP Communication Module User Manual

3.2 User-Defined Data Types (UDTs)

User-defined data types (UDTs) allow users to organize collections of data types
into groupings. These groupings, or data type structures, can then be used to
declare the data types for controller tag structures. Another advantage of defining
a UDT is that it may be re-used in other controller tag structures that use the
same data types.
The Add-On Instruction Import Rung ladder logic for the module has pre-defined
UDTs. You can find them in the User-Defined subfolder, located in the Data
Types folder in the Controller Organizer pane of the main RSLogix window. Like
the controller tags, the UDTs are organized in a multiple-level tree structure.

3.2.1 MVI69-MNET User-Defined Data Types

Fourteen different UDTs are defined for the MVI56(E)-MNET Add-On Instruction.
The main UDT, MNETModuleDef, contains all the data types for the module and
was used to create the main controller tag structure, MNET. There are five UDTs
one level below MNETModuleDef. These lower-level UDTs were used to create
the MNET.CONFIG, MNET.DATA, MNET.STATUS, MNET.CONTROL, and
MNET.UTIL controller tag structures.

Click the [+] signs to expand the UDT groupings and view lower-level UDTs.

ProSoft Technology, Inc. Page 71 of 159

October 17, 2011
Ladder Logic MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

For example, if you expand MNETDATA, you will see that it contains two UDTs,
ReadData and WriteData. Both of these are 600-element integer arrays by
default.

Notice that these UDTs are the data types declared for the
MNET.DATA.ReadData and MNET.DATA.WriteData controller tag arrays.

Page 72 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Ladder Logic
Modbus TCP/IP Communication Module User Manual

3.3 Using Controller Tags

You can use controller tags to:
 View read and write data that is being transferred between the module and
the processor.
 View status data for the module.
 Set up and trigger special functions.
 Initiate module restarts (Warm Boot or Cold Boot).

3.4 Adding the Module to an Existing CompactLogix Project

Important: The MVI69-MNET module has a power supply distance rating of 2 (L43 and L45
installations on first 2 slots of 1769 bus, to the right of the processor).

If you are installing and configuring the module with a CompactLogix controller,
and you decide to use the standard sample ladder logic rather than importing the
Add-On Instruction (AOI) Rung, then follow these steps. If you are using a
MicroLogix controller, refer to the next section (page 77).
1 Add the MVI69-MNET module to the project. Right-click the mouse button on
the I/O CONFIGURATION option in the Controller Organization window to
display a pop-up menu. Select the NEW MODULE option from the I/O
CONFIGURATION menu.

ProSoft Technology, Inc. Page 73 of 159

October 17, 2011
Ladder Logic MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

This action opens the Select Module dialog box:

2 Select the 1769-Module (Generic 1769 Module) from the list and click OK.

3 Enter the Name, Description and Slot options for your application, using the
values in the illustration above. You must select the Comm Format as DATA -
INT in the dialog box, otherwise the module will not communicate over the
backplane of the CompactLogix rack.

Page 74 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Ladder Logic
Modbus TCP/IP Communication Module User Manual

4 Configure the Connection Parameters to match to the Block Transfer Size

parameter in the configuration file. Use the values in the table corresponding
with the block transfer size you configured.
Block Transfer Size = 60
Field Recommended Value
Type 1769-MODULE Generic 1769 Module
Parent Local
Name MVI69
Description MVI69 Application Module
Comm Format Data - INT
Slot The slot number in the rack where the module is installed
Input Assembly Instance 101
Input Size 62
Output Assembly Instance 100
Output Size 61
Configuration Assembly Instance 102
Configuration Size 0

Block Transfer Size = 120

Field Recommended Value
Type 1769-MODULE Generic 1769 Module
Parent Local
Name MVI69
Description MVI69 Application Module
Comm Format Data - INT
Slot The slot number in the rack where the module is installed
Input Assembly Instance 101
Input Size 122
Output Assembly Instance 100
Output Size 121
Configuration Assembly Instance 102
Configuration Size 0

Block Transfer Size = 240

Field Recommended Value
Type 1769-MODULE Generic 1769 Module
Parent Local
Name MVI69
Description MVI69 Application Module
Comm Format Data - INT
Slot The slot number in the rack where the module is installed
Input Assembly Instance 101
Input Size 242
Output Assembly Instance 100
Output Size 241
Configuration Assembly Instance 102
Configuration Size 0

ProSoft Technology, Inc. Page 75 of 159

October 17, 2011
Ladder Logic MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5 Click NEXT to continue.

6 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. It should not be set to less than 1 millisecond.
Values between 5 and 10 milliseconds should work with most applications.
7 SAVE the module. Click OK to dismiss the dialog box. The Controller
Organization window now displays the module's presence. The following
illustration shows the Controller Organization window:

8 Copy the User-defined Data Types (UDTs) from the sample program.
9 Copy the Controller Tags from the sample program.
10 Copy the Ladder Rungs from the sample program.
11 Save and download the new application to the controller.

Page 76 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Ladder Logic
Modbus TCP/IP Communication Module User Manual

3.5 Adding the Module to an Existing MicroLogix Project

If you are installing and configuring the module with a MicroLogix controller,
follow these steps. If you are using a CompactLogix controller, refer to the
previous section.
The first step in setting up the processor ladder file is to define the I/O type
module to the system. Start RSLogix 500, and follow these steps:
1 In RSLogix, open your existing application, or start a new application,
depending on your requirements.
2 Double-click the I/O CONFIGURATION icon located in the Controller folder in the
project tree. This action opens the I/O Configuration dialog box.

3 In the I/O Configuration dialog box, select "OTHER - REQUIRES I/O CARD TYPE
ID" at the bottom of the list in the right pane, and then double-click to open
the "Other" type IO card dialog box.
4 Enter the values shown in the following illustration to define the module
correctly for the MicroLogix processor, and then click OK to save your
configuration.

ProSoft Technology, Inc. Page 77 of 159

October 17, 2011
Ladder Logic MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

The Input Words and Output Words parameters will depend on the Block
Transfer Size parameter you specify in the configuration file. Use the values
from the following table.

Block Transfer Size Input Words Output Words

60 62 61
120 122 121
240 242 241

5 Click OK to continue.
6 After completing the module setup, the I/O Configuration dialog box will
display the module's presence.
The last step is to add the ladder logic. If you are using the example ladder logic,
adjust the ladder to fit your application.
Download the new application to the controller. If you encounter errors when you
attempt to run the program, refer to Diagnostics and Troubleshooting (page 79)
for information on how to connect to the module's Config/Debug port to use its
troubleshooting features.

Page 78 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

4 Diagnostics and Troubleshooting

In This Chapter
 LED Status Indicators ............................................................................ 80
 Using ProSoft Configuration Builder (PCB) for Diagnostics................... 82
 Reading Status Data from the Module .................................................. 92

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.

ProSoft Technology, Inc. Page 79 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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
terminal using the Configuration/Debug port.
Off No data is being transferred on the Configuration/Debug port.
P1 Green On Port not used
Off Port not used
P2 Green On Port not used
Off Port not used
APP Amber Off The MVI69-MNET is working normally.
On The MVI69-MNET module program has recognized a
communication error on one of its Modbus ports.
BP ACT Amber On The LED is on when the module is performing a write
operation on the backplane.
Off The LED is off when the module is performing a read
operation on the backplane. Under normal operation, the LED
should blink rapidly on and off.
OK Red/ Off The card is not receiving any power and is not securely
Green plugged into the rack.
Green The module is operating normally.
Red The program has detected an error or is being configured. If
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.
BAT Red Off The battery voltage is OK and functioning.
On The battery voltage is low or battery is not present. Allow
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.
If the APP, BP ACT and OK LEDs blink at a rate of every one-second, this
indicates a serious problem with the module. Call ProSoft Technology support to
arrange for repairs.

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.

Page 80 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

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
CompactLogix or MicroLogix 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.
Verify that the slot in the rack configuration has been set up correctly in the
ladder logic.
Processor I/O LED This indicates a problem with backplane communications. Verify that all
flashes modules in the rack are configured in the ladder logic.
The module has a power supply distance rating of 2 on CompactLogix,
meaning that there must not be more than one other module between the
MVI69-MNET module and the power supply. If the module is used in a
MicroLogix system, verify that the backplane can supply the 800 mA required
by the module.

Module Errors
Problem Description Steps to take
BP ACT LED remains This indicates that backplane transfer operations are failing. Connect to the
OFF or blinks slowly module’s Configuration/Debug port to check this.
To establish backplane communications, verify the following items:
 The processor is in RUN mode
 The backplane driver is loaded in the module
 The module is configured for read and write block data transfer
 The ladder logic handles all read and write block situations
 The module is configured in the processor
OK LED remains RED The program has halted or a critical error has occurred. Connect to the
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 the card in the rack, and then restore power to the rack.

ProSoft Technology, Inc. Page 81 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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 sub-menus
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] — you do not need to press [ENTER]. When you type a
[COMMAND LETTER], a new screen will be displayed in your terminal application.

4.2.1 Using the Diagnostic Window in ProSoft Configuration Builder

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

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.

Page 82 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

2 On the shortcut menu, choose DIAGNOSTICS.

This action opens the Diagnostics dialog box.

3 Press [?] to open the Main menu.

If there is no response from the module, follow these steps:

ProSoft Technology, Inc. Page 83 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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.

Page 84 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

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.

ProSoft Technology, Inc. Page 85 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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 communication failures.
Use these commands only if you fully understand their potential effects, or if you are specifically
directed to do so by ProSoft Technology Technical Support Engineers.
There may be some special command keys that are not listed on the menu but that may activate
additional diagnostic or debugging features. If you need these functions, you will be advised how to
use them by Technical Support. 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.

Page 86 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

Viewing Module Configuration

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

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

Opening the Command Error List Menu

Press [E] 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.

Opening the Command List Menu

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

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 server(s) 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.

ProSoft Technology, Inc. Page 87 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

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

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.

Viewing Network Status

Press [1] to view statistics for the network server ports. The Network Server
Ports Status screen shows the number of requests, responses, and errors for
each network server.

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.

Viewing Client Configuration

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

Viewing Server Configuration

Press [6] to display the configuration information for the server.

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.

Page 88 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

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

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.

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 (page 132) for
information on the structure of Modbus messages. Each option available on the
menu is discussed in the following topics.

ProSoft Technology, Inc. Page 89 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Viewing Register Pages

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

Command Description
[0] Display registers 0 to 99
[1] Display registers 1000 to 1099
[2] 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.

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.

Page 90 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

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 Network Menu

From the Main menu press [@] to display the Network menu. 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.
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.

ProSoft Technology, Inc. Page 91 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

4.3 Reading Status Data from the Module

Module status information is useful for troubleshooting and can be accessed in
several different ways.

In the ladder logic's MNET.STATUS controller tag structure.

The MVI69-MNET module returns status data in the input image that can be
used to determine the module’s operating status. This data is transferred from
the module to the processor continuously as part of the normal data transfer
block sequence (page 105). You can view this data in the MNET.STATUS
controller tag structure in the ladder logic. For more information, see the Status
Data Definition (page 93).

In ProSoft Configuration Builder's Diagnostics screens.

For more information, see the section on PCB Diagnostics (page 82).

In database locations specified by Error/Status Pointers (optional).

If optional Error/Status Pointers are enabled, the status data can also be found in
the Read Data area of the module’s database at locations specified by the
pointer configuration parameters. For more information, see Backplane
Error/Status Pointer (page 49), Client Error/Status Pointer (page 52) and
Command Error Pointer (page 52).

Via the Configuration/Debug port.

Use a terminal program such as HyperTerminal. 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 4999)
 Version information
 Control over the module (warm boot, cold boot, transfer configuration)
 Facility to upload and download the module’s configuration file

Page 92 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

4.3.1 Status Data Definition

This section contains a description of the controller tags in the MNET.STATUS
controller tag structure, which contains module, server and Client status data.
This data is continuously transferred from the module to the processor as part of
the normal data transfer block sequence (page 105).

Controller Tag Data Type Description

Block Statistics
PassCnt INT This value is incremented each time a complete program
cycle occurs in the module.
Block.Read INT Total number of read blocks transferred from the module
to the processor
Block.Write INT Total number of write blocks transferred from the
processor to the module
Block.Parse INT Total number of blocks successfully parsed that were
received from the processor
Block.Event INT Total number of Event Command blocks received from the
processor
Block.Cmd INT Total number of Command Control blocks received from
the processor
Block.Err INT Total number of block errors recognized by the module.
MNET Server
MnetServer.CmdReq INT Not used
MnetServer.CmdResp INT Not used
MnetServer.CmdErr INT Not used
MnetServer.Requests INT This counter increments each time a MNet (port 2000)
request is received.
MnetServer.Responses INT This counter increments each time a MNet (port 2000)
response message is sent.
MnetServer.ErrSent INT This counter increments each time a MNet (port 2000)
sends an exception response to Client. Example: Client
sent illegal Modbus Data location address.
MnetServer.ErrRec INT This counter increments each time a MNet (port 2000)
receives a bad command. Example: Client sent illegal
function command.
MnetServer.CfgErrWord INT Configuration Error Word - Contains a bitmap that
indicates Client and server configuration errors
MnetServer.CurErr INT Not used
MnetServer.LastErr INT Not used
MBAP Server
MBAPServer.CmdReq INT Not used
MBAPServer.CmdResp INT Not used
MBAPServer.CmdErr INT Not used
MBAPServer.Requests INT This counter increments each time a MBAP (port 502)
request is received.

ProSoft Technology, Inc. Page 93 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Controller Tag Data Type Description

MBAPServer.Responses INT This counter increments each time a MBAP (port 502)
response message is sent.
MBAPServer.ErrSent INT This counter increments each time a MBAP (port 502)
sends an exception response to Client. Example: Client
sent illegal Modbus Data location address.
MBAPServer.ErrRec INT This counter increments each time a MBAP (port 502)
receives a bad command. Example: Client sent illegal
function command.
MBAPServer.CfgErrWord INT Configuration Error Word - Contains a bitmap that
indicates Client and server configuration errors
MBAPServer.CurErr INT Not used
MBAPServer.LastErr INT Not used
Client Status
ClientStatus.CmdReq INT This value is incremented each time a command request is
issued.
ClientStatus.CmdResp INT This value is incremented each time a command response
is received.
ClientStatus.CmdErr INT This value is incremented each time an error message is
received from a remote unit or a local error is generated
for a command.
ClientStatus.Requests INT Not used
ClientStatus.Responses INT Not used
ClientStatus.ErrSent INT Not used
ClientStatus.ErrRec INT Not used
ClientStatus.CfgErrWord INT Configuration Error Word - Contains a bitmap that
indicates Client and server configuration errors
ClientStatus.CurErr INT Most recent error code recorded for the Client
ClientStatus.LastErr INT Previous most recent error code recorded for the Client

Page 94 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

4.3.2 Configuration Error Word

The Configuration Error Word contains Client and server configuration error
indications, in a bit-mapped format. Specific bits in the module's Configuration
Error Word are turned on (set to 1) to indicate various configuration errors. The
Configuration Error Word appears in three separate MNET.STATUS controller
tags. Since there is only one Configuration Error Word for the whole module,
each of these tags contains exactly the same data, even though the tag name
might imply otherwise. Multiple copies of the same module error data have been
included in these different controller tag locations for your convenience when
troubleshooting.
Bits set to 1 in the Configuration Error Word indicate the following errors.

Bit Description Hex Value

0 Reserved - not currently used 0001h
1 Reserved - not currently used 0002h
2 Reserved - not currently used 0004h
3 Reserved - not currently used 0008h
4 Invalid retry count parameter (Client only) 0010h
5 The float flag parameter is not valid. (Client or server) 0020h
6 The float start parameter is not valid. (Client or server) 0040h
7 The float offset parameter is not valid. (Client or server) 0080h
8 The ARP Timeout is not in range (ARP Timeout parameter 0 or 0100h
greater than 60000 milliseconds) and will default to 5000
milliseconds. (Client only)
9 The Command Error Delay is > 300 and will default to 300. 0200h
(Client only)
10 Reserved - not currently used 0400h
11 Reserved - not currently used 0800h
12 Reserved - not currently used 1000h
13 Reserved - not currently used 2000h
14 Reserved - not currently used 4000h
15 Reserved - not currently used 8000h

Combinations of errors will result in more than one bit being set in the error word.
Correct any invalid data in the configuration for proper module operation. A value
of zero (0) in this word indicates all bits are clear, which means that all module
configuration parameters contain valid values. However, this does not mean that
the configuration is valid for the user application. Make sure each parameter is
set correctly for the intended application.

ProSoft Technology, Inc. Page 95 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

4.3.3 Client Command Errors

There are several different ways to view Client Command Errors.
 In the MNET.STATUS.ClientStatus.CurErr and
MNET.STATUS.ClientStatus.LastErr controller tags
 On the Client status data screens in the ProSoft Configuration Builder
Diagnostics
 At a module database location specified by the configuration's MNET Client 0
Command Error Pointer, if the Command Error Pointer is enabled. This
means that the first register refers to command 1 and so on.

Word 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 commands in the Client Command List are polled and executed, an error
value is maintained in the module for each command. This error list can be
transferred to the processor.

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

Module Communication Error Codes

Code Description
-2 Timeout while transmitting message
-11 Timeout waiting for response after request (same as -36)
253 Incorrect slave/server address in response
254 Incorrect function code in response
255 Invalid CRC/LRC value in response

Page 96 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Diagnostics and Troubleshooting
Modbus TCP/IP Communication Module User Manual

MNET Client Specific Errors

Code Description
-33 Failed to connect to server specified in command
-36 MNET command response timeout (same as -11)
-37 TCP/IP connection ended before session finished

Command List Entry Errors

Code Description
-40 Too few parameters
-41 Invalid enable code
-42 Internal address > maximum address
-43 Invalid node address (<0 or >255)
-44 Count parameter set to 0
-45 Invalid function code
-46 Invalid swap code
-47 ARP could not resolve MAC from IP (bad IP address, not part of a
network, invalid parameter to ARP routine).
-48 Error during ARP operation: the response to the ARP request did
not arrive to the module after a user-adjustable ARP Timeout.

Note: When the Client gets error -47 or -48, it uses the adjustable ARP Timeout parameter in the
configuration file to set an amount of time to wait before trying again to connect to this non-existent
server. This feature allows the Client to continue sending commands and polling other existing
servers, while waiting for the non-existent server to appear on the network.

ProSoft Technology, Inc. Page 97 of 159

October 17, 2011
Diagnostics and Troubleshooting MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Page 98 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5 Reference

In This Chapter
 Product Specifications ........................................................................... 99
 Functional Overview ............................................................................ 102
 Cable Connections .............................................................................. 128
 Modbus Protocol Specification ............................................................ 132

5.1 Product Specifications

The MVI69 Modbus TCP/IP Client/Server Communication Module allows
Rockwell Automation CompactLogix or MicroLogix processors to interface easily
with other Modbus compatible devices.
Compatible devices include Modicon Programmable Automation Controllers
(PACs), as well as a wide variety of instruments and devices. A 5000-word
register space in the module exchanges data between the processor and the
Modbus TCP/IP network.

5.1.1 Modbus TCP/IP

 Single Slot - CompactLogix or MicroLogix backplane compatible
 10/100 MB Ethernet port
 Module I/O data memory mapping supports up to 5000 registers and is user
definable
 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 and module configuration

ProSoft Technology, Inc. Page 99 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.1.2 Functional Specifications

 10/100 MB Ethernet Application port
 Supports Enron version of Modbus protocol for floating point data
transactions
 PCB includes a powerful Modbus network analyzer
 Special functions (Event Commands, Command Control, 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 ten independent server connections for Service Port 502
 Supports ten independent server connections for Service Port 2000
 All data mapping begins at Modbus register 40001
 Error codes, network error counters, and port status data available in user
data memory

Server Specifications
The MVI69-MNET module accepts Modbus function code commands of 1, 2, 3,
4, 5, 6, 8, 15, 16, 22 and 23 from an attached Modbus Client unit. A port
configured as a Modbus server permits a remote Client to interact with all data
contained in the module. This data can be derived from other Modbus server
devices on the network, through a Client port, or from the CompactLogix or
MicroLogix processor.

Client Specifications
A port configured as a virtual Modbus Client device on the MVI69-MNET module
actively issues Modbus commands to other nodes on the Modbus network. One
hundred (100) commands are supported on each port. Additionally, the Client
ports have an optimized polling characteristic that polls servers with
communication problems less frequently. The CompactLogix or MicroLogix
processor can be programmed to control the activity on the port by actively
selecting commands from the command list to execute or issuing commands
directly from the ladder logic.

Page 100 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.1.3 Hardware Specifications

Specification Description
Dimensions Standard 1769 single-slot module
Current Load 800 mA max @ 5 Vdc
Power supply distance rating of 2 (L43 and L45
installations on first 2 slots of 1769 bus)
Operating Temp. 0°C to 60°C (32°F to 140°F)
Storage Temp. -40°C to 85°C (-40°F to 185°F)
Relative Humidity 5% to 95% (with no condensation)
LED Indicators Power and Module Status
Application Status
CFG Port Activity
Ethernet Port Activity
Error Status
CFG Port (CFG) RJ45 (DB-9M with supplied cable)
RS-232 only
No hardware handshaking
App Port (Ethernet modules) 10/100 Base-T Ethernet compatible interface
Electrical Isolation 1500 Vrms 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

ProSoft Technology, Inc. Page 101 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.2 Functional Overview

5.2.1 Module Power Up

On power up, the module begins performing the following logical functions:
1 Initialize hardware components
o Initialize CompactLogix or MicroLogix backplane driver
o Test and clear all RAM
o Initialize the serial communication ports
2 Initialize the TCP/IP Stack and Ethernet interface module
3 Read configuration for module from MNET.CFG file on Compact Flash Disk
4 Initialize module register space
5 Enable server driver
6 Enable Client driver
After the module has received the configuration, the module will begin
communicating with other nodes on the network, depending on the configuration.

5.2.2 Backplane Data Transfer

The MVI69-MNET module communicates directly over the processor's
backplane. Data is paged between the module and the 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 update times range
from 2 to 10 milliseconds.
This bi-directional transfer of data is accomplished by the module putting data in
the input image to send to the processor. Data in the input image is placed in the
processor's controller tags by ladder logic. The input image for the module may
be configured to 62, 122, or 242 words with the Block Transfer Size parameter.
Processor logic inserts data to the output image to be transferred to the module.
The module's firmware program extracts the data and places it in the module's
internal database. The output image for the module may be configured to 61,
121, or 241 words with the Block Transfer Size parameter.

Page 102 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

The following illustration shows the data transfer method used to move data
between the processor, the MVI69-MNET 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
processor to interface the input and output image data with data contained 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).

Module’s Internal Database Structure

5000 registers for user data 0

Register Data

4999

ProSoft Technology, Inc. Page 103 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Data contained in this database is transferred in blocks, or pages, using the input
and output images. Processor ladder logic and the MVI69-MNET module's
program work together to coordinate these block transfers. The block structure of
each block type depends on the data content and the data transfer function to be
performed by the block. The module uses the following block identification
numbers.

Block ID Range Descriptions

-1 or 0 Status block
1 to 84 Read or Write blocks
1000 to 1083 Initialize Output Data blocks
2000 Event Command block
5001 to 5006 Command Control blocks
9956 Formatted Pass-through block from function 6 or 16 with word data
9957 Formatted Pass-through block from function 6 or 16 with floating-point data
9958 Formatted Pass-through block from function 5
9959 Formatted Pass-through block from function 15
9961 Formatted Pass-through block from function 23
9970 Function 99 indication block
9996 Unformatted Pass-through block with raw Modbus message
9997 Reset Status Data block
9998 Warm-boot block
9999 Cold-boot block

These block identification codes can be broken down into two groups:
Normal data transfer blocks
 Read, Write and Status blocks (-1 to 84)
Special function blocks
 Initialize Output Data blocks (1000 to 1083)
 Event Command block (2000)
 Command Control blocks (5001 to 5006)
 Pass-through blocks (9956 to 9959, 9961, 9970 and 9996
 Warm-boot and Cold-boot blocks (9998 and 9999)

Page 104 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Normal Data Transfer Blocks

Normal data transfer includes the paging of user data between the processor's
data areas and the module’s internal database (registers 0 to 4999), as well as
the paging of status data. These data are transferred through Read (input
image), Write (output image) and Status blocks. The amount of data paged in
each block depends on the Block Transfer Size set by the user in the
MNET.CONFIG.BlockTransferSize controller tag (possible values are 60, 120, or
240).
During normal program operation, the module sequentially sends Read and
Status Data blocks and receives Write blocks. The Status block is first in the
sequence, followed by alternating Write and Read blocks.
As an example, assume that an application's Read Data area consists of 180
words and its Write Data area consists of 120 words, and that the user has set
the Block Transfer Size to 60. Since the Read and Write data is paged 60 words
at a time, the module will use 3 Read blocks and 2 Write blocks to transfer the
data. The Read, Write and Status blocks will be sequenced as follows.

This sequence will continue until interrupted by other special function blocks sent
by the processor, by a command request from a node on the Modbus network, or
by operator control through the module’s Configuration/Debug port.
The following topics describe the function and structure of each block.

ProSoft Technology, Inc. Page 105 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Read Block
These blocks of data transfer information from the module to the CompactLogix
processor. The structure of the input image used to transfer this data is shown
below:

Read Block from Module to Processor

Word Offset Description Length
0 Read Block ID 1
1 Write Block ID 1
2 to (n + 1) Read Data n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

The Read Block ID is an index value used to determine where the data from
module memory will be placed in the ReadData[x] controller tag array of the
processor. The number of data words per transfer depends on the configured
Block Transfer Size parameter in the configuration file (possible values are 60,
120, or 240).
The Write Block ID associated with the block requests data from the processor.
The following example shows a typical backplane communication application.
If the backplane parameters are configured as follows:
Read Register Start: 0
Read Register Count: 480
Write Register Start: 480
Write Register Count: 480
The backplane communication would be configured as follows:

Database address 0 to 479 will be continuously transferred from the module to

the processor. Database address 480 to 959 will continuously be transferred
from the processor to the module.
The Block Transfer Size parameter basically configures how the Read Data and
Write Data areas are broken down into data blocks (60, 120, or 240).

Page 106 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

If Block Transfer Size = 60:

If Block Transfer Size = 120:

ProSoft Technology, Inc. Page 107 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

If Block Transfer Size = 240:

Page 108 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Write Block
These blocks of data transfer information from the CompactLogix or MicroLogix
processor to the module. The structure of the output image used to transfer this
data is shown below.

Write Block from Processor to Module

Word Offset Description Length
0 Write Block ID 1
1 to n Write Data n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

The Write Block ID is an index value used to determine the location in the
module’s database where the data will be placed. The number of data words per
transfer depends on the configured Block Transfer Size parameter in the
configuration file (possible values are 60, 120, or 240).

ProSoft Technology, Inc. Page 109 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Status Block
The Status block is automatically copied from the module into the
MNET.STATUS controller tag structure when the Read Block ID is 0 or -1, and
contains module, server and Client status information. The third column in the
table below contains the controller tags corresponding to each word in the block,
if applicable. For a more complete description of the block contents, see the
Status Data Definition (page 93).

Status Block from Module to Processor

Word Offset Content MNET.STATUS Controller Tag
0 Read Block ID
1 Write Block ID
Block Statistics
2 Program Scan Count PassCnt
3 Read Block Count Block.Read
4 Write Block Count Block.Write
5 Parse Block Count Block.Parse
6 Event Command Block Count Block.Event
7 Command Control Block Count Block.Cmd
8 Error Block Count Block.Err
9 to 18 Reserved
MNET Server
19 Command Requests (not used) MnetServer.CmdReq
20 Command Responses (not used) MnetServer.CmdResp
21 Command Errors (not used) MnetServer.CmdErr
22 Requests to Server MnetServer.Requests
23 Responses from Server MnetServer.Responses
24 Errors to Server MnetServer.ErrSent
25 Errors from Server MnetServer.ErrRec
26 Configuration Error Word MnetServer.CfgErrWord
27 Current Error (not used) MnetServer.CurErr
28 Last Error Logged (not used) MnetServer.LastErr
MBAP Server
29 Command Requests (not used) MBAPServer.CmdReq
30 Command Responses (not used) MBAPServer.CmdResp
31 Command Errors (not used) MBAPServer.CmdErr
32 Requests to Server MBAPServer.Requests
33 Responses from Server MBAPServer.Responses
34 Errors to Server MBAPServer.ErrSent
35 Errors from Server MBAPServer.ErrRec
36 Configuration Error Word MBAPServer.CfgErrWord
37 Current Error (not used) MBAPServer.CurErr

Page 110 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Word Offset Content MNET.STATUS Controller Tag

38 Last Error Logged (not used) MBAPServer.LastErr
Client Status
39 Command Requests ClientStatus.CmdReq
40 Command Responses ClientStatus.CmdResp
41 Command Errors ClientStatus.CmdErr
42 Requests to Server (not used) ClientStatus.Requests
43 Responses from Server (not used) ClientStatus.Responses
44 Errors to Server (not used) ClientStatus.ErrSent
45 Errors from Server (not used) ClientStatus.ErrRec
46 Configuration Error Word ClientStatus.CfgErrWord
47 Current Error ClientStatus.CurErr
48 Last Error Logged ClientStatus.LastErr
49 to (n + 1) Spare
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

ProSoft Technology, Inc. Page 111 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Special Function Blocks

Special function blocks are optional blocks used to request special tasks from the
module.

Initialize Output Data Blocks (1000 to 1083)

Use the Initialize Output Data parameter in the configuration to bring the module
to a known state after a restart operation. If the Initialize Output Data parameter
is enabled, when the module performs a restart operation, it will request blocks of
output data from the ReadData array in the processor to initialize the Read Data
area of the module’s internal database.

Block Request from Module to Processor

Word Offset Description Length
0 Read Block IDs 1000 to 1083 for n = 60 1
1 Write Block IDs 1000 to 1083 for n = 60 1
2 to (n + 1) Spare n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

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 format of the
returned write block is shown in the following table.

Block Response from Processor to Module

Word Offset Description Length
0 Write Block IDs 1000 to 1083 1
1 to n Output Data n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

Page 112 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Event Command Block (2000)

Note: Event Commands are not needed for normal Modbus command list polling operations and
are needed only occasionally for special circumstances.

During routine operation, the module continuously cycles through the user-
defined MNET Client 0 Command List (page 55), examining commands in the
order they are listed and sending enabled commands on the network. However,
the module also has a special command priority queue, which is an internal
buffer that holds commands from special function blocks until they can be sent
on the network.
When one or more commands appear in the command priority queue:
1 The routine polling process is temporarily interrupted.
2 The commands in the command priority queue are executed until the queue
is empty.
3 Then the module goes back to where it left off on the MNET Client 0
Command List and continues routine polling.
Event Command blocks send Modbus TCP/IP commands directly from controller
tags by ladder logic to the Client command priority queue on the module. Event
Commands are not placed in the module's internal database and are not part of
the MNET Client 0 Command List.

ProSoft Technology, Inc. Page 113 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Block Request from Processor to Module

Word Offset Description Length
0 Write Block ID - This word contains block identification code 2000 to 1
indicate that the block contains a command to be executed by the Client
driver.
1 to 4 IP Address - These four words contain the IP address of the destination 4
server. Each octet value (0 to 255) of the destination server's 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 ensure the values are in the range of 0 to 255.
5 Service Port - This word contains the TCP service port used in the 1
message. 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 used. 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 (serial-type) message.
6 Node Address - This word contains the Modbus node address for the 1
message. This field should have a value from 1 to 247.
7 Internal DB Address - This word contains the internal Modbus address in 1
the module to use with the command. This word can contain a value
from 0 to 4999.
8 Point Count - This word contains the count parameter that determines 1
the number of digital points or registers to associate with the command.
9 Swap Code - This parameter specifies the swap type for the data. This 1
option is valid only for function codes 3 and 4.
10 Modbus Function Code - This word contains the Modbus function code 1
for the command.
11 Device Database Address - This word contains the Modbus address in 1
the server device to be associated with the command.
12 to n Spare (n - 11)
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file)

Page 114 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

When the module receives this request block, it builds the command, places the
command in the command priority queue (if the queue is not already full;
maximum capacity is 100 commands), and returns a response block to tell the
ladder logic whether or not the command has been successfully added to the
queue.

Block Response from Module to Processor

Word Offset Description
0 This word contains the Read Block ID 2000 to verify the Event Command
request was received by the module.
1 This word contains the Write Block identification code of the next expected
write block.
2 This word contains the result of the event request. If a value of one is present,
the command was issued. If a value of zero is present, no room was found in
the command queue.
3 to (n + 1) Spare
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file)

Word 2 of the block can be used by the ladder logic to determine whether or not
the command was successfully added to the command priority queue. The
command will fail if the queue for the port is already full at the time when the
Event Command block is received by the module.

Controller Tags
The elements of the MNET.CONTROL.EventCmd controller tag structure contain
all the values needed to build one Modbus TCP/IP command, have it sent to the
module, and control the processing of the returned response block.

Controller Tag Description

EventCmdTrigger Set this tag to 1 to trigger the execution of the Event Command.
EventCmdPending Temporary variable used to prevent a new Event Command block
from being sent to the module until the previously sent Event
Command block has been completely processed and a response
block has been returned.
IPAddress Enter the four octet IP address numbers of the target Modbus server
into this array tag.
ServicePort Enter 502 for a MBAP message or 2000 for a MNET message.
NodeAddress Enter the Modbus Node Address. Enter 0, if not needed.
InternalAddress Enter the database address for the Client.
Count Enter the number of words or bits to be transferred by the Client.
Swap Enter the swap type for the data. This function is only valid for function
codes 3 and 4.
FunctionCode Enter the Modbus function code for the command.
DeviceDBAddress Enter the database address for the server.
EventCmdStatusReturned Temporary variable that provides status indication of whether or not
the Event Command was successfully added to the command priority
queue.
EventBlockID Temporary variable that provides the identification code number of the
Block ID just executed.

ProSoft Technology, Inc. Page 115 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Command Control Blocks (5001 to 5006)

Note: Command Control is not needed for normal Modbus command list polling operations and are
needed only occasionally for special circumstances.

During routine operation, the module continuously cycles through the user-
defined MNET Client 0 Command List (page 55), examining commands in the
order they are listed and sending enabled commands on the network. However,
the module also has a special command priority queue, which is an internal
buffer that holds commands from special function blocks until they can be sent
on the network.
When one or more commands appear in the command priority queue:
1 The routine polling process is temporarily interrupted.
2 The commands in the command priority queue are executed until the queue
is empty.
3 Then the module goes back to where it left off on the MNET Client 0
Command List and continues routine polling.
Like Event Command blocks, Command Control blocks place commands into the
module’s command priority queue. Unlike Event Commands blocks, which
contain all the values needed for one command, Command Control is only used
with commands already defined in the MNET Client 0 Command List.
Commands in the MNET Client 0 Command List may be either enabled for
routine polling or disabled and excluded from routine polling. A disabled
command has its Enable parameter set to NO (0) and is skipped during routine
polling. An enabled command has its Enable parameter set to YES (1) and is
sent during routine polling. However, Command Control allows any command in
the predefined MNET Client 0 Command List to be added to the command
priority queue, whether it is enabled for routine polling or not.
Command Control also gives you the option to use ladder logic to have
commands from the MNET Client 0 Command List executed at a higher priority
and out of routine order, if such an option might be required in special
circumstances.

Page 116 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

A single Command Control block request can place up to six commands from the
MNET Client 0 Command List into the command priority queue.

Block Request from Processor to Module

Word Offset Description
0 Command queue Write Block identification code of 5001 to 5006.
1 This word contains the Command Index for the first command to be entered into
the queue.
2 This word contains the Command Index for the second command to be entered
into the queue.
3 This word contains the Command Index for the third command to be entered into
the queue.
4 This word contains the Command Index for the fourth command to be entered
into the queue.
5 This word contains the Command Index for the fifth command to be entered into
the queue.
6 This word contains the Command Index for the sixth command to be entered
into the queue.
7 to n Spare
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file)

The last digit in the block identification code indicates the number of commands
to process. For example, a block identification code of 5003 indicates that three
commands are to be placed in the queue. In this case, the first three of the six
available Command Indexes will be used to determine exactly which three
commands will be added to the queue, and to set their order of execution.
Values to enter for the six Command Indexes range from 0 to 99 and correspond
to the MNET Client 0 Command List entries, which are numbered from 1 to 100.
To determine the Command Index value, subtract one (1) from the row number
of the command in the MNET Client 0 Command List, as seen in the Command
Editor window of ProSoft Configuration Builder (PCB).
The module responds to a Command Control block request with a response
block, indicating the number of commands added to the command priority queue.

Block Response from Module to Processor

Word Offset Description
0 This word contains theRead Block IDs 5001 to 5006 to verify the Command
Control Request was received by the module.
1 This word contains the next expected Write Block identification code.
2 This word contains the number of commands in the block placed in the
command priority queue.
3 to (n + 1) Spare
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file)

ProSoft Technology, Inc. Page 117 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Controller Tags
The MNET.CONTROL.CmdControl controller tag structure holds all the values
needed to create one Command Control block, have it sent to the module, and
control the processing of the returned response block.

Controller Tag Description

CmdControlTrigger Set this tag to 1 to trigger the execution of a command after all the
other parameters have been entered.
CmdControlPending Temporary variable used to prevent a new Command Control block
from being sent to the module until the previously sent Command
Control block has been completely processed and a response block
has been returned.
CommandIndex[x] Enter the ROW NUMBER of the command in the MNET Client 0
Command List in Prosoft Configuration Builder minus 1. This is a
six-element array. Each element holds one Command Index.
CmdsAddedToQueue Returned decimal value representing the quantity of commands
added from the MNET Client 0 Command List to the command
priority queue by the most recent Command Control block.
NumberOfCommands Enter a decimal value representing the quantity of commands to be
requested in the Command Control block (1 to 6).
CmdControlBlockID Temporary variable that provides block ID of the Command Control
block most recently processed by the module.

Page 118 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Pass-Through Blocks (9956 to 9959, 9961, 9970 and 9996)

If the module is set for pass-through operation by placing a value of 1 to 3 in the
configuration file parameter Pass-Through Mode, the module will send special
blocks to the module when a write request is received from a Client. Any Modbus
function 5, 6, 15 or 16 commands will be passed from the server to the processor
using this block identification numbers 9956 to 9959, 9961, 9970 and 9996.
Ladder logic must handle the receipt of these blocks and to place the enclosed
data into the proper controller tags in the module.
There are two basic modes of operation when the pass-through feature is
utilized: Unformatted (code 1) and Formatted (code 2 or 3). The unformatted
mode will pass the message received on the server directly to the processor
without any processing. The following table describes the format of the read
block.

Pass-Through Block 9996 from Module to Processor

Word Offset Description Length
0 Read Block ID 9996 1
1 Write Block ID 9996 1
2 Number of bytes in Modbus msg 1
3 Reserved (always 0) 1
4 to 56 or 60 Modbus message received 56 or 60

If the block size equals 60, 56 words are used.

If the block size equals 120 or 240, 60 words are used.
The ladder logic should copy and parse the received message and control the
processor as expected by the Client device. The processor must respond to the
Pass-through block with a Write block with the following format.

Response Block 9996 from Processor to Module

Word Offset Description Length
0 Write Block ID 9996 1
1 to 61 Spare 61

This will inform the module that the command has been processed and can be
cleared from the pass-through queue.
In formatted pass-through mode, the module will process the received write
request and generate a special block dependent on the function received. There
are two modes of operation when the formatted pass-through mode is selected. If
code 2 is utilized (no swap), the data received in the message is presented in the
order expected by the processor. If code 3 is utilized (swap mode), the bytes in
the data area of the message will be swapped. This selection is applied to all
received write requests. The block identification code used with the request
depends on the Modbus function requested.

ProSoft Technology, Inc. Page 119 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Block ID Modbus Function

9956 6, 16 (word type data)
9957 6, 16 (floating-point)
9958 5
9959 15
9961 23
9970 99

Pass-Through Blocks 9956, 9957, 9958 or 9961 from Module to Processor

Word Offset Description Length
0 Read Block IDs 9956, 9957, 9958 or 9961 1
1 Write Block IDs 9956, 9957, 9958 or 9961 1
2 Number of word registers in Modbus data set 1
3 Starting address for Modbus data set 1
4 to 62 Modbus data set 59

Pass-Through Block 9959 from Module to Processor

Word Offset Description Length
0 Read Block ID 9959 1
1 Write Block ID 9959 1
2 Number of word registers in Modbus data set 1
3 Starting word address for Modbus data set 1
4 to 33 Modbus data set 30
34 to 62 Bit mask for the data set. Each bit to be considered with the 29
data set will have a value of 1 in the mask. Bits to ignore in
the data set will have a value of 0 in the mask.

Pass-Through Block 9970 from Module to Processor

Word Offset Description Length
0 Read Block ID 9970 1
1 Write Block ID 9970 1
2 1 1
3 0 1
4 to 62 Spare data area 59

The ladder logic should copy and parse the received message and control the
processor as expected by the Client device. The processor must respond to the
formatted Pass-through blocks with a Write block. The following table describes
the format of the Write blocks.

Response Blocks 9956, 9957, 9958, 9959, 9961, or 9970 from Processor to Module
Word Offset Description Length
0 Write Block IDs 9956, 9957, 9958, 9959, 9961 or 9970 1
1 to 61 Spare 61

Page 120 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Reset Status Data Block (9997)

Each time the module is powered-up, as part of normal module processing, it
begins using module memory to store module and communication performance
and error information. Dunring a module start-up sequence, this area of module
memory will be 'zeroed', that is to say, all registers will be initialized with a value
of zero. Then, as the module begins to function, the status registers will begin
holding live data as counters are incremented and status values change. This
information is held in volitile RAM memory in the module. Anytime the power is
turned off, this information will be erased.
From time to time, you may wish to reset or clear this stored status information
without turning power to the module off and back on (cycle power). You can use
Special Function Block 9997 to accomplish this clearing or 'reset' of all module
status information, with one exception, without having to cycle power. The one
exception is the Program Scan Count register.
The Program Scan Count register is the only status register that will not be
cleared when using Block 9997. This status register holds a counter value that
tracks the number of times the main firmware processing loop has been
executed. It is a way of knowing whether or not the module is operating and
processing its internal logic. It can be thought of as a' module heartbeat', showing
the module is 'alive' and working. As long as this number coutinues to change
with every status tag update, you will know the module is executing its most
basic functions.
The Program Scan Counter will not be reset by Block 9997, but it will reset as
part of the power-on self test whenever powered up.

WARNING: If you do not add logic to read and store module performance and error data in your
RSLogix5000 ladder logic program, SCADA system, or other MNET device, that status data will be
lost whenever you cycle power to the module or whenever you send Block ID 9997. Once gone, it
can no longer be retrieved from module memory. Only data acquired since the most recent power-
up or issuance of Block 9997 will be available in the module's status registers.

Block Request from Processor to Module

Word Offset Description Length
0 Write Block ID 9997 1
1 to n Not Used n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

Block Response from Module to the Processor

Word Offset Description Length
0 Read Block ID 9997 1
1 Write Block ID of the next expected write block 1
2 to (n + 1) Not used n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file).

ProSoft Technology, Inc. Page 121 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Warm Boot Block (9998)

This block is sent from the CompactLogix or MicroLogix processor to the module
(output image) when the module is required to perform a warm-boot (software
reset) operation. This block is commonly sent to the module any time
configuration data modifications are made in the controller tags data area. This
will cause the module to read the new configuration information and to restart.
The following table describes the format of the Warm Boot block.

Block Request from Processor to Module

Word Offset Description Length
0 9998 1
1 to n Spare n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file)

Cold Boot Block (9999)

This block is sent from the CompactLogix processor to the module (output
image) when the module is required to perform the cold-boot (hardware reset)
operation. This block is sent to the module when a hardware problem is detected
by the ladder logic that requires a hardware reset. The following table describes
the format of the Cold Boot block.

Block Request from Processor to Module

Word Offset Description Length
0 9999 1
1 to n Spare n
n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration file)

Page 122 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.2.3 Data Flow between MVI69-MNET Module and Processor

The following topics describe the flow of data between the two pieces of
hardware (the processor and MVI69-MNET module) and other nodes on the
Modbus TCP/IP network under the module’s different operating modes. The
module has both server and Client capability. The server accepts TCP/IP
connections on service ports 502 (MBAP) and 2000 (MNET). The Client can
generate either MBAP or MNET requests dependent on the service port selected
in the command.

ProSoft Technology, Inc. Page 123 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Server Driver
The server driver allows the MVI69-MNET module to respond to data read and
write commands issued by Clients on the Modbus TCP/IP network. The following
flowchart describes the flow of data into and out of the module.

1 The server driver receives the configuration information from the

configuration file on the Personality Module (compact flash card), and the
module initializes the server.
2 A host device, such as a Modicon PLC or an HMI application, issues a read
or write command to the module’s node address. The server driver validates
the message before accepting it into the module. If the message is
considered invalid, an error response is returned to the originating Client
node.
3 After the module accepts the command, the module processes the data
contained in the command.
If the command is a read command, the data is read out of the database and
a response message is built.
If the command is a write command, the data is written directly into the
database and a response message is built.
If the command is a write command and the pass-through feature is utilized,
the write message is transferred to the processor ladder logic and is not
written directly into the module’s database, unless it is returned as a change
in the output image that overwrites data in the WriteData area as a result of
such ladder logic processing.
4 After the data processing has been completed in Step 3, a response is issued
to the originating Client node.

Page 124 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Counters are available in the Status block that permit the ladder logic program to
determine the level of activity of the server driver.
An exception to normal processing is when the pass-through mode is
implemented. In this mode, all write requests are passed directly to the processor
and are not placed in the database. This permits direct, remote control of the
processor without changes in the intermediate database. This mode is especially
useful for Client devices that do not send both states of control. For example, a
SCADA system may only send a SET command to a digital control point and
never send a CLEAR command to that same digital point address because it
expects the processor logic to reset the control bit. Pass-through must be used to
simulate this mode. The following illustration shows the data flow for a server port
with pass-through enabled.

ProSoft Technology, Inc. Page 125 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Client Driver
In the Client driver, the MVI69-MNET module issues read or write commands to
servers on the Modbus TCP/IP network. The commands originate either from the
module's user-configured Client 0 Command List, or directly from the processor
as Event Commands. The commands from the Client 0 Command List are
executed either via routine polling or as a result of special Command Control
block requests from the processor. The following flowchart describes the flow of
data into and out of the module.

1 The Client driver obtains configuration data when the module restarts. This
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 servers
on the Modbus TCP/IP network.
2 When configured, the Client driver begins transmitting read and/or write
commands to servers on the network. The data for write commands is
obtained from the module's internal database.
3 Assuming successful processing by the server specified in the command, a
response message is received into the Client driver for processing.

Page 126 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

4 Data received from the server is passed into the module's internal database,
if the command was a read command. Status information is routinely returned
to the processor in the input images.
5 Special functions, such as Event Commands and Command Control options,
can be generated by the processor and sent to the Client driver for action.

Client Command List

In order for the Client to function, the module's Client Command List must be
defined. This list contains up to 100 individual entries, with each entry containing
the information required to construct a valid command. This includes the
following:
 Command enable mode ((0) disabled, (1) continuous or (2) conditional)
 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
For information on troubleshooting commands, see Client Command Errors
(page 96).

ProSoft Technology, Inc. Page 127 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.3 Cable Connections

The MVI69-MNET module has the following functional communication
connections installed:
 One Ethernet port (RJ45 connector)
 One RS-232 Configuration/Debug port (RJ45 connector)

5.3.1 Ethernet Connection

The MVI69-MNET module has an RJ45 port located on the front of the module,
labeled Ethernet, for use with the TCP/IP network. The module is connected to
the Ethernet network using an Ethernet cable between the module’s Ethernet
port and an Ethernet switch or hub.

Note: Depending on hardware configuration, you may see more than one RJ45 port on the
module. The Ethernet port is labeled Ethernet.
Warning: The MVI69-MNET module is NOT compatible with Power Over Ethernet (IEEE802.3af /
IEEE802.3at) networks. Do NOT connect the module to Ethernet devices, hubs, switches or
networks that supply AC or DC power over the Ethernet cable. Failure to observe this precaution
may result in damage to hardware, or injury to personnel.
Important: The module requires a static (fixed) IP address that is not shared with any other device
on the Ethernet network. Obtain a list of suitable IP addresses from your network administrator
BEFORE configuring the Ethernet port on this module.

Page 128 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

Ethernet Port Configuration - wattcp.cfg

The wattcp.cfg file must be set up properly in order to use a TCP/IP network
connection. You can view the current network configuration in ProSoft
Configuration Builder (PCB), as shown:

You may also view the network configuration using a PC serial port connection
and an ASCII terminal program (like Windows HyperTerminal) by selecting [@]
(Network Menu) and [V] (View) options when connected to the Debug port. For
more information on serial port access, see the chapter on Diagnostics and
Troubleshooting (page 79).

ProSoft Technology, Inc. Page 129 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.3.2 RS-232 Configuration/Debug Port

This port is physically an RJ45 connection. An RJ45 to DB-9 adapter cable is
included with the module. This port permits a PC-based terminal emulation
program to view configuration and status data in the module and to control the
module. The cable pinout for communications on this port is shown in the
following diagram.

Disabling the RSLinx Driver for the Com Port on the PC

The communication port driver in RSLinx can occasionally prevent other
applications from using the PC’s COM port. If you are not able to connect to the
module’s configuration/debug port using ProSoft Configuration Builder (PCB),
HyperTerminal or another terminal emulator, follow these steps to disable the
RSLinx driver.
1 Open RSLinx and go to COMMUNICATIONS > RSWHO.
2 Make sure that you are not actively browsing using the driver that you wish to
stop. The following shows an actively browsed network.

Page 130 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

3 Notice how the DF1 driver is opened, and the driver is looking for a processor
on node 1. If the network is being browsed, then you will not be able to stop
this driver. To stop the driver your RSWho screen should look like this:

Branches are displayed or hidden by clicking on the or the icons.

4 When you have verified that the driver is not being browsed, go to
COMMUNICATIONS > CONFIGURE DRIVERS.
You may see something like this:

If you see the status as running, you will not be able to use this com port for
anything other than communication to the processor. To stop the driver press
the STOP button on the side of the window:

5 After you have stopped the driver you will see the following.

ProSoft Technology, Inc. Page 131 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

6 You may now use the com port to connect to the debug port of the module.

Note: You may need to shut down and restart your PC before it will allow you to stop the driver
(usually only on Windows NT machines). If you have followed all of the above steps, and it will not
stop the driver, then make sure you do not have RSLogix open. If RSLogix is not open, and you
still cannot stop the driver, then reboot your PC.

5.3.3 DB9 to RJ45 Adaptor (Cable 14)

Page 132 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.4 Modbus Protocol Specification

The following pages give additional reference information regarding the Modbus
protocol commands supported by the MVI69-MNET.

5.4.1 About the MODBUS TCP/IP 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/IP.
MODBUS TCP/IP 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/IP commands to the server. The MVI69-MNET module works
both as a Client and as a server.
Aside from the benefits of Ethernet versus serial communications (including
performance, distance, and flexibility) for industrial networks, the MODBUS
TCP/IP protocol allows for remote administration and control of devices over a
TCP/IP network. The efficiency, scalability, and low cost of a MODBUS TCP/IP
network make this an ideal solution for industrial applications.
The MVI69-MNET module acts as an input/output module between devices on a
MODBUS TCP/IP network and the Rockwell Automation backplane. The module
uses an internal database to pass data and commands between the processor
and the Client and server devices on the MODBUS TCP/IP network.

ProSoft Technology, Inc. Page 133 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.4.2 Read Coil Status (Function Code 01)

Query
This function allows the user to obtain the ON/OFF status of logic coils used to
control discrete outputs from the addressed server only. Broadcast mode is not
supported with this function code. In addition to the server address and function
fields, the message requires that the information field contain the initial coil
address to be read (Starting Address) and the number of locations that will be
interrogated to obtain status data.
The addressing allows up to 2000 coils to be obtained at each request; however,
the specific server device may have restrictions that lower the maximum quantity.
The coils are numbered from zero; (coil number 1 = zero, coil number 2 = one,
coil number 3 = two, and so on).
The following table is a sample read output status request to read coils 0020 to
0056 from server device number 11.

Adr Func Data Start Pt Hi Data Start Pt Lo Data # Of Pts Ho Data # Of Pts Lo Error Check Field
11 01 00 13 00 25 CRC

Response
An example response to Read Coil Status is as shown in Figure C2. The data is
packed one bit for each coil. The response includes the server address, function
code, quantity of data characters, the data characters, and error checking. Data
will be packed with one bit for each coil (1 = ON, 0 = OFF). The low order bit of
the first character contains the addressed coil, and the remainder follow. For coil
quantities that are not even multiples of eight, the last characters will be filled in
with zeros at high order end. The quantity of data characters is always specified
as quantity of RTU characters, that is, the number is the same whether RTU or
ASCII is used.
Because the server interface device is serviced at the end of a controller's scan,
data will reflect coil status at the end of the scan. Some servers will limit the
quantity of coils provided each scan; thus, for large coil quantities, multiple PC
transactions must be made using coil status from sequential scans.

Adr Func Byte Data Coil Data Coil Data Coil Data Coil Data Coil Error
Count Status 20 to Status 28 to Status 36 to Status 44 to Status 52 to Check
27 35 43 51 56 Field
11 01 05 CD 6B B2 OE 1B CRC

The status of coils 20 to 27 is shown as CD(HEX) = 1100 1101 (Binary). Reading

left to right, this shows that coils 27, 26, 23, 22, and 20 are all on. The other coil
data bytes are decoded similarly. Due to the quantity of coil statuses requested,
the last data field, which is shown 1B (HEX) = 0001 1011 (Binary), contains the
status of only 5 coils (52 to 56) instead of 8 coils. The 3 left most bits are
provided as zeros to fill the 8-bit format.

Page 134 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.4.3 Read Input Status (Function Code 02)

Query
This function allows the user to obtain the ON/OFF status of discrete inputs in the
addressed server PC Broadcast mode is not supported with this function code. In
addition to the server address and function fields, the message requires that the
information field contain the initial input address to be read (Starting Address)
and the number of locations that will be interrogated to obtain status data.
The addressing allows up to 2000 inputs to be obtained at each request;
however, the specific server device may have restrictions that lower the
maximum quantity. The inputs are numbered form zero; (input 10001 = zero,
input 10002 = one, input 10003 = two, and so on, for a 584).
The following table is a sample read input status request to read inputs 10197 to
10218 from server number 11.

Adr Func Data Start Pt Hi Data Start Pt Lo Data #of Pts Hi Data #of Pts Lo Error Check Field
11 02 00 C4 00 16 CRC

Response
An example response to Read Input Status is as shown in Figure C4. The data is
packed one bit for each input. The response includes the server address,
function code, quantity of data characters, the data characters, and error
checking. Data will be packed with one bit for each input (1=ON, 0=OFF). The
lower order bit of the first character contains the addressed input, and the
remainder follow. For input quantities that are not even multiples of eight, the last
characters will be filled in with zeros at high order end. The quantity of data
characters is always specified as a quantity of RTU characters, that is, the
number is the same whether RTU or ASCII is used.
Because the server interface device is serviced at the end of a controller's scan,
data will reflect input status at the end of the scan. Some servers will limit the
quantity of inputs provided each scan; thus, for large coil quantities, multiple PC
transactions must be made using coil status for sequential scans.

Adr Func Byte Data Discrete Input Data Discrete Input Data Discrete Input Error Check Field
Count 10197 to 10204 10205 to 10212 10213 to 10218
11 02 03 AC DB 35 CRC

The status of inputs 10197 to 10204 is shown as AC (HEX) = 10101 1100

(binary). Reading left to right, this show that inputs 10204, 10202, and 10199 are
all on. The other input data bytes are decoded similar.
Due to the quantity of input statuses requested, the last data field which is shown
as 35 HEX = 0011 0101 (binary) contains the status of only 6 inputs (10213 to
102180) instead of 8 inputs. The two left-most bits are provided as zeros to fill
the 8-bit format.

ProSoft Technology, Inc. Page 135 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.4.4 Read Holding Registers (Function Code 03)

Query
Read Holding Registers (03) allows the user to obtain the binary contents of
holding registers 4xxxx in the addressed server. The registers can store the
numerical values of associated timers and counters which can be driven to
external devices. The addressing allows up to 125 registers to obtained at each
request; however, the specific server device may have restriction that lower this
maximum quantity. The registers are numbered form zero (40001 = zero, 40002
= one, and so on). The broadcast mode is not allowed.
The example below reads registers 40108 through 40110 from server 584
number 11.

Adr Func Data Start Reg Hi Data Start Reg Lo Data #of Regs Hi Data #of Regs Lo Error Check Field
11 03 00 6B 00 03 CRC

Response
The addressed server responds with its address and the function code, followed
by the information field. The information field contains 1 byte describing the
quantity of data bytes to be returned. The contents of the registers requested
(DATA) are two bytes each, with the binary content right justified within each pair
of characters. The first byte includes the high order bits and the second, the low
order bits.
Because the server interface device is normally serviced at the end of the
controller's scan, the data will reflect the register content at the end of the scan.
Some servers will limit the quantity of register content provided each scan; thus
for large register quantities, multiple transmissions will be made using register
content from sequential scans.
In the example below, the registers 40108 to 40110 have the decimal contents
555, 0, and 100 respectively.

Adr Func ByteCnt Hi Data Lo Data Hi Data Lo Data Hi Data Lo Data Error Check Field
11 03 06 02 2B 00 00 00 64 CRC

Page 136 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.4.5 Read Input Registers (Function Code 04)

Query
Function code 04 obtains the contents of the controller's input registers at
addresses 3xxxx. These locations receive their values from devices connected to
the I/O structure and can only be referenced, not altered from within the
controller, The addressing allows up to 125 registers to be obtained at each
request; however, the specific server device may have restrictions that lower this
maximum quantity. The registers are numbered for zero (30001 = zero, 30002 =
one, and so on). Broadcast mode is not allowed.
The example below requests the contents of register 3009 in server number 11.

Adr Func Data Start Reg Hi Data Start Reg Lo Data #of Regs Hi Data #of Regs Lo Error Check Field
11 04 00 08 00 01 CRC

Response
The addressed server responds with its address and the function code followed
by the information field. The information field contains 1 byte describing the
quantity of data bytes to be returned. The contents of the registers requested
(DATA) are 2 bytes each, with the binary content right justified within each pair of
characters. The first byte includes the high order bits and the second, the low
order bits.
Because the server interface is normally serviced at the end of the controller's
scan, the data will reflect the register content at the end of the scan. Each PC will
limit the quantity of register contents provided each scan; thus for large register
quantities, multiple PC scans will be required, and the data provided will be form
sequential scans.
In the example below the register 3009 contains the decimal value 0.

Adr Func Byte Count Data Input Reg Hi Data Input Reg Lo Error Check Field
11 04 02 00 00 E9

ProSoft Technology, Inc. Page 137 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.4.6 Force Single Coil (Function Code 05)

Query
This message forces a single coil either ON or OFF. Any coil that exists within
the controller can be forced to either state (ON or OFF). However, because the
controller is actively scanning, unless the coil is disabled, the controller can also
alter the state of the coil. Coils are numbered from zero (coil 0001 = zero, coil
0002 = one, and so on). The data value 65,280 (FF00 HEX) will set the coil ON
and the value zero will turn it OFF; all other values are illegal and will not affect
that coil.
The use of server address 00 (Broadcast Mode) will force all attached servers to
modify the desired coil.

Note: Functions 5, 6, 15, and 16 are the only messages that will be recognized as valid for
broadcast.

The example below is a request to server number 11 to turn ON coil 0173.

Adr Func Data Coil # Hi Data Coil # Lo Data On/off Ind Data Error Check Field
11 05 00 AC FF 00 CRC

Response
The normal response to the Command Request is to re-transmit the message as
received after the coil state has been altered.

Adr Func Data Coil # Hi Data Coil # Lo Data On/ Off Data Error Check Field
11 05 00 AC FF 00 CRC

The forcing of a coil via MODBUS function 5 will be accomplished regardless of

whether the addressed coil is disabled or not (In ProSoft products, the coil is only
affected if the necessary ladder logic is implemented).

Note: The Modbus protocol does not include standard functions for testing or changing the
DISABLE state of discrete inputs or outputs. Where applicable, this may be accomplished via
device specific Program commands (In ProSoft products, this is only accomplished through ladder
logic programming).

Coils that are reprogrammed in the controller logic program are not automatically
cleared upon power up. Thus, if such a coil is set ON by function Code 5 and
(even months later), an output is connected to that coil, the output will be "hot".

Page 138 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.4.7 Preset Single Register (Function Code 06)

Query
Function (06) allows the user to modify the contents of a holding register. Any
holding register that exists within the controller can have its contents changed by
this message. However, because the controller is actively scanning, it also can
alter the content of any holding register at any time. The values are provided in
binary up to the maximum capacity of the controller unused high order bits must
be set to zero. When used with server address zero (Broadcast mode) all server
controllers will load the specified register with the contents specified.

Note Functions 5, 6, 15, and 16 are the only messages that will be recognized as valid for
broadcast.

Adr Func Data Start Reg Data Start Reg Data #of Regs Hi Data #of Regs Lo Error Check Field
Hi Lo
11 06 00 01 00 03 CRC

Response
The response to a preset single register request is to re-transmit the query
message after the register has been altered.

Adr Func Data Reg Hi Data Reg Lo Data Input Reg Hi Data Input Reg Lo Error Check Field
11 06 00 01 00 03 CRC

ProSoft Technology, Inc. Page 139 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.4.8 Diagnostics (Function Code 08)

MODBUS function code 08 provides a series of tests for checking the
communication system between a Client device and a server, or for checking
various internal error conditions within a server.
The function uses a two-byte sub-function code field in the query to define the
type of test to be performed. The server echoes both the function code and sub-
function code in a normal response. Some of the diagnostics cause data to be
returned from the remote device in the data field of a normal response.
In general, issuing a diagnostic function to a remote device does not affect the
running of the user program in the remote device. Device memory bit and
register data addresses are not accessed by the diagnostics. However, certain
functions can optionally reset error counters in some remote devices.
A server device can, however, be forced into 'Listen Only Mode' in which it will
monitor the messages on the communications system but not respond to them.
This can affect the outcome of your application program if it depends upon any
further exchange of data with the remote device. Generally, the mode is forced to
remove a malfunctioning remote device from the communications system.

Sub-function Codes Supported

Only Sub-function 00 is supported by the MVI69-MNET module.

00 Return Query Data

The data passed in the request data field is to be returned (looped back) in the
response. The entire response message should be identical to the request.

Sub-function Data Field (Request) Data Field (Response)

00 00 Any Echo Request Data

Example and State Diagram

Here is an example of a request to remote device to Return Query Data. This
uses a sub-function code of zero (00 00 hex in the two-byte field). The data to be
returned is sent in the two-byte data field (A5 37 hex).

Request Response
Field Name (Hex) Field Name (Hex)
Function 08 Function 08
Sub-function Hi 00 Sub-function Hi 00
Sub-function Lo 00 Sub-function Lo 00
Data Hi A5 Data Hi A5
Data Lo 37 Data Lo 27

Page 140 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

The data fields in responses to other kinds of queries could contain error counts
or other data requested by the sub-function code.

ProSoft Technology, Inc. Page 141 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.4.9 Force Multiple Coils (Function Code 15)

Query
This message forces each coil in a consecutive block of coils to a desired ON or
OFF state. Any coil that exists within the controller can be forced to either state
(ON or OFF). However, because the controller is actively scanning, unless the
coils are disabled, the controller can also alter the state of the coil. Coils are
numbered from zero (coil 00001 = zero, coil 00002 = one, and so on). The
desired status of each coil is packed in the data field, one bit for each coil (1=
ON, 0= OFF). The use of server address 0 (Broadcast Mode) will force all
attached servers to modify the desired coils.

Note: Functions 5, 6, 15, and 16 are the only messages (other than Loopback Diagnostic Test) that
will be recognized as valid for broadcast.

The following example forces 10 coils starting at address 20 (13 HEX). The two
data fields, CD =1100 and 00 = 0000 000, indicate that coils 27, 26, 23, 22, and
20 are to be forced on.

Adr Func Hi Add Lo Quantity Byte Data Coil Status Data Coil Status Error Check
Add Cnt 20 to 27 28 to 29 Field
11 0F 00 13 00 0A 02 CD 00 CRC

Response
The normal response will be an echo of the server address, function code,
starting address, and quantity of coils forced.

Adr Func Hi Addr Lo Addr Quantity Error Check Field

11 0F 00 13 00 0A CRC

The writing of coils via Modbus function 15 will be accomplished regardless of

whether the addressed coils are disabled or not.
Coils that are unprogrammed in the controller logic program are not automatically
cleared upon power up. Thus, if such a coil is set ON by function code 15 and
(even months later) an output is connected to that coil, the output will be hot.

Page 142 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

5.4.10 Preset Multiple Registers (Function Code 16)

Query
Holding registers existing within the controller can have their contents changed
by this message (a maximum of 60 registers). However, because the controller is
actively scanning, it also can alter the content of any holding register at any time.
The values are provided in binary up to the maximum capacity of the controller
(16-bit for the 184/384 and 584); unused high order bits must be set to zero.

Note: Function codes 5, 6, 15, and 16 are the only messages that will be recognized as valid for
broadcast.

Adr Func Hi Lo Add Quantity Byte Hi Lo Hi Lo Data Error Check

Add Cnt Data Data Data Field
11 10 00 87 00 02 04 00 0A 01 02 CRC

Response
The normal response to a function 16 query is to echo the address, function
code, starting address and number of registers to be loaded.

Adr Func Hi Addr Lo Addr Quantity Error Check Field

11 10 00 87 00 02 56

ProSoft Technology, Inc. Page 143 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

5.4.11 Modbus Exception Responses

When a Modbus Client sends a request to a server device, it expects a normal
response. One of four possible events can occur from the Client's query:
 If the server device receives the request without a communication error, and
can handle the query normally, it returns a normal response.
 If the server does not receive the request due to a communication error, no
response is returned. The Client program will eventually process a timeout
condition for the request.
 If the server receives the request, but detects a communication error (parity,
LRC, CRC, ...), no response is returned. The Client program will eventually
process a timeout condition for the request.
 If the server receives the request without a communication error, but cannot
handle it (for example, if the request is to read a non-existent output or
register), the server will return an exception response informing the Client of
the nature of the error.
The exception response message has two fields that differentiate it from a
normal response:
Function Code Field: In a normal response, the server echoes the function
code of the original request in the function code field of the response. All function
codes have a most-significant bit (MSB) of 0 (their values are all below 80
hexadecimal). In an exception response, the server sets the MSB of the function
code to 1. This makes the function code value in an exception response exactly
80 hexadecimal higher than the value would be for a normal response.
With the function code's MSB set, the Client's application program can recognize
the exception response and can examine the data field for the exception code.
Data Field: In a normal response, the server may return data or statistics in the
data field (any information that was requested in the request). In an exception
response, the server returns an exception code in the data field. This defines the
server condition that caused the exception.
The following table shows an example of a Client request and server exception
response.

Request Response
Field Name (Hex) Field Name (Hex)
Function 01 Function 81
Starting Address Hi 04 Exception Code 02
Starting Address Lo A1
Quantity of Outputs Hi 00
Quantity of Outputs Lo 01

In this example, the Client addresses a request to server device. The function
code (01) is for a Read Output Status operation. It requests the status of the
output at address 1245 (04A1 hex). Note that only that one output is to be read,
as specified by the number of outputs field (0001).

Page 144 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Reference
Modbus TCP/IP Communication Module User Manual

If the output address is non-existent in the server device, the server will return
the exception response with the exception code shown (02). This specifies an
illegal data address for the server.

Modbus Exception Codes

Code Name Meaning
01 Illegal Function The function code received in the query is not an allowable
action for the server. This may be because the function
code is only applicable to newer devices, and was not
implemented in the unit selected. It could also indicate that
the server is in the wrong state to process a request of this
type, for example because it is unconfigured and is being
asked to return register values.
02 Illegal Data Address The data address received in the query is not an allowable
address for the server. More specifically, the combination
of reference number and transfer length is invalid. For a
controller with 100 registers, a request with offset 96 and
length 4 would succeed; a request with offset 96 and length
5 will generate exception 02.
03 Illegal Data Value A value contained in the query data field is not an allowable
value for server. This indicates a fault in the structure of the
remainder of a complex request, such as that the implied
length is incorrect. It specifically does not mean that a data
item submitted for storage in a register has a value outside
the expectation of the application program, because the
Modbus protocol is unaware of the significance of any
particular value of any particular register.
04 Slave Device Failure An unrecoverable error occurred while the server was
attempting to perform the requested action.
05 Acknowledge Specialized use in conjunction with programming
commands. The server has accepted the request and is
processing it, but a long duration of time will be required to
do so. This response is returned to prevent a timeout error
from occurring in the Client. The Client can next issue a
poll program complete message to determine if processing
is completed.
06 Slave Device Busy Specialized use in conjunction with programming
commands. The server is engaged in processing a long-
duration program command. The Client should retransmit
the message later when the server is free.
08 Memory Parity Error Specialized use in conjunction with function codes 20 and
21 and reference type 6, to indicate that the extended file
area failed to pass a consistency check. The server
attempted to read record file, but detected a parity error in
the memory. The Client can retry the request, but service
may be required on the server device.
0a Gateway Path Unavailable Specialized use in conjunction with gateways, indicates
that the gateway was unable to allocate an internal
communication path from the input port to the output port
for processing the request. Usually means that the gateway
is misconfigured or overloaded.
0b Gateway Target Device Specialized use in conjunction with gateways, indicates
Failed To Respond that no response was obtained from the target device.
Usually means that the device is not present on the
network.

ProSoft Technology, Inc. Page 145 of 159

October 17, 2011
Reference MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Page 146 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Support, Service & Warranty
Modbus TCP/IP Communication Module User Manual

6 Support, Service & Warranty

In This Chapter
 Contacting Technical Support ............................................................. 147
 Return Material Authorization (RMA) Policies and Conditions............. 149
 LIMITED WARRANTY ......................................................................... 151

Contacting Technical Support

ProSoft Technology, Inc. (ProSoft) is committed to providing the most efficient
and effective support possible. Before calling, please gather the following
information to assist in expediting this process:
1 Product Version Number
2 System architecture
3 Network details
If the issue is hardware related, we will also need information regarding:
1 Module configuration and associated ladder files, if any
2 Module operation and any unusual behavior
3 Configuration/Debug status information
4 LED patterns
5 Details about the serial, Ethernet or fieldbus devices interfaced to the module,
if any.

Note: For technical support calls within the United States, an after-hours answering system allows
24-hour/7-days-a-week pager access to one of our qualified Technical and/or Application Support
Engineers. Detailed contact information for all our worldwide locations is available on the following
page.

ProSoft Technology, Inc. Page 147 of 159

October 17, 2011
Support, Service & Warranty MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Internet Web Site: www.prosoft-technology.com/support

E-mail address: [email protected]
Asia Pacific Tel: +603.7724.2080, E-mail: [email protected]
(location in Malaysia) Languages spoken include: Chinese, English
Asia Pacific Tel: +86.21.5187.7337 x888, E-mail: [email protected]
(location in China) Languages spoken include: Chinese, English
Europe Tel: +33 (0) 5.34.36.87.20,
(location in Toulouse, E-mail: [email protected]
France) Languages spoken include: French, English
Europe Tel: +971-4-214-6911,
(location in Dubai, UAE) E-mail: [email protected]
Languages spoken include: English, Hindi
North America Tel: +1.661.716.5100,
(location in California) E-mail: [email protected]
Languages spoken include: English, Spanish
Latin America Tel: +1-281-2989109,
(Oficina Regional) E-Mail: [email protected]
Languages spoken include: Spanish, English
Latin America Tel: +52-222-3-99-6565,
(location in Puebla, Mexico) E-mail: [email protected]
Languages spoken include: Spanish
Brasil Tel: +55-11-5083-3776,
(location in Sao Paulo) E-mail: [email protected]
Languages spoken include: Portuguese, English

Page 148 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Support, Service & Warranty
Modbus TCP/IP Communication Module User Manual

6.1 Return Material Authorization (RMA) Policies and Conditions

The following Return Material Authorization (RMA) Policies and Conditions
(collectively, "RMA Policies") apply to any returned product. These RMA Policies
are subject to change by ProSoft Technology, Inc., without notice. For warranty
information, see Limited Warranty (page 151). In the event of any inconsistency
between the RMA Policies and the Warranty, the Warranty shall govern.

6.1.1 Returning Any Product

a) In order to return a Product for repair, exchange, or otherwise, the
Customer must obtain a Return Material Authorization (RMA) number
from ProSoft Technology and comply with ProSoft Technology shipping
instructions.
b) In the event that the Customer experiences a problem with the Product for
any reason, Customer should contact ProSoft Technical Support at one of
the telephone numbers listed above (page 147). A Technical Support
Engineer will request that you perform several tests in an attempt to
isolate the problem. If after completing these tests, the Product is found to
be the source of the problem, we will issue an RMA.
c) All returned Products must be shipped freight prepaid, in the original
shipping container or equivalent, to the location specified by ProSoft
Technology, and be accompanied by proof of purchase and receipt date.
The RMA number is to be prominently marked on the outside of the
shipping box. Customer agrees to insure the Product or assume the risk
of loss or damage in transit. Products shipped to ProSoft Technology
using a shipment method other than that specified by ProSoft Technology,
or shipped without an RMA number will be returned to the Customer,
freight collect. Contact ProSoft Technical Support for further information.
d) A 10% restocking fee applies to all warranty credit returns, whereby a
Customer has an application change, ordered too many, does not need,
etc. Returns for credit require that all accessory parts included in the
original box (i.e.; antennas, cables) be returned. Failure to return these
items will result in a deduction from the total credit due for each missing
item.

6.1.2 Returning Units Under Warranty

A Technical Support Engineer must approve the return of Product under ProSoft
Technology’s Warranty:
a) A replacement module will be shipped and invoiced. A purchase order will
be required.
b) Credit for a product under warranty will be issued upon receipt of
authorized product by ProSoft Technology at designated location
referenced on the Return Material Authorization

ProSoft Technology, Inc. Page 149 of 159

October 17, 2011
Support, Service & Warranty MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

i. If a defect is found and is determined to be customer generated, or if

the defect is otherwise not covered by ProSoft Technology s warranty,
there will be no credit given. Customer will be contacted and can
request module be returned at their expense;
ii. If defect is customer generated and is repairable, customer can
authorize ProSoft Technology to repair the unit by providing a
purchase order for 30% of the current list price plus freight charges,
duties and taxes as applicable.

6.1.3 Returning Units Out of Warranty

a) Customer sends unit in for evaluation to location specified by ProSoft
Technology, freight prepaid.
b) If no defect is found, Customer will be charged the equivalent of $100
USD, plus freight charges, duties and taxes as applicable. A new
purchase order will be required.
c) If unit is repaired, charge to Customer will be 30% of current list price
(USD) plus freight charges, duties and taxes as applicable. A new
purchase order will be required or authorization to use the purchase order
submitted for evaluation fee.

The following is a list of non-repairable units:

ScanPort Adapters
o 1500 - All
o 1550 - Can be repaired only if defect is the power supply
o 1560 - Can be repaired only if defect is the power supply
inRAx Modules
o 3150 - All
o 3170 - All
o 3250
o 3300
o 3350
o 3600 - All
o 3700
o 3750
o 3800-MNET
ProLinx Standalone Gateways
o 4xxx - All (No hardware available to do repairs)

Page 150 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Support, Service & Warranty
Modbus TCP/IP Communication Module User Manual

6.2 LIMITED WARRANTY

This Limited Warranty ("Warranty") governs all sales of hardware, software, and
other products (collectively, "Product") manufactured and/or offered for sale by
ProSoft Technology, Incorporated (ProSoft), and all related services provided by
ProSoft, including maintenance, repair, warranty exchange, and service
programs (collectively, "Services"). By purchasing or using the Product or
Services, the individual or entity purchasing or using the Product or Services
("Customer") agrees to all of the terms and provisions (collectively, the "Terms")
of this Limited Warranty. All sales of software or other intellectual property are, in
addition, subject to any license agreement accompanying such software or other
intellectual property.

6.2.1 What Is Covered By This Warranty

a) Warranty On New Products: ProSoft warrants, to the original purchaser,
that the Product that is the subject of the sale will (1) conform to and
perform in accordance with published specifications prepared, approved
and issued by ProSoft, and (2) will be free from defects in material or
workmanship; provided these warranties only cover Product that is sold as
new. This Warranty expires three (3) years from the date of shipment for
Product purchased on or after January 1st, 2008, or one (1) year from the
date of shipment for Product purchased before January 1st, 2008 (the
"Warranty Period"). If the Customer discovers within the Warranty Period
a failure of the Product to conform to specifications, or a defect in material
or workmanship of the Product, the Customer must promptly notify
ProSoft by fax, email or telephone. In no event may that notification be
received by ProSoft later than 39 months from date of original shipment.
Within a reasonable time after notification, ProSoft will correct any failure
of the Product to conform to specifications or any defect in material or
workmanship of the Product, with either new or remanufactured
replacement parts. ProSoft reserves the right, and at its sole discretion,
may replace unrepairable units with new or remanufactured equipment.
All replacement units will be covered under warranty for the 3 year period
commencing from the date of original equipment purchase, not the date of
shipment of the replacement unit. Such repair, including both parts and
labor, will be performed at ProSoft’s expense. All warranty service will be
performed at service centers designated by ProSoft.
b) Warranty On Services: Materials and labor performed by ProSoft to repair
a verified malfunction or defect are warranteed in the terms specified
above for new Product, provided said warranty will be for the period
remaining on the original new equipment warranty or, if the original
warranty is no longer in effect, for a period of 90 days from the date of
repair.

ProSoft Technology, Inc. Page 151 of 159

October 17, 2011
Support, Service & Warranty MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

6.2.2 What Is Not Covered By This Warranty

a) ProSoft makes no representation or warranty, expressed or implied, that
the operation of software purchased from ProSoft will be uninterrupted or
error free or that the functions contained in the software will meet or
satisfy the purchaser’s intended use or requirements; the Customer
assumes complete responsibility for decisions made or actions taken
based on information obtained using ProSoft software.
b) This Warranty does not cover the failure of the Product to perform
specified functions, or any other non-conformance, defects, losses or
damages caused by or attributable to any of the following: (i) shipping; (ii)
improper installation or other failure of Customer to adhere to ProSoft’s
specifications or instructions; (iii) unauthorized repair or maintenance; (iv)
attachments, equipment, options, parts, software, or user-created
programming (including, but not limited to, programs developed with any
IEC 61131-3, "C" or any variant of "C" programming languages) not
furnished by ProSoft; (v) use of the Product for purposes other than those
for which it was designed; (vi) any other abuse, misapplication, neglect or
misuse by the Customer; (vii) accident, improper testing or causes
external to the Product such as, but not limited to, exposure to extremes
of temperature or humidity, power failure or power surges; or (viii)
disasters such as fire, flood, earthquake, wind and lightning.
c) The information in this Agreement is subject to change without notice.
ProSoft shall not be liable for technical or editorial errors or omissions
made herein; nor for incidental or consequential damages resulting from
the furnishing, performance or use of this material. The user guide
included with your original product purchase from ProSoft contains
information protected by copyright. No part of the guide may be duplicated
or reproduced in any form without prior written consent from ProSoft.

6.2.3 Disclaimer Regarding High Risk Activities

Product manufactured or supplied by ProSoft is not fault tolerant and is not
designed, manufactured or intended for use in hazardous environments requiring
fail-safe performance including and without limitation: the operation of nuclear
facilities, aircraft navigation of communication systems, air traffic control, direct
life support machines or weapons systems in which the failure of the product
could lead directly or indirectly to death, personal injury or severe physical or
environmental damage (collectively, "high risk activities"). ProSoft specifically
disclaims any express or implied warranty of fitness for high risk activities.

Page 152 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Support, Service & Warranty
Modbus TCP/IP Communication Module User Manual

6.2.4 Intellectual Property Indemnity

Buyer shall indemnify and hold harmless ProSoft and its employees from and
against all liabilities, losses, claims, costs and expenses (including attorney’s
fees and expenses) related to any claim, investigation, litigation or proceeding
(whether or not ProSoft is a party) which arises or is alleged to arise from Buyer’s
acts or omissions under these Terms or in any way with respect to the Products.
Without limiting the foregoing, Buyer (at its own expense) shall indemnify and
hold harmless ProSoft and defend or settle any action brought against such
Companies to the extent based on a claim that any Product made to Buyer
specifications infringed intellectual property rights of another party. ProSoft
makes no warranty that the product is or will be delivered free of any person’s
claiming of patent, trademark, or similar infringement. The Buyer assumes all
risks (including the risk of suit) that the product or any use of the product will
infringe existing or subsequently issued patents, trademarks, or copyrights.
a) Any documentation included with Product purchased from ProSoft is
protected by copyright and may not be duplicated or reproduced in any
form without prior written consent from ProSoft.
b) ProSoft’s technical specifications and documentation that are included
with the Product are subject to editing and modification without notice.
c) Transfer of title shall not operate to convey to Customer any right to make,
or have made, any Product supplied by ProSoft.
d) Customer is granted no right or license to use any software or other
intellectual property in any manner or for any purpose not expressly
permitted by any license agreement accompanying such software or other
intellectual property.
e) Customer agrees that it shall not, and shall not authorize others to, copy
software provided by ProSoft (except as expressly permitted in any
license agreement accompanying such software); transfer software to a
third party separately from the Product; modify, alter, translate, decode,
decompile, disassemble, reverse-engineer or otherwise attempt to derive
the source code of the software or create derivative works based on the
software; export the software or underlying technology in contravention of
applicable US and international export laws and regulations; or use the
software other than as authorized in connection with use of Product.
f) Additional Restrictions Relating To Software And Other Intellectual
Property
In addition to compliance with the Terms of this Warranty, Customers
purchasing software or other intellectual property shall comply with any
license agreement accompanying such software or other intellectual
property. Failure to do so may void this Warranty with respect to such
software and/or other intellectual property.

6.2.5 Disclaimer of all Other Warranties

The Warranty set forth in What Is Covered By This Warranty (page 151) are in
lieu of all other warranties, express or implied, including but not limited to the
implied warranties of merchantability and fitness for a particular purpose.

ProSoft Technology, Inc. Page 153 of 159

October 17, 2011
Support, Service & Warranty MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

6.2.6 Limitation of Remedies **

In no event will ProSoft or its Dealer be liable for any special, incidental or
consequential damages based on breach of warranty, breach of contract,
negligence, strict tort or any other legal theory. Damages that ProSoft or its
Dealer will not be responsible for include, but are not limited to: Loss of profits;
loss of savings or revenue; loss of use of the product or any associated
equipment; loss of data; cost of capital; cost of any substitute equipment,
facilities, or services; downtime; the claims of third parties including, customers of
the Purchaser; and, injury to property.

** Some areas do not allow time limitations on an implied warranty, or allow the exclusion or
limitation of incidental or consequential damages. In such areas, the above limitations may not
apply. This Warranty gives you specific legal rights, and you may also have other rights which vary
from place to place.

6.2.7 Time Limit for Bringing Suit

Any action for breach of warranty must be commenced within 39 months
following shipment of the Product.

6.2.8 No Other Warranties

Unless modified in writing and signed by both parties, this Warranty is
understood to be the complete and exclusive agreement between the parties,
suspending all oral or written prior agreements and all other communications
between the parties relating to the subject matter of this Warranty, including
statements made by salesperson. No employee of ProSoft or any other party is
authorized to make any warranty in addition to those made in this Warranty. The
Customer is warned, therefore, to check this Warranty carefully to see that it
correctly reflects those terms that are important to the Customer.

6.2.9 Allocation of Risks

This Warranty allocates the risk of product failure between ProSoft and the
Customer. This allocation is recognized by both parties and is reflected in the
price of the goods. The Customer acknowledges that it has read this Warranty,
understands it, and is bound by its Terms.

Page 154 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Support, Service & Warranty
Modbus TCP/IP Communication Module User Manual

6.2.10 Controlling Law and Severability

This Warranty shall be governed by and construed in accordance with the laws of
the United States and the domestic laws of the State of California, without
reference to its conflicts of law provisions. If for any reason a court of competent
jurisdiction finds any provisions of this Warranty, or a portion thereof, to be
unenforceable, that provision shall be enforced to the maximum extent
permissible and the remainder of this Warranty shall remain in full force and
effect. Any cause of action with respect to the Product or Services must be
instituted in a court of competent jurisdiction in the State of California.

ProSoft Technology, Inc. Page 155 of 159

October 17, 2011
Support, Service & Warranty MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

Page 156 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Index
Modbus TCP/IP Communication Module User Manual

D 
Data Flow between MVI69-MNET Module and
Processor • 123
Index DB9 to RJ45 Adaptor (Cable 14) • 132
Diagnostics (Function Code 08) • 140
Diagnostics and Troubleshooting • 9, 78, 79, 129
0  Disabling the RSLinx Driver for the Com Port on the
PC • 130
00 Return Query Data • 140 Disclaimer of all Other Warranties • 153
A  Disclaimer Regarding High Risk Activities • 152
Downloading the Project to the Module Using a Serial
About the MODBUS TCP/IP Protocol • 133 COM Port • 67
Adding Multiple Modules (Optional) • 34 Downloading the Sample Program to the Processor •
Adding the Module to an Existing CompactLogix 41
Project • 19, 20, 73 Duplex/Speed Code • 51
Adding the Module to an Existing MicroLogix Project •
19, 20, 73, 77 E 
Allocation of Risks • 154 Enable • 57
ARP Timeout • 54 Ethernet Configuration • 66
B  Ethernet Connection • 128
Ethernet LED Indicators • 80
Backplane Data Transfer • 102 Ethernet Port Configuration - wattcp.cfg • 129
Backplane Error/Status Pointer • 49, 92 Event Command Block (2000) • 113
Battery Life Advisory • 4 Example and State Diagram • 140
Bit Input Offset • 63 Exiting the Program • 89
Block Transfer Size • 50
F 
C 
Failure Flag Count • 50
Cable Connections • 128 Float Flag • 53, 62
Clearing a Fault Condition • 81 Float Offset • 54, 63
Client Command Errors • 96, 127 Float Start • 53, 63
Client Command List • 127 Force Multiple Coils (Function Code 15) • 142
Client Driver • 126 Force Single Coil (Function Code 05) • 138
Client Error/Status Pointer • 52, 92 Functional Overview • 102
Cold Boot Block (9999) • 122 Functional Specifications • 100
Command Control Blocks (5001 to 5006) • 116
Command Entry Formats • 56 G 
Command Error Delay • 54 Guide to the MVI69-MNET User Manual • 9
Command Error Pointer • 52, 92
Command List Entry Errors • 97 H 
Command List Overview • 55
Commands Supported by the Module • 56 Hardware MAC Address • 65
Comment • 61 Hardware Specifications • 101
Configuration Error Word • 95 Holding Register Offset • 64
Configuring Module Parameters • 47 How to Contact Us • 2
Configuring the MVI69-MNET Module • 19
Configuring the RSLinx Driver for the PC COM Port •
I 
42 Important Installation Instructions • 3
Connecting Your PC to the Module • 44 Importing the Ladder Rung • 24
Connecting Your PC to the Processor • 40 Initialize Output Data • 51
Connection Timeout • 64 Initialize Output Data Blocks (1000 to 1083) • 112
Contacting Technical Support • 147, 149 Installing ProSoft Configuration Builder Software • 14
Controller Tags • 69 Installing the Module • 16
Controlling Law and Severability • 155 Intellectual Property Indemnity • 153
Creating a New RSLogix 5000 Project • 21 Internal Address • 58
Creating the Module • 22 IP Address • 65

ProSoft Technology, Inc. Page 157 of 159

October 17, 2011
Index MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform
User Manual Modbus TCP/IP Communication Module

K  Preset Multiple Registers (Function Code 16) • 143

Preset Single Register (Function Code 06) • 139
Keystrokes • 85 Printing a Configuration File • 48
Product Specifications • 9, 99
L  ProSoft Technology® Product Documentation • 2
Ladder Logic • 69
LED Status Indicators • 80 R 
Limitation of Remedies ** • 154 Read Block • 106
LIMITED WARRANTY • 149, 151 Read Coil Status (Function Code 01) • 134
Read Holding Registers (Function Code 03) • 136
M  Read Input Registers (Function Code 04) • 137
Main Menu • 86 Read Input Status (Function Code 02) • 135
Markings • 4 Read Register Count • 49
MB Address in Device • 61 Read Register Start • 49
Minimum Command Delay • 52 Reading Status Data from the Module • 92
MNET Client Specific Errors • 97 Receiving the Configuration File • 87
MNET Client x • 52 Redisplaying the Current Page • 90
MNET Client x Commands • 55, 113, 116 Reference • 9, 99
MNET Servers • 62 Reg Count • 58
Modbus Database View Menu • 87, 89 Renaming an Object • 47
Modbus Exception Codes • 145 Reset Status Information Block (9991) • 121
Modbus Exception Responses • 144 Resetting Diagnostic Data • 87
Modbus Function • 60 Response Timeout • 52
Modbus Protocol Specification • 89, 133 Retry Count • 53
Modbus TCP/IP • 99 Return Material Authorization (RMA) Policies and
Module • 49 Conditions • 149
Module Communication Error Codes • 96 Returning Any Product • 149
Module Configuration • 49 Returning to the Main Menu • 91
Module Power Up • 102 Returning Units Out of Warranty • 150
Moving Back Through 5 Pages of Registers • 90 Returning Units Under Warranty • 149
Moving Forward Through 5 Pages of Registers • 90 RS-232 Configuration/Debug Port • 130
MVI (Multi Vendor Interface) Modules • 3
MVI69-MNET Add-On Instruction Rung Import S 
Procedure • 19, 20, 25, 36 Sending the Configuration File • 87
MVI69-MNET Controller Tags • 70 Server Driver • 124
MVI69-MNET User-Defined Data Types • 71 Service Port • 59
Setting Jumpers • 15
N  Setting Module Parameters • 47
Navigation • 85 Setting the Block Transfer Size • 31
Network Menu • 89, 91 Setting the Connection Input and Output Sizes • 32
No Other Warranties • 154 Setting the Read and Write Data Array Sizes • 29
Node IP Address • 59, 60 Setting Up the Project • 45
Normal Data Transfer Blocks • 49, 52, 92, 93, 105 Slave Address • 60
Special Function Blocks • 112
O  Standard Modbus Exception Code Errors • 96
Start Here • 9, 11
Opening the Command Error List Menu • 87 Static ARP Table • 65
Opening the Command List Menu • 87 Status Block • 110
Opening the Database View Menu • 87 Status Data Definition • 92, 93, 110
Opening the Network Menu • 89 Sub-function Codes Supported • 140
Output Offset • 63 Support, Service & Warranty • 9, 147
P  Swap Code • 59
System Requirements • 12
Package Contents • 13
Pass-Through Blocks (9956 to 9959, 9961, 9970 and T 
9996) • 119 Time Limit for Bringing Suit • 154
Pass-Through Mode • 51 Transferring WATTCP.CFG to the Module • 91
Pinouts • 3, 128, 132 Transferring WATTCP.CFG to the PC • 91
Poll Interval • 58 Troubleshooting • 81

Page 158 of 159 ProSoft Technology, Inc.

October 17, 2011
MVI69-MNET ♦ CompactLogix and MicroLogix 1500 Platform Index
Modbus TCP/IP Communication Module User Manual

U 
User-Defined Data Types (UDTs) • 71
Using Controller Tags • 73
Using ProSoft Configuration Builder • 45
Using ProSoft Configuration Builder (PCB) for
Diagnostics • 82, 92
Using the Diagnostic Window in ProSoft Configuration
Builder • 82

V 
Viewing Block Transfer Statistics • 86
Viewing Client Configuration • 88
Viewing Client Status • 88
Viewing Data in ASCII (Text) Format • 91
Viewing Data in Decimal Format • 90
Viewing Data in Floating-Point Format • 91
Viewing Data in Hexadecimal Format • 90
Viewing Module Configuration • 87
Viewing Network Status • 88
Viewing NIC Status • 88
Viewing Register Pages • 90
Viewing Server Configuration • 88
Viewing the Next Page of Registers • 90
Viewing the Previous Page of Registers • 90
Viewing the Static ARP Table • 88
Viewing the WATTCP.CFG File on the module • 91
Viewing Version Information • 87

W 
Warm Boot Block (9998) • 122
Warm Booting the Module • 88
Warnings • 3
What Is Covered By This Warranty • 151, 153
What Is Not Covered By This Warranty • 152
Word Input Offset • 64
Write Block • 109
Write Register Count • 50
Write Register Start • 50

Y 
Your Feedback Please • 2

ProSoft Technology, Inc. Page 159 of 159

October 17, 2011