Mvi69E-Mbtcp: User Manual

MVI69E-MBTCP
CompactLogix Platform
Modbus TCP/IP Enhanced
Communication Module
May 8, 2019
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.
ProSoft Technology, Inc.
+1 (661) 716-5100
+1 (661) 716-5101 (Fax)
www.prosoft-technology.com
support@prosoft-technology.com
MVI69E-MBTCP User Manual
May 8, 2019
ProSoft Technology®, is a registered copyright of ProSoft Technology, Inc. All other brand or product names are or
may be trademarks of, and are used to identify products and services of, their respective owners.
In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments.
User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided at:
www.prosoft-technology.com
Content Disclaimer
This documentation is not intended as a substitute for and is not to be used for determining suitability or reliability of
these products for specific user applications. It is the duty of any such user or integrator to perform the appropriate
and complete risk analysis, evaluation and testing of the products with respect to the relevant specific application or
use thereof. Neither ProSoft Technology nor any of its affiliates or subsidiaries shall be responsible or liable for
misuse of the information contained herein. Information in this document including illustrations, specifications and
dimensions may contain technical inaccuracies or typographical errors. ProSoft Technology makes no warranty or
representation as to its accuracy and assumes no liability for and reserves the right to correct such inaccuracies or
errors at any time without notice. If you have any suggestions for improvements or amendments or have found errors
in this publication, please notify us.
No part of this document may be reproduced in any form or by any means, electronic or mechanical, including
photocopying, without express written permission of ProSoft Technology. All pertinent state, regional, and local safety
regulations must be observed when installing and using this product. For reasons of safety and to help ensure
compliance with documented system data, only the manufacturer should perform repairs to components. When
devices are used for applications with technical safety requirements, the relevant instructions must be followed.
Failure to use ProSoft Technology software or approved software with our hardware products may result in injury,
harm, or improper operating results. Failure to observe this information can result in injury or equipment damage.
Copyright © 2019 ProSoft Technology, Inc. All Rights Reserved.
Printed documentation is available for purchase. Contact ProSoft Technology for pricing and availability.
North America: +1 (661) 716-5100
Asia Pacific: +603.7724.2080
Europe, Middle East, Africa: +33 (0) 5.3436.87.20
Latin America: +1.281.298.9109
Important Safety Information
North America Warnings

A This Equipment is Suitable For Use in Class I, Division 2, Groups A, B, C, D or Non-Hazardous Locations Only.
B Warning – Explosion Hazard – Substitution of Any Components May Impair Suitability for Class I, Division 2.
C Warning – Explosion Hazard – Do Not Disconnect Equipment Unless Power Has Been Switched Off Or The
Area is Known To Be Non-Hazardous.
D The subject devices are powered by a Switch Model Power Supply (SMPS) that has regulated output voltage of
5 VDC.
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.
Agency Approvals & Certifications

Please visit our website: www.prosoft-technology.com
MVI69E-MBTCP ♦ CompactLogix Platform Contents
Modbus TCP/IP Enhanced Communication Module User Manual
Contents
Your Feedback Please ........................................................................................................................ 2
Content Disclaimer .............................................................................................................................. 2
Important Safety Information ............................................................................................................... 3
1 Start Here 9
1.1 System Requirements ............................................................................................. 10
1.2 Deployment Checklist.............................................................................................. 11
1.3 Setting Jumpers ...................................................................................................... 11
1.4 Installing the Module in the Rack ............................................................................ 12
1.5 Package Contents ................................................................................................... 15
2 Adding the Module to RSLogix 17

2.1 Creating the Module in an RSLogix 5000 Project ................................................... 17
2.1.1 Creating a Module in the Project Using an Add-On Profile ..................................... 18
2.1.2 Creating a Module in the Project Using a Generic 1769 Module Profile ................. 21
2.2 Installing ProSoft Configuration Builder .................................................................. 24
2.3 Generating the AOI (.L5X File) in ProSoft Configuration Builder ............................ 25
2.3.1 Setting Up the Project in PCB ................................................................................. 25
2.3.2 Creating and Exporting the .L5X File ...................................................................... 27
2.4 Creating a New RSLogix 5000 Project .................................................................... 30
2.5 Importing the Add-On Instruction ............................................................................ 31
2.6 Adding Multiple Modules in the Rack (Optional) ..................................................... 34
2.6.1 Adding an Additional Module in PCB ...................................................................... 34
2.6.2 Adding an Additional Module in RSLogix 5000 ....................................................... 36
3 Configuring the MVI69E-MBTCP Using PCB 43

3.1 Basic PCB Functions ............................................................................................... 44
3.1.1 Creating a New PCB Project and Exporting an .L5X File ....................................... 44
3.1.2 Renaming PCB Objects .......................................................................................... 44
3.1.3 Editing Configuraiton Parameters ........................................................................... 44
3.1.4 Printing a Configuration File .................................................................................... 46
3.2 Module Configuration Parameters .......................................................................... 47
3.2.1 Module ..................................................................................................................... 47
3.2.2 MBTCP Servers ...................................................................................................... 48
3.2.3 MBTCP Client x ....................................................................................................... 50
3.2.4 MBTCP Client x Commands ................................................................................... 51
3.2.5 Ethernet 1 ................................................................................................................ 55
3.2.6 Static ARP Table ..................................................................................................... 56
3.3 Downloading the Configuration File to the Processor ............................................. 57
3.4 Uploading the Configuration File from the Processor ............................................. 60
4 MVI69E-MBTCP Backplane Data Exchange 63

4.1 General Concepts of the MVI69E-MBTCP Data Transfer ...................................... 63
4.2 Backplane Data Transfer......................................................................................... 64
ProSoft Technology, Inc. Page 5 of 150

Contents MVI69E-MBTCP ♦ CompactLogix Platform
User Manual Modbus TCP/IP Enhanced Communication Module
4.3 Normal Data Transfer ............................................................................................. 65

4.3.1 Write Block: Request from the Processor to the Module ........................................ 65
4.3.2 Read Block: Response from the Module to the Processor ..................................... 65
4.3.3 Read and Write Block Transfer Sequences ........................................................... 66
4.4 Data Flow Between the Module and Processor ..................................................... 70
4.4.1 Server Mode ........................................................................................................... 70
4.4.2 Master Mode ........................................................................................................... 72
5 Using Controller Tags 75

5.1 Controller Tags ....................................................................................................... 75
5.1.1 MVI69E-MBTCP Controller Tags............................................................................ 76
5.2 User-Defined Data Types (UDTs)........................................................................... 76
5.2.1 MVI69E-MBTCP User-Defined Data Types ........................................................... 77
5.3 MBTCP Controller Tag Overview ........................................................................... 79
5.3.1 MBTCP.CONFIG .................................................................................................... 79
5.3.2 MBTCP.DATA ......................................................................................................... 80
5.3.3 MBTCP.CONTROL ................................................................................................. 80
5.3.4 MBTCP.STATUS .................................................................................................... 86
5.3.5 MBTCP.UTIL........................................................................................................... 90
6 Diagnostics and Troubleshooting 93

6.1 Ethernet LED Indicators .......................................................................................... 93
6.2 LED Status Indicators ............................................................................................. 94
6.2.1 Clearing a Fault Condition ...................................................................................... 94
6.2.2 Troubleshooting ...................................................................................................... 95
6.3 Connecting the PC to the Module's Ethernet Port .................................................. 96
6.3.1 Setting Up a Temporary IP Address ....................................................................... 96
6.4 Using the Diagnostics Menu in ProSoft Configuration Builder ............................... 98
6.4.1 Diagnostics Menu ................................................................................................. 100
6.4.2 Monitoring General Information ............................................................................ 101
6.4.3 Monitoring Backplane Information ........................................................................ 101
6.4.4 Modbus Server Driver Information ........................................................................ 102
6.4.5 Monitoring Data Values in the Module’s Database............................................... 103
6.4.6 Modbus Client Driver Information ......................................................................... 103
6.5 Communication Error Codes ................................................................................ 104
6.5.1 Standard MODBUS Protocol Exception Code Errors ........................................... 104
6.5.2 Module Communication Error Codes ................................................................... 104
6.5.3 Command List Entry Errors .................................................................................. 104
6.5.4 MBTCP Client-Specific Errors .............................................................................. 105
6.6 Connecting to the MVI69E-MBTCP Webpage ..................................................... 105
7 Reference 107
7.1 Product Specifications .......................................................................................... 107
7.1.1 General Specifications - Modbus Client/Server .................................................... 108
7.1.2 Hardware Specifications ....................................................................................... 108
7.2 About the Modbus TCP/IP Protocol ...................................................................... 109
7.2.1 Modbus Client ....................................................................................................... 109
7.2.2 Modbus Server...................................................................................................... 110
7.2.3 Function Codes Supported by the Module ........................................................... 110
7.2.4 Read Coil Status (Function Code 01) ................................................................... 111
Page 6 of 150 ProSoft Technology, Inc.

MVI69E-MBTCP ♦ CompactLogix Platform Contents
7.2.5 Read Input Status (Function Code 02) .................................................................. 112

7.2.6 Read Holding Registers (Function Code 03) ........................................................ 113
7.2.7 Read Input Registers (Function Code 04)............................................................. 114
7.2.8 Force Single Coil (Function Code 05) ................................................................... 115
7.2.9 Preset Single Register (Function Code 06) ........................................................... 116
7.2.10 Diagnostics (Function Code 08) ............................................................................ 117
7.2.11 Force Multiple Coils (Function Code 15) ............................................................... 119
7.2.12 Preset Multiple Registers (Function Code 16) ...................................................... 120
7.3 Floating-Point Support........................................................................................... 121
7.3.1 ENRON Floating Point Support ............................................................................. 122
7.3.2 Configuring the Floating Point Data Transfer ........................................................ 122
7.4 Function Blocks ..................................................................................................... 127
7.4.1 Event Command Blocks (2000 to 2019) ............................................................... 128
7.4.2 Client Status Request/Response Blocks (3000 to 3019) ...................................... 129
7.4.3 Event Sequence Request Blocks (4000 to 4019) ................................................. 130
7.4.4 Event Sequence Command Error Status Blocks (4100 to 4119) .......................... 131
7.4.5 Get Queue and Event Sequence Block Counts Block (4200)............................... 132
7.4.6 Command Control Blocks (5001 to 5016) ............................................................. 132
7.4.7 Add Event with Data for Client Blocks (8000) ....................................................... 133
7.4.8 Get Event with Data Status Block (8100) .............................................................. 134
7.4.9 Get General Module Status Data Block (9250) ..................................................... 135
7.4.10 Set Driver and Command Active Bits Block (9500) .............................................. 136
7.4.11 Get Driver and Command Active Bits Block (9501) .............................................. 137
7.4.12 Pass-Through Formatted Block for Functions 6 and 16 with Word Data Block
(9956) .................................................................................................................... 138
7.4.13 Pass-Through Formatted Block for Functions 6 and 16 with Float Data Block
(9957) .................................................................................................................... 139
7.4.14 Pass-Through Formatted Block for Function 5 (9958) .......................................... 139
7.4.15 Pass-Through Formatted Block for Function 15 (9959) ........................................ 140
7.4.16 Pass-Through Formatted Block for Function 23 (9961) ........................................ 141
7.4.17 Pass-Through Block for Function 99 (9970) ......................................................... 141
7.4.18 Set Module Time Using Received Time Block (9972) .......................................... 142
7.4.19 Pass Module Time to Processor Block (9973) ...................................................... 143
7.4.20 Reset Status Block (9997)..................................................................................... 143
7.4.21 Warm-boot Control Block (9998) ........................................................................... 144
7.4.22 Cold-boot Control Block (9999) ............................................................................. 144
7.5 Ethernet Port Connection ...................................................................................... 145
7.5.1 Ethernet Cable Specifications ............................................................................... 145
8 Support, Service & Warranty 147

8.1 Contacting Technical Support ............................................................................... 147
8.2 Warranty Information ............................................................................................. 148
Index 149

MVI69E-MBTCP ♦ CompactLogix Platform

MVI69E-MBTCP ♦ CompactLogix Platform Start Here
1 Start Here
In This Chapter
 System Requirements ........................................................................... 10
 Deployment Checklist ............................................................................ 10
 Setting Jumpers .................................................................................... 11
 Installing the Module in the Rack ........................................................... 12
 Package Contents ................................................................................. 15
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 and CompactLogix devices to a power source and to the MVI69E-
MBTCP module’s Ethernet port

Start Here MVI69E-MBTCP ♦ CompactLogix Platform
1.1 System Requirements

The MVI69E-MBTCP module requires the following minimum hardware and
software components:
 Rockwell Automation CompactLogix® processor (firmware version 10 or
higher), with compatible power supply and one free slot in the rack, for the
MVI69E-MBTCP module.
Important: The MVI69E-MBTCP module has a power supply distance rating of 4 (L43 and L45
installations on first 2 slots of 1769 bus). It consumes 500 mA at 5 Vdc.
Important: For 1769-L23x processors, please make note of the following limitation:
1769-L23E-QBFC1B = 450 mA at 5 Vdc (No MVI69E module can be used with this processor.)
 The module requires 500 mA of available 5 Vdc power

 Rockwell Automation RSLogix 5000 programming software version 16 or
higher
 Rockwell Automation RSLinx® communication software version 2.51 or higher
 ProSoft Configuration Builder (PCB) (included)
 ProSoft Discovery Service (PDS) (included in PCB)
 Pentium® II 450 MHz minimum. Pentium III 733 MHz (or better)
recommended
 Supported operating systems:
o Microsoft Windows® 7
o Microsoft Windows Vista
o Microsoft Windows XP Professional with Service Pack 1 or 2
o Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3
o Microsoft Windows Server 2003
 128 Mbytes of RAM minimum, 256 Mbytes of RAM recommended
 100 Mbytes of free hard disk space (or more based on application
requirements)
 256-color VGA graphics adapter, 800 x 600 minimum resolution (True Color
1024 x 768 recommended)
Note: The Hardware and Operating System requirements in this list are the minimum
recommended to install and run software provided by ProSoft Technology®. Other third party
applications may have different minimum requirements. Refer to the documentation for any third
party applications for system requirements.

1.2 Deployment Checklist

Before you begin to configure the module, consider the following questions. Your
answers will help you determine the scope of your project, and the configuration
requirements for a successful deployment.
 Are you creating a new application or integrating the module into an existing
application?
Most applications can use the Sample Add-On Instruction or Sample Ladder
Logic without any modification.
 Which slot number in the chassis does the MVI69E-MBTCP module occupy?
For communication to occur, you must enter the correct slot number in the
sample program.
 Are the RSLogix 5000 and RSLinx software installed?
RSLogix and RSLinx are required to communicate to the CompactLogix
processor.
 How many words of data do you need to transfer in your application (from
CompactLogix to Module / to CompactLogix from Module)?
1.3 Setting Jumpers

The Setup Jumper acts as "write protection" for the module’s firmware. In "write
protected" mode, the Setup pins are not connected, and the module’s firmware
cannot be overwritten. The module is shipped with the Setup jumper OFF. Do not
jumper the Setup pins together unless you are directed to do so by ProSoft
Technical Support (or you want to update the module firmware).
The following illustration shows the MVI69E-MBTCP jumper configuration with
the Setup Jumper OFF.
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.

1.4 Installing the Module in the Rack

Make sure the processor and power supply are installed and configured before
installing the MVI69E-MBTCP module. Refer to the Rockwell Automation product
documentation for installation instructions.
Warning: Please follow all safety instructions when installing this or any other electronic devices.
Failure to follow safety procedures could result in damage to hardware or data, or even serious
injury or death to personnel. Refer to the documentation for each device to be connected to verify
that suitable safety procedures are in place before installing or servicing the device.
After you verify the jumper placements, insert the MVI69E-MBTCP into the rack.
Use the same technique recommended by Rockwell Automation to remove and
install CompactLogix modules.
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.
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.

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

1.5 Package Contents

The following components are included with your MVI69E-MBTCP 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 MVI69E-MBTCP Module MVI69E-MBTCP Modbus TCP/IP Enhanced
Communication Module
1 Ethernet Cable RL-CBL025 Straight-through Ethernet cable
If any of these components are missing, please contact ProSoft Technology

Technical Support for replacement parts. For the latest files, please visit
www.prosoft-technology.com.


MVI69E-MBTCP ♦ CompactLogix Platform Adding the Module to RSLogix
2 Adding the Module to RSLogix
In This Chapter
 Creating the Module in an RSLogix 5000 Project .................................. 17
 Installing ProSoft Configuration Builder ................................................. 24
 Generating the AOI (.L5X File) in ProSoft Configuration Builder ........... 25
 Creating a New RSLogix 5000 Project .................................................. 30
 Importing the Add-On Instruction........................................................... 31
 Adding Multiple Modules in the Rack (Optional) .................................... 34
To add the MVI69E-MBTCP module in RSLogix 5000, you must:

1 Create a new project in RSLogix 5000.
2 Add the module to the RSLogix 5000 project. There are two ways to do this:
o You can use the Add-On Profile from ProSoft Technology. This is the
preferred way, but requires RSLogix version 15 or later.
o You can manually create the module using a generic 1769 profile, and
then manually configure the module parameters. Use this method if you
have RSLogix version 14 or earlier.
3 Create an Add-On Instruction file using ProSoft Configuration Builder (PCB)
and export the Add-On Instruction to an RSLogix 5000 compatible file (.L5X
file).
4 Import the Add-On Instruction (the .L5X file) into RSLogix 5000.
The .L5X file contains the Add-On Instruction, user-defined data types, controller
tags and ladder logic required to configure the MVI69E-MBTCP module.
2.1 Creating the Module in an RSLogix 5000 Project

In an RSLogix 5000 project, there are two ways you can add the MVI69E-
MBTCP module to the project.
 You can use an Add-On Profile (AOP) from ProSoft Technology. The AOP
contains all the configuration information needed to add the module to the
project. This is the preferred way, but requires RSLogix version 15 or later.
Refer to Creating a Module in the Project Using an Add-On Profile (page 18).
 If using an AOP is not an option, you can manually create and configure the
module using a generic 1769 profile. Use this method if you have RSLogix
version 14 or earlier. Refer to Creating a Module in the Project Using a
Generic 1769 Module Profile (page 21).

Adding the Module to RSLogix MVI69E-MBTCP ♦ CompactLogix Platform
2.1.1 Creating a Module in the Project Using an Add-On Profile
Installing an Add-On Profile

Download the AOP file (MVI69x_RevX.X_AOP.zip) from the product webpage
(www.prosoft-technology.com) onto your local hard drive and then extract the
files from the zip archive. Make sure you have shut down RSLogix 5000 and
RSLinx before you install the Add-On Profile (AOP).
1 Run the MPSetup.exe file to start the Setup Wizard. Follow the Setup Wizard
to install the AOP.
2 Continue to follow the steps in the wizard to complete the installation.

3 Click FINISH when complete. The AOP is now installed in RSLogix 5000. You
do not need to reboot the PC.
Using an Add-On Profile

1 In RSLogix 5000, expand the I/O CONFIGURATION folder in the Project tree.
Right-click the appropriate communications bus and choose NEW MODULE.
This opens the Select Module Type dialog box.

2 In the Module Type Vendor Filters area, uncheck all boxes except the
PROSOFT TECHNOLOGY box. A list of ProSoft Technology modules appears.
3 Select the MVI69E-MBTCP module in the list and click CREATE.

4 In the New Module dialog box, edit the NAME and SLOT. Click OK.
Note : The I/O TABLE SIZES above should reflect the Block Transfer Size parameter set in ProSoft
Configuration Builder (see Module Configuration Parameters (page 47)).
A Block Transfer Size of 60 uses an I/O TABLE SIZE of 62/61 words.


The MVI69E-MBTCP module is now visible in the I/O Configuration tree.
2.1.2 Creating a Module in the Project Using a Generic 1769 Module

Profile
1 Expand the I/O CONFIGURATION folder in the Project tree. Right-click the
appropriate communications bus and choose NEW MODULE.
This opens the Select Module Type dialog box.

2 Enter GENERIC in the search text box and select the GENERIC 1769 MODULE. If
you're using an earlier version of RSLogix, expand OTHER in the Select
Module dialog box, and then select the GENERIC 1769 MODULE.
3 Set the Module Properties values as follows:

Parameter Value
Name Enter a module identification string. Example: MVI69E_MBTCP
Description Enter a description for the module. Example: ProSoft
communication module for Serial Modbus communications.
Comm Format Select DATA-INT
Slot Enter the slot number in the rack where the MVI69E-MBTCP
module is 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

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:

Block Transfer Size Input Block Size Output Block Size
60 62 61
120 122 121
240 242 241
4 On the Connection tab, set the REQUESTED PACKET INTERVAL value for your
project and click OK.

The MVI69E-MBTCP module is now visible in the I/O Configuration tree.
2.2 Installing ProSoft Configuration Builder

Use the ProSoft Configuration Builder (PCB) software to configure the module.
You can find the latest version of the ProSoft Configuration Builder (PCB) on our
website: http://www.prosoft-technology.com. The installation filename contains
the PCB version number. For example, PCB_4.3.4.5.0238.EXE.
If you are installing PCB from the ProSoft website:

1 Open a browser window and navigate to Error! Hyperlink reference not
valid..
2 Perform a search for 'pcb' in the Search bar. Click on the ProSoft
Configuration Builder search result.
3 On the PCB page, click the download link for ProSoft Configuration Builder,
and save the file to your Windows desktop.
4 After the download completes, double-click the file to install. If you are using
Windows 7, right-click the PCB installation file and then choose RUN AS
ADMINISTRATOR. Follow the instructions that appear on the screen.
5 If you want to find additional software specific to your MVI69E-MBTCP, enter
the model number into the ProSoft website search box and press the Enter
key.

2.3 Generating the AOI (.L5X File) in ProSoft Configuration Builder

The following sections describe the steps required to set up a new configuration
project in ProSoft Configuration Builder (PCB), and to export the .L5X file for the
project.
2.3.1 Setting Up the Project in PCB

To begin, start PROSOFT CONFIGURATION BUILDER (PCB).
The PCB window consists of a tree view on the left, and an information pane and
a configuration pane on the right side of the window. The tree view consists of
folders for Default Project and Default Location, with a Default Module in the
Default Location folder. The following illustration shows the PCB window with a
new project.

Your first task is to add the MVI69E-MBTCP module to the project.
1 In the Tree view, right-click DEFAULT MODULE, and then choose CHOOSE
MODULE TYPE. This opens the Choose Module Type dialog box.
2 In the Product Line Filter area of the dialog box, click MVI69. In the Select
Module Type dropdown list, click MVI69E-MBTCP, and then click OK to save
your settings and return to the ProSoft Configuration Builder window. The
MVI69E-MBTCP icon is now visible in the tree view.

2.3.2 Creating and Exporting the .L5X File

There are two parameters in the PCB configuration that affect the format of the
.L5X file that is exported. Before exporting the .L5X file to the PC/Laptop, check
the Block Transfer Size and Slot Number parameters.
1 Expand the MVI69E-MBTCP icon by clicking the [+] symbol beside it.
Similarly, expand the icon.
2 Double-click the icon to open the Edit - Module dialog box.

3 Set the Block Transfer Size to the desired size of the data blocks transferred
between the module and processor (60, 120 or 240 words). You can find
block transfer size information starting in Normal Data Transfer (page 65).

4 Edit the Slot Number indicating where the module is located in the 1769 bus.
5 Click OK to close the Edit – Module dialog box. The .L5X file is now ready to
export to the PC/Laptop.
6 Right-click the MVI69E-MBTCP icon in the project tree and choose EXPORT
AOI FILE.

7 Save the .L5X file to the PC/Laptop in an easily found location, such as the
Windows Desktop.

2.4 Creating a New RSLogix 5000 Project

1 Click the FILE menu and then choose NEW.
2 Select your CompactLogix controller model.

3 Select REVISION 16 or newer.
4 Enter a name for your controller, such as My_Controller.
5 Select your CompactLogix chassis type.

2.5 Importing the Add-On Instruction

1 Open the application in RSLogix 5000.
2 Expand the TASKS folder, and expand the MAINTASK folder.
3 Expand the MAINPROGRAM folder and then double-click the MAINROUTINE
icon to display the Routine Editor. The MainRoutine contains rungs of logic.
The very last rung in this routine is blank. This is where you can import the
Add-On Instruction (AOI).
Note: You can place the Add-On Instruction in a different routine than the MainRoutine. Make sure
to add a rung with a jump instruction (JSR) in the MainRoutine to jump to the routine containing the
Add-On Instruction.
4 Right-click an empty rung in the routine and choose IMPORT RUNGS.

5 Select the .L5X file that you exported from ProSoft Configuration Builder. See
Creating and Exporting the .L5X File (page 27).
This opens the Import Configuration dialog box. Click TAGS under
MAINROUTINE to display the controller tags in the Add-On Instruction.
Note: If you are using RSLogix version 16 or earlier, the Import Configuration dialog box does not
contain the Import Content tree.

6 If the module is not located in the default slot (or is in a remote rack), edit the
connection input and output variables that define the path to the module in
the FINAL NAME column (NAME column for RSLogix version 16 or less). For
example, if your module is located in slot 3, change Local:1:I in the FINAL
NAME column to Local:3:I. Do the same for Local:1:O.
Note: If your module is located in Slot 1 of the local rack, this step is not required.
7 Click OK to confirm the import. RSLogix indicates that the import is in

progress:
When the import is completed, the new rung with the Add-On Instruction is
visible as shown in the following image.
The procedure has also imported new user-defined data types, data objects
and the Add-On instruction to be used in the project with the MVI69E-MBTCP
module.

2.6 Adding Multiple Modules in the Rack (Optional)
Important: This procedure is for multiple MVI69E-MBTCP modules running in the same
CompactLogix rack
You can add additional modules of the same type to the rack.
1 Add a new MVI69E-MBTCP module to the ProSoft Configuration Builder
(PCB) project.
2 Export the module configuration as an L5X file.
3 Add a new MVI69E-MBTCP to the RSLogix 5000 project.
4 Import the .L5X file into RSLogix 5000 for the new module as an Add-On
Instruction.
2.6.1 Adding an Additional Module in PCB

1 Start ProSoft Configuration Builder (PCB).
2 Right click DEFAULT LOCATION (which you can rename) and choose ADD
MODULE.
3 Right-click NEW MODULE and choose CHOOSE MODULE TYPE.
4 In the Choose Module Type dialog box, select MVI69E in the PRODUCT LINE
FILTER area, and then select MVI69E-MBTCP as the MODULE TYPE. Click
OK.

5 Select the MVI69E-MBTCP module in the tree and repeat the above steps to
add a second (or more) module in the PCB project.
Note: You must give each MVI69E-MBTCP module a unique name. The default name on a
duplicate module appends a number to the end such as MVI69E-MBTCP_000, MVI69E-
MBTCP_001, etc.
6 You can rename the module by right clicking the module and selecting
Rename.
7 Configure the module parameters. See Module Configuration Parameters

(page 47), and then export the AOI .L5X file for the new module (right-click
the module and then choose EXPORT AOI FILE). See Creating and Exporting
the .L5X File (page 27).

2.6.2 Adding an Additional Module in RSLogix 5000

You can place multiple MVI69E-MBTCP modules in the same rack provided it
does not exceed the power distance rating of the CompactLogix rack (see
System Requirements (page 10)). Adding an additional module is similar to
installing a new module; however, the name of the module must be unique.
1 Start RSLogix 5000 and open the project.
2 In RSLogix 5000, locate the I/O CONFIGURATION folder. Right click
COMPACTBUS LOCAL and choose NEW MODULE.
3 In the Select Module Type dialog box, select theMVI69E-MBTCP module.

o If you are using an Add-On Profile (AOP), this adds the MVI69E-MBTCP
module and configures the relevant parameters. You must be using
RSLogix version 15 or later to to use an AOP.
o If using an AOP is not an option, select GENERIC 1769 MODULE and click
CREATE.
4 The New Module dialog box appears. Enter a unique name for the new
module, and confirm the slot number of the new module.

5 Click OK. The new module is now visible.
6 You must also import the Add-On Instruction(AOI) for the new module (see
Adding another module in PCB). In the Controller Organizer pane, double-
click MAINROUTINE to open the ladder for the routine.

7 Right-click an empty rung in the routine and then choose IMPORT RUNGS…
8 Select the .L5X file you created and exported for the new module, and click
IMPORT. Recall that the new .L5X file has a unique filename that is specific to
the new module.

9 This opens the Import Configuration dialog box. Click TAGS to show the
controller tags in the AddOn Instruction. You must edit the FINAL NAME
column of the tags for the second module to make them unique.

10 Associate the I/O connection variables to the correct module in the

corresponding slot number. The default values are Local:1:I and Local:1:O.
You must edit these values if the card is placed in a slot location other than
slot 1 (Local:1:x means the card is located in slot 1). Since the second card is
placed in slot 2, change the FINAL NAME to Local:2:I and Local:2:O. Also, you
can append a ‘_2’ at the end of the FINAL NAME of ‘AOI69_MBS’ and ‘MBS’
arrays as shown below.

11 Click OK.
The setup procedure is now complete. Save the project. It is ready to download
to the CompactLogix processor.


MVI69E-MBTCP ♦ CompactLogix Platform Configuring the MVI69E-MBTCP Using PCB
3 Configuring the MVI69E-MBTCP Using PCB
In This Chapter
 Basic PCB Functions ............................................................................. 44
 Module Configuration Parameters ......................................................... 47
 Downloading the Configuration File to the Processor ............................ 57
 Uploading the Configuration File from the Processor ............................ 60
ProSoft Configuration Builder (PCB) provides a quick and easy way to manage
module configuration files customized to meet your application needs.
You build and edit the module’s configuration in ProSoft Configuration Builder.
You use PCB to download the configuration file to the CompactLogix processor,
where it is stored in the MBTCP.CONFIG controller tag generated by the
previously exported AOI. See Creating and Exporting the .L5X File (page 27).
When the MVI69E-MBTCP module boots up, it requests the processor to send
the configuration over the backplane in special Configuration Blocks.
See the chapter Adding the Module to RSLogix (page 16) for the procedures to
create a new PCB project and export a .L5X file for the processor. This chapter
describes the module configuration parameters in detail, as well as how to
download the configuration to the processor using PCB.

Configuring the MVI69E-MBTCP Using PCB MVI69E-MBTCP ♦ CompactLogix Platform
3.1 Basic PCB Functions
3.1.1 Creating a New PCB Project and Exporting an .L5X File

Please see the chapter Adding the Module to RSLogix (page 16).
3.1.2 Renaming PCB Objects

You can rename objects such as the Default Project and Default Location folders
in the tree view. You can also rename the Module icon to customize the project.
1 Right-click the object you want to rename and then hoose RENAME.
2 Type the new name for the object and press Enter.
3.1.3 Editing Configuraiton Parameters

1 Click the [+] sign next to the MVI69E-MBTCP 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.
To edit a parameter, click the parameter in the left pane and then make your
changes in the right pane.
Note: Depending on the parameter, you must enter text, or a valid number, or select from a list of
options.
4 Click OK to save your changes.

5 Double-click any icon to open an Edit dialog box with a table. Use this
dialog box to build and edit Modbus Client commands.
6 To add a row to the table, click ADD ROW.

7 To edit the row, click EDIT ROW. This opens an Edit dialog box.
3.1.4 Printing a Configuration File

1 In the main PCB window, right-click the MVI69E-MBTCP icon and then
choose VIEW CONFIGURATION.
2 In the View Configuration dialog box, click the FILE menu and then click
PRINT.
3 In the Print dialog box, choose the printer to use from the drop-down list,
select the printing options, and then click OK.

3.2 Module Configuration Parameters
3.2.1 Module
This section contains general module configuration parameters. In the ProSoft
Configuration Builder (PCB) tree view, expand the MVI69E-MBTCP icon, then
expand MODULE, and then double-click the MODULE icon.
Parameter Value Description

Module Name ASCII Assigns a name to the module that can be viewed using the
characters configuration/debug port. Use this parameter to identify the module
(max. 38) and the configuration file.
Read Register Start 0 to 9999 Specifies the starting address of the module's Read Data area. Data
in this area is transferred from the module to the processor.
Read Register Count 0 to 10,000 Specifies the size of the Read Data area.
Write Register Start 0 to 9999 Specifies the start of the Write Data area in module memory. Data in
this area is transferred in from the processor.
Write Register Count 0 to 10,000 Specifies the size of the Write Data area.
Failure Flag Count 0 to 65535 Specifies the number of consecutive backplane transfer failures that
can occur before Modbus communications are halted.
Error/Status Block -1 to 9955 Starting register location in the module’s database for the error/status
Pointer table. This data must be placed in the read data range of module
memory. If a value of -1 is entered, the error/status data is not placed
in the database. All other valid values determine the starting location
of the data.
This data area includes the module version information and all server
error/status data. Refer to MBTCP.STATUS.GeneralStatus (page 88)
for more information.
Initialize Input Image Yes or No This parameter determines if the input image data and the module’s
Read Register Data values are initialized with Read Register Data
values from the processor. If you set the parameter to No, the Read
Register Data values in the module are set to 0 upon initialization. If
you set the parameter to Yes, the data is initialized with Read
Register Data values from the processor. Using this option requires
associated ladder logic to pass the data from the processor to the
module.
Block Transfer Size 60, 120 or Specifies the number of words in each block transferred between the
240 module and processor.
Slot Number 1 to x Specifies the slot in the CompactLogix rack for the module.
Important: The sum of the Read Register Count and Write Register Count cannot exceed 10,000
total registers. Furthermore, neither the Read Data nor the Write Data area may extend above
module register 9999. The Read Data and Write Data areas must have separate address ranges in
the module database and must not overlap.

3.2.2 MBTCP Servers

This section applies to configuring the MVI69E-MBTCP Server (Slave) Driver.
In the ProSoft Configuration Builder tree view, double-click the MBTCP SERVERS
icon.

Start Active Yes or No Specifies whether or not the port and commands are active
upon module boot-up.
Pass-Through Client, Server, Specifies which device type the port emulates. Refer to the
Mode or Server with section Data Flow Between the Module and Processor (page
Pass-Through 70) for more information on the server with Pass-Through
option.
Float Flag Yes or No Specifies how the Server driver responds 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 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
returns 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 sends 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 (the default setting).
You also must set the Float Start and Float Offset parameters
to appropriate values whenever the Float Flag parameter is set
to YES.
Float Start 0 to 9998 Defines the first register of floating-point data. All requests with
register values greater-than or equal to this value are
considered floating-point data requests. This parameter is only
used if the Float Flag is enabled. For example, if you enter a
value of 7000, all requests for registers 7000 and above are
considered as floating-point data.
Float Offset 0 to 9998 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 you set the Float Offset value to 3000
and set the float start parameter to 7000, data requests for
register 7000 use the internal Modbus register 3000.

Output Offset 0 to 9999 Specifies the offset address into the internal Modbus database
for network requests for Modbus function 1, 5 or 15
commands. For example, if you set the value to 100, an
address request of 0 corresponds to register 100 in the
database.
Bit Input Offset 0 to 9999 Specifies the offset address into the internal Modbus database
for network requests for Modbus function 2 commands. For
example, if you set the value to 150, an address request of 0
returns the value at register 150 in the database.
Holding Register 0 to 9999 Specifies the offset address in the internal Modbus database
Offset for network requests for Modbus function 3, 6, or 16
commands. For example, if you enter a value of 50, a request
for address 0 corresponds to the register 50 in the database.
Word Input Offset 0 to 9999 Specifies the offset address into the internal Modbus database
for network requests for Modbus function 4 commands. For
example, if you set the value to 150, an address request of 0
returns the value at register 150 in the database.
Connection 0 to 1200 Specifies the server’s timeout period if it is not receiving any
Timeout new data in the amount of seconds preset.

3.2.3 MBTCP Client x

This section defines the general configuration for MBTCP Client x. You can
configure up to 20 MBTCP clients, each using the parameters below. In the
ProSoft Configuration Builder tree view, double-click the MBTCP CLIENT X icon.

Enabled Yes or No Enables this client
Start Active Yes or No Specifies whether to start with commands active on boot up
Error/Status Pointer -1 to 9990 Specifies the starting register location in the module’s database
for the error/status table for this client. If you enter a value of -1,
the error/status data is not placed in the database.
All other valid values determine the starting location of the data.
This data should be placed within the read data range of module
memory.
Command Error -1 to 9984 Specifies the address in the module’s database where the
Pointer command error data is placed. If you set the value to -1, the data
is not transferred to the database. This data should be placed
within the read data range of module memory.
Minimum Command 0 to 65535 Specifies the number of milliseconds to wait between receiving
Delay milliseconds the end of a server's response to the most recently transmitted
command and the issuance of the next command.
You can use this parameter to place a delay after each
command to avoid sending commands on the network faster
than the servers can be ready to receive them. It does not affect
retries of a command, as retries are issued when a command
failure is recognized.
Response Timeout 1 to 65535 Specifies the command response timeout period in 1 millisecond
milliseconds increments. The client waits for a response from the addressed
server within the timeout period before re-transmitting the
command (Retries) or skipping to the next command in the
Command List.
The value depends on the communication network used and the
expected response time (plus or minus) of the slowest device on
the network.
Retry Count 0 to 10 Specifies the number of times a command is retried if it fails.
Float Flag Yes or No Specifies if the Daniel/ENRON-specific floating-point data access
functionality is to be implemented. If you set the Float Flag to Y,
Modbus functions 3, 6 and 16 interpret floating point values for
registers as specified by the two following parameters (Float
Start, Float Offset).
Note: You do not need to enable this parameter for most
applications using floating-point data.

Float Start 0 to 9998 Specifies the first register of floating-point data. All requests with
register values greater-than or equal to this value are considered
floating-point data requests. This parameter is only used if the
Float Flag is enabled.
Float Offset 0 to 9998 Specifies the start register for floating-point data in the internal
database. This parameter is used only if the Float Flag is
enabled.
ARP Timeout 1 to 60 Specifies the number of seconds to wait for an ARP reply after a
seconds request is issued. If the value is out of range, the module uses
the default value of 5.
Command Error Delay 0 to 300 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 you set this parameter to 0, there is no delay.
MBAP Port Override Yes or No Override default port settings.
NO = Use standard server Port 502 with MBAP format
messages. All other server Port values use encapsulated
Modbus message format (RTU via TCP).
YES = Use MBAP format messages for all server Port values.
RTU via TCP is not used.
3.2.4 MBTCP Client x Commands

In order to interface the MVI69E-MBTCP module with Modbus server devices,
you must create 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.
Each of the 20 Client Command Lists supports up to 16 commands each. The
command list is processed from top (Command #0) to bottom.
Read commands are executed without condition. You can set write commands to
execute only if the data in the write command changes (Conditional Enable). If
the register data values in the command have not changed since the command
was last issued, the command is not executed. You can use this feature to
optimize network performance.
Note: The first command in the Client x Command list cannot be disabled.
The MBTCP Modbus client (and server) communication drivers support several
data read and write commands. When you configure a command, you need to
consider the type of data (bit, 16-bit integer, 32-bit float, etc), and the level of
Modbus support in the server equipment.

In the ProSoft Configuration Builder tree view, double-click the MBTCP CLIENT X
COMMANDS icon.

Enable Disable, Enable, Specifies whether the command is executed and under what
Conditional, conditions.
Bit/Word DISABLE (0) = The command is disabled and is not executed in the
Override, normal polling sequence.
Float Override ENABLE (1) = The command is executed each scan of the
command list if the Poll Interval (see below) is set to zero. If the
Poll Interval is set to a nonzero value, the command is executed
when the interval timer expires.
CONDITIONAL (2) = For write commands only. The command
executes only if the internal data associated with the command
changes.
BIT/WORD OVERRIDE (3) = For read commands only. If a command
error occurs, the module overrides the associated database area
with the Override Value Upon Error parameter value.
FLOAT OVERRIDE (4) = For read commands only. If a command
error occurs, the module overrides the associated database area
(2x word count) with the Override Value Upon Error parameter
value.
Internal Address 0 to 9999 (word- Specifies the module’s internal database register to be associated
level) with the command. Allowable range is 0 to 9999 for Modbus
or Function Codes 3, 4, 6, or 16, and 0 to 65535 for Modbus Function
0 to 65535 (bit- Codes 1, 2, 5, or 15.
level) If the command is a read function, the data read from the server
device is stored beginning at the module’s internal database
register value entered in this field. This register value must be in
the Read Data area of the module’s memory, defined by the Read
Register Start and Read Register Count parameters in the Module
section.
If the command is a write function, the data to be written to the
server device is sourced beginning from the module’s internal
database register specified. This register value must come from
the Write Data area of the module’s memory, defined by the Write
Register Start and Write Register Count parameters in the Module
section.
Poll Interval 0 to 65535 Specifies the minimum interval between executions of continuous
(1/10 second) commands (Enable code = 1).
Example: The parameter is entered in 1/10th of a second.
Therefore, if a value of 100 is entered, the command executes no
more frequently than every 10 seconds. When the command
reaches the top of the command queue and 10 seconds has not
elapsed, it is skipped until the poll interval has expired.

Register Count 1 to 125 (words) Specifies the number of registers or digital points to be associated
or with the command. Modbus Function Codes 5 and 6 ignore this
1 to 800 (coils) field as they only apply to a single data point.
For Modbus Function Codes 1, 2, and 15, this parameter sets the
number of single bit digital points (inputs or coils) to be associated
with the command.
For Modbus Function Codes 3, 4, and 16, this parameter sets the
number of 16-bit registers to be associated with the command.
Swap Code No Change, Defines if the data received from the Modbus server is to be
Word Swap, ordered differently than received from the server device. This
Word and Byte parameter is helpful when dealing with floating-point or other multi-
Swap, register values, as there is no standard method of storing these
Byte Swap data types in server devices. You can set this parameter to order
the register data received in an order useful by other applications.
NO CHANGE = No change is made in the byte ordering (ABCD =
ABCD)
WORD SWAP = The words are swapped (ABCD= CDAB)
WORD AND BYTE SWAP = The words are swapped, then the bytes
in each word are swapped (ABCD=DCBA)
BYTE SWAP = The bytes in each word are swapped
(ABCD=BADC)
Note: Each pair of characters is a byte (example: AB and CD).
Two pairs of characters is a 16-bit register (example: ABCD).
Node IP Address xxx.xxx.xxx.xxx Specifies the IP address of the target device being addressed by
the command.
Service Port 1 to 65535 Use a value of 502 when addressing Modbus TCP/IP servers
which are compatible with the Schneider Electric MBAP
specifications (most devices).
If a server implementation supports another service port, enter the
value here. Service Port 2000 is common for encapsulated format
messages.
Slave Address 0 to 255 Mainly used for Modbus TCP/IP to serial conversion. This
specifies the Modbus slave node address on the serial network to
be considered.
If a Modbus TCP/IP server device does not have or need a slave
address, use a value of ‘1’.
If you set the value to zero, the command is a broadcast message
on the network. The Modbus protocol permits broadcast
commands for write operations. Do not use this node address for
read operations.
Modbus Function 1, 2, 3, 4, 5, 6, 15, Specifies the Modbus function to be executed by the command.
16 These function codes are defined in the Modbus protocol.
1 = Read Coil Status (0xxxx)
2 = Read Input Status (1xxxx)
3 = Read Holding Registers (4xxxx)
4 = Read Input Registers (3xxxx)
5 = Force (Write Single) Coil (0xxxx)
6 = Force (Write Single) Holding Register (4xxxx)
15 = Preset (Write) Multiple Coils (0xxxx)
16 = Preset (Write) Multiple Registers (4xxxx)
MB Address in 0 to 9999 Specifies the register or digital point address offset within the
Device Modbus server device. The MBTCP client reads or writes from/to
this address within the server.
Refer to the documentation of each Modbus server device for their

register and digital point address assignments.

Note: The value you enter here does not need to include the
"Modbus Prefix" addressing scheme. Also, this value is an offset of
the zero-based Modbus addressing scheme.
Example: When using a Modbus Function Code 3 to read from
address 40010 in the server, enter a value of ‘9’ for this parameter.
The firmware (internally) adds a ‘40001’ offset to the value
entered. This is the same for all Modbus addresses (0x, 1x, 3x,
4x).
Override Value This parameter is only applicable when the Enable parameter is 3
Upon Error (Bit/Word Override) or 4 (Float Override).
If an error occurs associated with a read command, the module
automatically populates the associated database area with this
override value.

3.2.5 Ethernet 1
This section defines the permanent IP address, Subnet Mask, and Gateway of
the module.
In the ProSoft Configuration Builder tree view, double-click the ETHERNET 1 icon.
Parameter Description
IP Address Unique IP address assigned to the module
Netmask Subnet mask of module
Gateway Gateway (if used)

3.2.6 Static ARP Table

This section defines a list of static IP addresses that the module uses when an
ARP (Address Resolution Protocol) is required. The module accepts 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 MVI69E-
MBTCP module communicates with regularly.
In ProSoft Configuration Builder tree view, double-click the STATIC ARP TABLE
icon.

IP Address xxx.xxx.xxx.xxx This table contains a list of static IP addresses that the module
uses when an ARP is required. The module accepts 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,
there is no communication with the module.
Hardware MAC FF.FF.FF.FF.FF.FF This table contains a list of static MAC addresses that the
Address module uses when an ARP is required. The module accepts
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,
there is no communication with the module.

3.3 Downloading the Configuration File to the Processor

1 In the ProSoft Configuration Builder tree view, right-click the module icon and
then click DOWNLOAD FROM PC TO DEVICE.
2 In the Download Configuration File dialog box, click RSWHO.

3 Browse to, and then click the CompactLogix processor and click OK.
4 Notice the CIPConnect path has been updated in the Download Configuration
File dialog box. Click TEST CONNECTION to verify the path is active and can
successfully connect to the processor.

5 When ready, click DOWNLOAD to download the configuration file to the

processor. Following the download process, the module is automatically
rebooted.
6 After rebooting, the ladder logic sends the configuration data from the
processor to the module. When that is complete, the module starts Modbus
communications.

3.4 Uploading the Configuration File from the Processor

1 In the ProSoft Configuration Builder tree view, right-click the MVI69E-MBTCP
icon and choose UPLOAD FROM DEVICE TO PC.

2 In the Upload Configuration File dialog box, the CIPConnect path should
already be constructed if you have previously downloaded the configuration
file from the same PC. If not, click RSWHO, browse to, and then select the
CompactLogix Processor, and click OK.

3 Click TEST CONNECTION to verify the path is active and can successfully
connect to the processor.
4 When ready, click UPLOAD. When upload is complete, click CLOSE.
5 PCB now displays the uploaded configuration file.

MVI69E-MBTCP ♦ CompactLogix Platform MVI69E-MBTCP Backplane Data Exchange
4 MVI69E-MBTCP Backplane Data Exchange
In This Chapter
 General Concepts of the MVI69E-MBTCP Data Transfer ..................... 63
 Backplane Data Transfer ....................................................................... 64
 Normal Data Transfer ............................................................................ 65
 Data Flow Between the Module and Processor..................................... 70
4.1 General Concepts of the MVI69E-MBTCP Data Transfer

The MVI69E-MBTCP module uses ladder logic to communicate with the
CompactLogix processor across the backplane. The ladder logic handles the
module data transfer, configuration data transfer, special block handling, and
status data receipt.
The following topics describe several concepts that are important for
understanding the operation of the MVI69E-MBTCP module. This is the order of
operations on power-up:
1 The module begins the following logical functions:
o Initialize hardware components
o Initialize CompactLogix backplane driver
o Test and clear all RAM
2 Read configuration from the CompactLogix processor through ladder logic
3 Allocate and initialize Module Register space
4 Enable Modbus TCP/IP Ethernet port
After the module has received the module configuration, the module begins
communicating with other devices on the Modbus network, depending on the
Modbus configuration of the module.

MVI69E-MBTCP Backplane Data Exchange MVI69E-MBTCP ♦ CompactLogix Platform
4.2 Backplane Data Transfer

The MVI69E-MBTCP module communicates directly over the CompactLogix
backplane. Data is paged between the module and the CompactLogix 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 that you
define for the module and the communication load on the module. Typical
updates are in the range of 1 to 10 milliseconds per block of information.
This bi-directional data transfer is accomplished by the module filling in data in
the module's input image to send to the processor. Data in the input image is
placed in the Controller Tags in the processor by the ladder logic. The input
image for the module may be set to 62, 122, or 242 words depending on the
block transfer size parameter set in the configuration file. This data area permits
fast throughput of data between the module and the processor.
The processor inserts data to the module's output image to transfer to the
module. The module's program extracts the data and places it in the module's
internal database. The output image for the module may be set to 61, 121, or 241
words depending on the block transfer size parameter set in the configuration
file.
The following illustration shows the data transfer method used to move data
between the CompactLogix processor, the MVI69E-MBTCP module and the
Modbus Network.
All data transferred between the module and the processor over the backplane is
through the input and output images. Ladder logic in the CompactLogix
processor interfaces the input and output image data with data defined in the
Controller Tags. All data used by the module is stored in its internal database.
This database is defined as virtual MBTCP data tables with addresses from 0 to
the maximum number of points for each data type.

4.3 Normal Data Transfer

Normal data transfer includes the paging of the user data found in the module’s
internal database (Registers 0 to 9999) and the status data. These data are
transferred through read (input image) and write (output image) blocks. The
following topics describe the structure and function of each block.
4.3.1 Write Block: Request from the Processor to the Module

These blocks of data transfer information from the processor to the module. The
structure of the output image used to transfer this data is shown below:
Offset Description Length (words)
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 that determines the location in the module’s
database where the data is placed.
4.3.2 Read Block: Response from the Module to the Processor

These blocks of data transfer information from the module to the processor. The
structure of the input image used to transfer this data is shown below:
Offset Description Length (words)
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).

4.3.3 Read and Write Block Transfer Sequences

The Read Block ID is an index value that determines the location where the data
is placed in the processor controller tag array of module read data. 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.
Under normal program operation, the module sequentially sends read blocks and
requests write blocks. For example, if the application uses three read and two
write blocks, the sequence is as follows:
R1W1R2W2R3W1R1W2R2W1R3W2R1W1
This sequence continues until interrupted by other write block numbers sent by
the controller or by a command request from a node on the Modbus network or
operator control through the module’s Configuration/Debug port.
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 is continuously transferred from the module to the

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

If Block Transfer Size = 60



4.4 Data Flow Between the Module and Processor

The following topics describe the flow of data between the two pieces of
hardware (CompactLogix processor and MVI69E-MBTCP module) and other
nodes on the Modbus network. The module can act as a Modbus TCP/IP client
(master), server (slave), or both simultaneously.
4.4.1 Server Mode

In Server driver mode, the MVI69E-MBTCP module responds to read and write
commands issued by a client on the Modbus network. The following diagram
shows the data flow for normal Server mode.
Step Description
1 Any time the module restarts (boots or reboots), the server port driver receives
configuration information from the MBTCP controller tags. This information configures the
Ethernet port and defines Server driver characteristics. The configuration information may
also contain instructions to offset data stored in the database to addresses different from
addresses requested in the received messages.
2 A Modbus client device, such as a Modicon PLC or an HMI application, issues a read or
write command to the module’s IP address. The Server driver qualifies the message before
accepting it into the module. Rejected commands cause an Exception Response.
3 After the module accepts the command, the data is immediately transferred to or from the
module’s internal database. On a read command, the data is read from of the database and
a response message is built. On a write command, the data is written directly into the
database and a response message is built.
4 After Steps 2 and 3 have been completed, either a normal response message or an
Exception Response message is sent to the client.
5 Counters are available in the Status Block to permit the ladder logic program to determine
the level of activity of the Server driver.

In Server Pass-Through mode, write commands from the client are handled
differently than they are in Normal mode. In Server Pass-Through mode, all write
requests are passed directly to the processor and data is not written directly into
the module’s database.
This mode is especially useful when both a Modbus client and the module’s
processor logic need to be able to read and write values to the same internal
database addresses.
The following diagram shows the data flow for a server port with Pass-Through
enabled:
Step Description
1 Same as normal mode.
3 a. In Pass-Through mode, if the Server driver receives a read request, it looks for the
data in module’s internal database, just as it would in Normal mode.
b. The data needed to respond to the read command is retrieved directly from the
internal database and returned to the Server driver so it can build a response message.
c. In Pass-Through mode, if the Server Driver receives a write request, it does not send
the data directly to the module’s internal database. It puts the data to be written into a
special Input Image with a special Block ID code to identify it as a Pass-Through Write
Block and substitutes this special block in place of the next regular Read Data Block. The
special block is processed by the ladder logic and the data to be written is placed into the
WriteData controller tag array at an address that corresponds to the Modbus Address
received in the write command.
d. During normal backplane communications, the data from the WriteData array,
including the data updated by the Pass-Through Write Block, is sent to the module’s
internal database. This gives the ladder logic the opportunity to also change the values
stored in these addresses, if need be, before they are written to the database.
Note: The ReadData array is not used in Pass-Through mode.

4.4.2 Master Mode

In Client mode, the MVI69E-MBTCP module issues read or write commands to
server devices on the Modbus network. You configure these commands in
ProSoft Configuration Builder in the Client Command List. This list is transferred
to the module when the module receives its configuration from the processor.
The commands can also be issued directly from the CompactLogix processor
(Special Command Blocks).
Command status is returned to the processor for each individual command in the
command list. The location of this command status list in the module’s internal
database is user-defined. The following flow chart and associated table describe
the flow of command data into and out of the module.
Step Description
1 Upon module boot-up, the Client driver obtains configuration data from the MBTCP
controller tags. The configuration data retrieved includes Ethernet configuration and the
Client Command List.
Special Commands can be issued directly from the CompactLogix processor using Event
Commands and Command Control. The Client driver uses these command values to
determine the types and order of commands to send to server on the network.
2 After configuration, the Client driver begins transmitting read and/or write commands to
server nodes on the network. If the Client driver is writing data to a server, the data for
the write command is retrieved from the module’s internal database.
3 Once the specified server has successfully processed the command, it returns a
response message to the Client driver for processing.
4 Data received from a server in response to a read command is stored in the module’s
internal database.
5 Status is returned to the processor for each command in the Client Command List.

Important: Take care when constructing each command in the list to ensure predictable operation
of the module. If two commands write to the same internal database address of the module, the
results are invalid. All commands containing invalid data are ignored by the module.
Client Command List

You can define up to 10 Modbus TCP/IP client connections in the MVI69E-
MBTCP. Each client connection can contain up to 16 commands each.
A valid command includes the following items:
 Command enable mode: (0) disabled, (1) continuous, or (2) conditional for
write commands only.
 Source or destination database address: The module’s database address
where data is written or read.
 Count: The number of words or bits to be transferred: up to 125 words for
Function Codes 3, 4, or 16; and up to 2000 bits for Function Codes 1, 2, or
15.
Note: 125 words is the maximum count allowed by the Modbus protocol. Some field devices may
support less than the full 125 words. Check with the device manufacturer for the maximum count
supported by the particular slave device.
 Server IP Address.
 Modbus Service Port of the server.
 Modbus Function Code: This is the type of command that is issued.
 Source or destination address in the server device.
Command Error Codes

As the list is read in from the processor and as the commands are processed, an
error value is maintained in the module for each command. The definition for
these command error codes is listed in Communication Error Codes (page 104).
You can view the command error codes through the Ethernet diagnostics port;
refer to Diagnostics and Troubleshooting (page 92). They can also be transferred
from the module’s database to the processor.
To transfer the Command Error List to the processor, set the Command Error
Offset parameter in the port configuration to a module database address that is in
the module’s Read Data area.
Note: The Command Error List must be placed in the Read Data area of the database, so it can be
transferred to the processor in the input image. Each MBTCP client must place their own
Command Error List within the Read Data area so that they do not overlap each other.


MVI69E-MBTCP ♦ CompactLogix Platform Using Controller Tags
5 Using Controller Tags
In This Chapter
 Controller Tags ...................................................................................... 75
 User-Defined Data Types (UDTs) ......................................................... 76
 MBTCP Controller Tag Overview .......................................................... 79
Ladder logic is required for managing communication between the MVI69E-

MBTCP module and the CompactLogix processor. The ladder logic handles
tasks such as:
 Module backplane data transfer
 Special block handling
 Status data receipt
Additionally, a power-up handler may be needed to initialize the module’s
database and may clear some processor fault conditions.
The sample Import Rung with Add-On Instruction is extensively commented to
provide information on the purpose and function of each user-defined data type
and controller tag. For most applications, the Import Rung with Add-On
Instruction works without needing any modification.
5.1 Controller Tags

Data related to the MVI69E-MBTCP 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. After you import the Add-On Instruction, you
can find the controller tags 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 (UDTs),
which are collections of data types.

Using Controller Tags MVI69E-MBTCP ♦ CompactLogix Platform
5.1.1 MVI69E-MBTCP Controller Tags

The main controller tag structure, MBTCP, 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 structure to
expand it and view the next level in the structure.
For example, if you expand the MBTCP.DATA controller tag structure, you see
that it contains two controller tag arrays, MBTCP.DATA.ReadData and
MBTCP.DATA.WriteData, which are 600-element integer arrays by default.
The controller tags in the Add-On Instruction are commented in the DESCRIPTION
column.
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).
5.2 User-Defined Data Types (UDTs)

User-defined data types (UDTs) allow you to organize collections of data types
into groupings. You can use these groupings, or data type structures, to declare
the data types for controller tag structures. Another advantage of defining a UDT
is that you may reuse it 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.

5.2.1 MVI69E-MBTCP User-Defined Data Types

Twenty-two different UDTs are defined for the MVI69E-MBTCP Add-On
Instruction.
The main UDT, MBTCPMODULEDEF, contains all the data types for the module
and was used to create the main controller tag structure, MBTCP. There are five
UDTs one level below MBTCPMODULEDEF. These lower-level UDTs were used
to create the MBTCP.CONFIG, MBTCP.DATA, MBTCP.CONTROL,
MBTCP.STATUS, and MBTCP.UTIL controller tag structures.
Click the [+] signs to expand the UDT structures and view lower-level UDTs.

For example, if you expand MBTCP.DATA, you 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 used to declare the
MBTCP.DATA.ReadData and MBTCP.DATA.WriteData controller tag arrays.
The UDTs are commented in the DESCRIPTION column.
Tip: If more than 600 words of Read or Write Data are needed, the MBTCP.DATA.ReadData and
MBTCP.DATA.WriteData controller tag arrays can be expanded. Simply edit the size of the
ReadData or WriteData integer array in the Data Type column of the MBTCPDATA UDT. In the
example below, the ReadData array size has been changed to 2000. Save and download the
ladder program for this change to take effect.

5.3 MBTCP Controller Tag Overview

You use controller tags to:
 View the read and write 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).
Tag Name Description

MBTCP.CONFIG Configuration information
MBTCP.DATA MBTCP input and output data transferred between the processor
and the module
MBTCP.CONTROL Governs the data movement between the PLC rack and the
module
MBTCP.STATUS Status information
MBTCP.UTIL Generic tags used for internal ladder processing (DO NOT
MODIFY)
The following sections describe each of these controller tag structures in more
detail.
5.3.1 MBTCP.CONFIG
When ProSoft Configuration Builder (PCB) downloads the configuration file from
the PC to the processor, the processor stores the configuration file data in the
MBTCP.CONFIG.FileData array. Its CRC is also included in this array.
You cannot edit this array directly. You must use PCB to edit the module
configuration since PCB calculates a unique CRC to protect data integrity. Any
change to the configuration parameters directly in this array do not match the
calculated CRC.
MBTCP.CONFIG.FileData This parameter contains the MBTCP configuration data after it
has been downloaded from PCB. It is displayed in ASCII format.
Note: MBTCP configuration changes cannot be made directly in
this array; the configuration must be downloaded with PCB.
MBTCP.CONFIG.FileSize Configuration file size (MBTCP.CONFIG.FileData array) in bytes.
MBTCP.CONFIG.FileCRC32 CRC checksum of the configuration file stored in the array.
MBTCP.CONFIG.FileStatus Configuration file status. 0 = No file present, 1 = File present

5.3.2 MBTCP.DATA
This array contains the Read Data and Write Data arrays for processor-to-
module communication.

MBTCP.DATA.ReadData Data area copied from the module to the processor. This array
stores the Modbus data coming into the module from the Modbus
network.
MBTCP.DATA.WriteData Data area copied from the processor to the module. This array
stores the outgoing data sent from the module to the Modbus
network.
5.3.3 MBTCP.CONTROL
This array handles special tasks requested by the processor.
MBTCP.CONTROL
This array allows the processor to dynamically enable configured commands for
execution.
Tag Name Range Description

MBTCP.CONTROL. 0 or 1 Command Control: Disable = 0, Enable = 1
CommandControl.Trigger
MBTCP.CONTROL. 1 to 16 This value represents the quantity of commands to
CommandControl.CommandID be requested in the Command Control block (1 to
16). The ladder logic uses this value to generate
the Command Control Block ID. The rightmost
digits of the Command Control Block ID are the
number of commands requested by the block.
MBTCP.CONTROL. 0 to 19 Client ID associated with the command to be
CommandControl.ClientID executed. There are 20 MBTCP clients available.
MBTCP.CONTROL. 0 to 15 This array stores the command index within the
CommandControl.CommandIndex client ID. It can be determined by command row
number minus 1. Up to 16 command indexes can
be stored here
MBTCP.CONTROL. This value is returned from the module. This is the
CommandControl.CmdsAddedToQue number of commands added to the queue.
-1 = Client not enabled and active.
-2 = Client index not valid.
MBTCP.CONTROL. Number of commands in the queue waiting to be
CommandControl.CmdInQue executed

MBTCP.CONTROL.EventCommand_DBData
This array allows the processor to dynamically build Modbus commands with
data associated to the module’s database. This feature is meant for periodic
execution such as resetting clock and zeroing-out counters.

MBTCP.CONTROL.EventCommand 0 or 1 Toggle to send Event Command.
_DBData.Trigger 0 = Disable, 1 = Enable
MBTCP.CONTROL.EventCommand 0 to 19 Client ID associated with the command to be
_DBData.ClientID executed
MBTCP.CONTROL.EventCommand xxx.xxx.xxx IP address of target Modbus server
_DBData.ServerIPaddress .xxx
MBTCP.CONTROL.EventCommand 502 or Service port of target Modbus server
_DBData.ServicePort 2000
MBTCP.CONTROL.EventCommand 1 to 255 Slave address of target Modbus TCP/IP to serial
_DBData.SlaveAddress device, if applicable
MBTCP.CONTROL.EventCommand 0 to 9999 Specifies the module’s internal database
_DBData.InternalDBaddress (word-level) register to be associated with the command.
or Allowable range is:
0 to 65535 0 to 9999 for Modbus Function Codes 3, 4, 6, or
(bit-level) 16
0 to 65535 for Modbus Function Codes 1, 2, 5,
or 15.
MBTCP.CONTROL.EventCommand 1 to 125 Specifies the number of registers or digital
_DBData.RegisterCount (words) points to be associated with the command.
or Modbus Function Codes 5 and 6 ignore this field
1 to 800 as they only apply to a single data point.
(coils)
MBTCP.CONTROL.EventCommand 0,1,2,3 Specifies if the data received from the Modbus
_DBData.SwapCode server is to be ordered differently than received
from the server device.
This parameter is helpful when dealing with
floating-point or other multi-register values, as
there is no standard method of storage of these
data types in server devices.
MBTCP.CONTROL.EventCommand 1,2,3,4,5,6, Specifies the Modbus function to be executed
_DBData.ModbusFC 15,16 by the command.
MBTCP.CONTROL.EventCommand 0 to 9999 Specifies the register or digital point address
_DBData.DeviceModbusAddress offset within the Modbus server device. The
MBTCP client reads or writes from/to this
address within the server.
MBTCP.CONTROL.EventCommand 0 = Fail
_DBData.StatusReturned 1 = Success
-1 = Client is not Enabled and Active
MBTCP.CONTROL.EventCommand Number of commands in the queue waiting to
_DBData.CmdInQue be executed

MBTCP.CONTROL.EventCommand_PLCData
This array allows the processor to dynamically build Modbus commands with
PLC processor data. This feature is meant for periodic execution such as
resetting the clock and zeroing-out counters.

MBTCP.CONTROL.EventCommand 0 or 1 Toggle to send Event Command.
_PLCData.Trigger 0 = Disable, 1 = Enable
MBTCP.CONTROL.EventCommand 0 to 19 Client ID associated with the command to be
_PLCData.ClientID executed
MBTCP.CONTROL.EventCommand xxx.xxx.xx IP address of target Modbus server
_PLCData.ServerIPaddress x.xxx
MBTCP.CONTROL.EventCommand 502 or Service port of target Modbus server
_PLCData.ServicePort 2000
MBTCP.CONTROL.EventCommand 1 to 255 Slave address of target Modbus TCP/IP to serial
_PLCData.SlaveAddress device, for backwards compatibility
MBTCP.CONTROL.EventCommand 1,2,3,4,5,6 Specifies the Modbus function to be executed
_PLCData.ModbusFunctionCode ,15,16 by the command.
MBTCP.CONTROL.EventCommand 0 to 9999 Specifies the register or digital point address
_PLCData.DeviceDBAddress offset within the Modbus server device. The
MBTCP.CONTROL.EventCommand 1 to 125 Specifies the number of registers or digital
_PLCData.PointCount (words) points to be associated with the command.
(coils)
MBTCP.CONTROL.EventCommand Data values associated with the command
_PLCData.Data
MBTCP.CONTROL.EventCommand Command status after execution
_PLCData.ErrorStatus

MBTCP.CONTROL.EventSequenceCommand
This tag array contains the values needed to build one Modbus TCP/IP
command, have it sent to a specific client on the module, and control the
processing of the returned response block.

MBTCP.CONTROL.EventSequence 0 or 1 Toggle to send Event Sequence Command.
Command.Trigger 0 = Disable, 1 = Enable
MBTCP.CONTROL.EventSequence 0 to 19 Client ID associated with the command to be

Command.ClientID executed
MBTCP.CONTROL.EventSequence xxx.xxx.xxx IP address of target Modbus server
Command.ServerIPaddress .xxx
MBTCP.CONTROL.EventSequence 502 or Service port of target Modbus server
Command.ServicePort 2000
MBTCP.CONTROL.EventSequence 1 to 255 Slave address of target Modbus TCP/IP to
Command.SlaveAddress serial device, if applicable
MBTCP.CONTROL.EventSequence 0 to 9999 Specifies the module’s internal database
Command.InternalDBaddress (word-level) register to be associated with the command.
or Allowable range is:
0 to 65535 0 to 9999 for Modbus Function Codes 3, 4, 6, or
(bit-level) 16
0 to 65535 for Modbus Function Codes 1, 2, 5,
or 15.
MBTCP.CONTROL.EventSequence 1 to 125 Specifies the number of registers or digital
Command.RegisterCount (words) points to be associated with the command.
(coils)
MBTCP.CONTROL.EventSequence 0,1,2,3 Specifies if the data received from the Modbus
Command.SwapCode server is to be ordered differently than received
from the server device.
This parameter is helpful when dealing with
floating-point or other multi-register values, as
there is no standard method of storage of these
data types in server devices.
MBTCP.CONTROL.EventSequence 1,2,3,4,5,6, Specifies the Modbus function to be executed
Command.ModbusFC 15,16 by the command.
MBTCP.CONTROL.EventSequence 0 to 9999 Specifies the register or digital point address
Command.DeviceModbusAddress offset within the Modbus server device. The
MBTCP.CONTROL.EventSequence Event Sequence Command Number
Command.SequenceNumber
MBTCP.CONTROL.EventSequence Event Sequence Command Returned
Command.StatusReturned 0 = Fail
1 = Success
-1 = Client disabled /inactive
MBTCP.CONTROL.EventSequence Number of Event Sequence commands in
Command.CmdInQue queue

MBTCP.CONTROL.Time
This array allows the processor to get or set module time.
MBTCP.CONTROL.Time.SetTime 0 or 1 Sends the PLC time to the module
0 = Disable, 1 = Enable
MBTCP.CONTROL.Time.GetTime 0 or 1 Retrieves the time from the module to PLC
MBTCP.CONTROL.Time.Year 0 to 9999 Four digit year value. Example: 2014
MBTCP.CONTROL.Time.Month 1 to 12 Month
MBTCP.CONTROL.Time.Day 1 to 31 Day
MBTCP.CONTROL.Time.Hour 0 to 23 Hour
MBTCP.CONTROL.Time.Minute 0 to 59 Minute
MBTCP.CONTROL.Time.Second 0 to 59 Second
MBTCP.CONTROL.Time.Milliseconds 0 to 999 Millisecond
MBTCP.CONTROL.Time.Error 0 or -1 0 = OK
-1 = Error present
MBTCP.CONTROL.ClientServerControl
This array allows the control and retrieval of driver command active bits.
MBTCP.CONTROL.ClientServerControl. 0 or 1 Toggle client/server control
Trigger 0 = Disable, 1 = Enable
MBTCP.CONTROL.ClientServerControl. 0 or 1 Server active state:
ActiveServer 0 = Disable, 1 = Enable
MBTCP.CONTROL.ClientServerControl. Client 0 to 15 bit map for active status of clients
ActiveClient_0to15
MBTCP.CONTROL.ClientServerControl. Client 16 to 19 bit map for active status of
ActiveClient_16to19 clients
MBTCP.CONTROL.ClientServerControl. 0 or 1 Client 0 to 19 command active bits. One word
ActiveClientCmd[x] for each client. Each bit is a command.
MBTCP.CONTROL.ClientServerControl. 0 or 1 Toggle request for status
GetStatus 0 = Disable, 1 = Enable
MBTCP.CONTROL.ClientServerControl. 0 or 1 Server active state
ServerStatus 0 = Disabled, 1 = Enabled
MBTCP.CONTROL.ClientServerControl. Client 0 to 15 bit map for active status of clients
Client_0to15Status
MBTCP.CONTROL.ClientServerControl. Client 16 to 19 bit map for active status of
Client_16to19Status clients
MBTCP.CONTROL.ClientServerControl. 0 or 1 Clients 0 to 19 command active bits. One word
ClientCmdStatus[x] for each client. Each bit is a command.
0 = Disabled, 1 = Enabled

MBTCP.CONTROL.ResetStatus
This array resets the module along with client and server status tags.

MBTCP.CONTROL.ResetStatus. 0 or 1 Toggle reset control
Trigger 0 = Disable, 1 = Enable
MBTCP.CONTROL.ResetStatus. Reset Module status (0 = No, else yes with any non-
Module zero value)
MBTCP.CONTROL.ResetStatus. Reset server status (0 = No, else yes with any non-
Server zero value)
MBTCP.CONTROL.ResetStatus. Reset client status (0 = No, else yes with any non-
Client zero value)
MBTCP.CONTROL.EventSequenceCounts
This tag triggers the counting of the event sequence operation.

MBTCP.CONTROL. 0 or 1 Triggers the counting of event sequence
EventSequenceCounts 0 = Disable, 1 = Enable
MBTCP.CONTROL.EventSequenceStatus
This tag triggers the request for the event sequence status.

MBTCP.CONTROL. 0 or 1 Triggers event sequence status read
EventSequenceStatus 0 = Disable, 1 = Enable
MBTCP.CONTROL.GetGeneralStatus
This tag triggers the request for the general status of the module.

MBTCP.CONTROL. 0 or 1 Triggers general status read
GetGeneralStatus 0 = Disable, 1 = Enable

MBTCP.CONTROL.GetEventDataStatus
This tag triggers the request of the event status.

MBTCP.CONTROL. 0 or 1 Triggers event status read
GetEventDataStatus 0 = Disable, 1 = Enable
MBTCP.CONTROL. ColdBoot
This tag triggers the processor to Coldboot the module (full reboot).

MBTCP.CONTROL.ColdBoot 0 or 1 Triggers a cold boot of the module
MBTCP.CONTROL.WarmBoot
This tag triggers the processor to Warmboot the module (driver reboot).

MBTCP.CONTROL.WarmBoot 0 or 1 Triggers a warm boot the module
5.3.4 MBTCP.STATUS
This array contains the status information of the module.
MBTCP.STATUS.Block
This array contains block status.
MBTCP.STATUS.Block.Read Total number of read blocks transferred from the module to the
processor
MBTCP.STATUS.Block.Write Total number of write blocks transferred from the processor to
the module
MBTCP.STATUS.Block.Parse Total number of blocks successfully parsed that were received
from the processor
MBTCP.STATUS.Block.Event Total number of event command blocks received from the
processor
MBTCP.STATUS.Block.Cmd Total number of command blocks received from the processor
MBTCP.STATUS.Block.Err Total number of block transfer errors recognized by the module

MBTCP.STATUS.ClientStatus
This array contains the status of a specific MBTCP client (0 to 19).

MBTCP.STATUS.ClientStatus. Initiates request for Client Status block from module when set to 1
Request
MBTCP.STATUS.ClientStatus. Specifies Client (0 to 19) to request status data from
ClientID
MBTCP.STATUS.ClientStatus. Total number of requests made from this port to server devices on
CommandRequests the network
MBTCP.STATUS.ClientStatus. Total number of server response messages received on the port
CommandResponses
MBTCP.STATUS.ClientStatus. Total number of command errors processed on the port. These
CommandErrors errors could be due to a bad response or command
MBTCP.STATUS.ClientStatus. Total number of messages sent out of the port
Requests
MBTCP.STATUS.ClientStatus. Total number of messages received on the port
Responses
MBTCP.STATUS.ClientStatus. Total number of message errors sent out of the port
ErrorsSent
MBTCP.STATUS.ClientStatus. Total number of message errors received on the port
ErrorsReceived
MBTCP.STATUS.ClientStatus. Bitmap indicating general module configuration errors
ConfigErrorWord
MBTCP.STATUS.ClientStatus. Most recent error code recorded for the client
CurrentError
MBTCP.STATUS.ClientStatus. Previous most recent error code recorded for the client
LastError
MBTCP.STATUS.ClientStatus. Command error code for each command (0-15) on the specified
CmdErrors[x] client's command list
MBTCP.STATUS.EventSeqStatus
This array contains the status of the event command queue.

MBTCP.STATUS.EventSeqStatus. Specifies Client (0 to19) to request event status data from
ClientID
MBTCP.STATUS.EventSeqStatus. Number of event sequence messages in block (0 to 15)
MessageCount
MBTCP.STATUS.EventSeqStatus. Sequence number returned error code
SeqNum_RetErrCode[x]

MBTCP.STATUS.EventSeqCounts
This array indicates the number of commands waiting in the command queue.

MBTCP.STATUS.EventSeqCounts. Event command quantity waiting in queue. There are two
ClientCmdCount_EventSeqMessage bytes of status data per client. See below for details.
Byte 1: Number of Event sequence commands for which status has not yet been
retrieved (up to 15). This corresponds to the
MNETC.STATUS.EventSeqCmdPending.Client[x]_QueueCount controller tag.
Byte 2: Total number of commands waiting in the command queue. This includes
Event Commands, Event Commands with Sequence Numbers, and Command
Control messages. This corresponds to the
MBTCP.STATUS.EventSeqStatus.MessageCount controller tag.
MBTCP.STATUS.GeneralStatus
This array contains the general status of the module including firmware revision
and general communication status.

MBTCP.STATUS.GeneralStatus. Contains the next write block ID number
ExpectedWriteBlock
MBTCP.STATUS.GeneralStatus. Program cycle counter – increments each time a complete
ProgramScanCount program cycle occurs in the module
MBTCP.STATUS.GeneralStatus. Product code
ProductCode
MBTCP.STATUS.GeneralStatus. Firmware revision level number
ProductVersion
MBTCP.STATUS.GeneralStatus. Operating level number
OperatingSystem
MBTCP.STATUS.GeneralStatus. Run number
RunNumber
MBTCP.STATUS.GeneralStatus. Total number of read blocks transferred from the module to the
ReadBlockCount processor
MBTCP.STATUS.GeneralStatus. Total number of write blocks transferred from the processor to
WriteBlockCount the module
MBTCP.STATUS.GeneralStatus. Total number of blocks successfully parsed that were received
ParseBlockCount from the processor
MBTCP.STATUS.GeneralStatus. Total number of event command blocks received from the
CmdEventBlockCount processor
MBTCP.STATUS.GeneralStatus. Total number of command blocks received from the processor
CmdBlockCount
MBTCP.STATUS.GeneralStatus. Total number of block transfer errors recognized by the module
ErrorBlockCount
MBTCP.STATUS.GeneralStatus. Each bit in this word is used to enable/disable the commands for
Client0CmdExecutionWord client 0.

MBTCP.STATUS.GeneralStatus. Each bit in each of the 19 words is used to enable/disable the
Client1to19CmdExecutionWord commands for clients 1 to 19.
MBTCP.STATUS.GeneralStatus. Bit mapped (1 bit per client 0 to 19)
EventSeqReady Bit = 0, no event sequence status data ready
Bit = 1, event sequence status data ready
MBTCP.STATUS.GeneralStatus. Increments each time an encapsulated Modbus TCP/IP (Service
MNetRequestCount port 2000) request is received.
MBTCP.STATUS.GeneralStatus. Increments each time an encapsulated Modbus TCP/IP (Service
MNetResponseCount port 2000) response message is sent.
MBTCP.STATUS.GeneralStatus. Increments each time an error is sent from a server on service
MnetErrorSent port 2000.
MBTCP.STATUS.GeneralStatus. Increments each time an error is received from a server on
MNETErrorReceived service port 2000.
MBTCP.STATUS.GeneralStatus. Increments each time a MBAP (Service port 502) request is
MBAPRequestCount received.
MBTCP.STATUS.GeneralStatus. Increments each time a MBAP (Service port 502) response
MBAPResponseCount message is sent.
MBTCP.STATUS.GeneralStatus. Increments each time an error is sent from the server on service
MBAPErrorSent port 502.
MBTCP.STATUS.GeneralStatus. Increments each time an error is received from a server on
MBAPErrorReceived service port 502.
MBTCP.STATUS.GetEventDataStatus
This array contains the status of the event command last executed.

MBTCP.STATUS.GetEventData Number of clients contained in block (0 to 19)
Status.ClientRecordsCount
MBTCP.STATUS.GetEventData Two words per client.
Status.Status Word 1 = Client (0 to19)
Word 2 = Error code for last executed command for
corresponding client

5.3.5 MBTCP.UTIL
The array is used for internal ladder processing. It should not be modified.

MBTCP.UTIL.ReadDataSizeGet Holds Read Data array size
MBTCP.UTIL.WriteDataSizeGet Holds Write Data array size
MBTCP.UTIL.ReadDataBlkCount Number of Read Data blocks – this value is the Read Register
Count divided by the Block Transfer Size
MBTCP.UTIL.WriteDataBlkCount Number of Write Data blocks – this value is the Write Register
Count divided by the Block Transfer Size
MBTCP.UTIL.RBTSremainder Remainder from the Read Register Count divided by the Block
Transfer Size
MBTCP.UTIL.WBTSremainder Remainder from the Write Register Count divided by the Block
Transfer Size
MBTCP.UTIL.BlockIndex Computed block offset for data
MBTCP.UTIL.LastRead Latest Read Block ID received from the module
MBTCP.UTIL.LastWrite Latest Write Block ID to be sent to the module
MBTCP.UTIL.LastWriteInit Latest Write Block ID used during initialization
MBTCP.UTIL.ConfigFile [ ] Array Holds variables for configuration file transfer
MBTCP.UTIL.ConfigFile. Length of configuration data to be included in block transfer
WordLength
MBTCP.UTIL.ConfigFile. Block transfer count for transferring the whole configuration file
BlockCount from PLC to the Module
MBTCP.UTIL.ConfigFile.FileOffset Offset in configuration file to use as a starting point for copying
over configuration data
MBTCP.UTIL.ConnectionInputSize Holds size of the Connection Input array
MBTCP.UTIL.BlockTransferSize Size of the backplane transfer blocks
MBTCP.UTIL.SlotNumber Slot number of the module in the rack
MBTCP.UTIL.CommandControl Waiting for response from module
Pending
MBTCP.UTIL. Block ID for Command Control
CommandControlWriteBlockID
MBTCP.UTIL. Keeps an Event Command with Data message from being sent
EventCommandDBDataPending to the module before the previous Event Command with Data
is completed
MBTCP.UTIL. Block ID of last read block
EventCmd_DBDataBlockID
MBTCP.UTIL.EventCmd_ Event response write block ID.
DBDataWriteEventBlockID
MBTCP.UTIL.EventCmd_ Event Command Processor Data Pending – Yes (0) or No (1)
ProcessorDataPending
MBTCP.UTIL.EventCmd_ Event Command processor data block ID
ProcessorDataBlockID
MBTCP.UTIL. Event Sequence Command Pending – Yes (0) or No (1)
EventSeqCmdPending

MBTCP.UTIL. Event Sequence Command Block ID

EventSeqCmdBlockID
MBTCP.UTIL. Event Sequence Command Write Event Block ID
EventSeqCmdWriteEventBlockID
MBTCP.UTIL.PassThrough. Holds variables used for processing Pass-Through messages
MBControlx [ ] Array
MBTCP.UTIL. Client and Server Control Block ID
ClientServerControlBlockID
MBTCP.UTIL.ClientStatusPending Client Status Pending – Yes (0) or No (1)
MBTCP.UTIL. Client Status Write Block ID
ClientStatusWriteBlockID
MBTCP.UTIL. Event Sequence Status Pending – Yes (0) or No (1)
EventSeqStatusPending
MBTCP.UTIL. Event Sequence Status Write Block ID
EventSeqStatusWriteBlockID
MBTCP.UTIL. Event Sequence Counts Write Block ID
EventSeqCountsWriteBlockID
MBTCP.UTIL. Event Sequence Counts Pending – Yes (0) or No (1)
EventSeqCountsPending
MBTCP.UTIL.TimeWriteBlockID Time Write Block ID
MBTCP.UTIL. Reset Status Write Block ID
ResetStatusWriteBlockID
MBTCP.UTIL. Get Event Data Status Block ID
GetEventDataStatusBlockID


MVI69E-MBTCP ♦ CompactLogix Platform Diagnostics and Troubleshooting
6 Diagnostics and Troubleshooting
In This Chapter
 Ethernet LED Indicators ........................................................................ 93
 LED Status Indicators ............................................................................ 94
 Connecting the PC to the Module's Ethernet Port ................................. 96
 Using the Diagnostics Menu in ProSoft Configuration Builder ............... 98
 Communication Error Codes ............................................................... 104
 Connecting to the Module’s Webpage ................................................. 105
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.
 You can view status data contained in the module through the Ethernet port,
using the troubleshooting and diagnostic capabilities of ProSoft Configuration
Builder (PCB).
 You can transfer status data values from the module to processor memory
and can monitor them in the processor manually or by customer-created
logic.
6.1 Ethernet LED Indicators

The Ethernet LEDs indicate the module's Ethernet port status.
LED State Description
Data OFF Ethernet connected at 10Mbps duplex speed
AMBER Solid Ethernet connected at 100Mbps duplex speed
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
or Blinking for Ethernet communication to be possible.

Diagnostics and Troubleshooting MVI69E-MBTCP ♦ CompactLogix Platform
6.2 LED Status Indicators

ETH CFG
CLT BP
SRV OK
The LEDs indicate the module’s operating status.

LED Color Indication
ETH Green Application is running and Ethernet is ready
Off Application is not running
CLT Red Exception response received from the server; bad address,
command, etc
SRV Red Exception message received from the client
CFG Red Error in configuration
Green Configuration is OK
Amber Configuration state
Off Application is not running or backplane has failed
BP Red Processor is not in RUN mode
Green (Flashing) BP transfer is operational
Amber Initialization state
Off Application is not running
OK Red Application is not running
Green Application is running
During module configuration, the OK LED is red and the BP LED is on. If the BP
ACT and OK LEDs blink at a rate of every one-second, this indicates a serious
problem with the module. Call ProSoft Technology Technical Support to arrange
for repairs.
6.2.1 Clearing a Fault Condition

Typically, if the OK LED on the front of the module remains 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 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.
6.2.2 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 securely plugged into the slot that has been
configured for the module in the I/O Configuration in RSLogix.
Verify that the slot location in the rack has been configured correctly in
the ladder logic.
Processor I/O LED This indicates a problem with backplane communications. A problem
flashes could exist between the processor and any installed I/O module, not just
the MVI69E-MBTCP. Verify that all modules in the rack are correctly
configured.
Module Errors
Problem description Steps to take
BP ACT LED (not This indicates that backplane transfer operations are failing. Connect to
present on MVI56E the module’s Configuration/Debug port to check this.
modules) remains OFF To establish backplane communications, verify the following items:
or blinks slowly  The processor is in RUN or REM RUN mode.
MVI69 modules with  The backplane driver is loaded in the module.
scrolling LED display:
<Backplane Status>  The module is configured for read and write data block transfer.
condition reads ERR  The ladder logic handles all read and write block situations.
 The module is properly configured in the processor I/O configuration
and ladder logic.
OK LED remains RED The program has halted or a critical error has occurred. Connect to the
Configuration/Debug (or communication) port to see if the module is
running. If the program has halted, turn off power to the rack, remove the
card from the rack and re-insert it, and then restore power to the rack.

6.3 Connecting the PC to the Module's Ethernet Port

With the module securely mounted, connect one end of the Ethernet cable to the
ETH1 Port, and the other end to an Ethernet hub or switch accessible from the
same network as the PC. Or, connect directly from the Ethernet Port on the PC
to the ETH 1 Port on the module.
6.3.1 Setting Up a Temporary IP Address
Important: ProSoft Configuration Builder locates MVI69E-MBTCP modules through UDP

broadcast messages. These messages may be blocked by routers or layer 3 switches. In that
case, the ProSoft Discovery Service is unable to locate the modules.
To use ProSoft Configuration Builder, arrange the Ethernet connection so that there is no router/
layer 3 switch between the computer and the module, OR reconfigure the router/ layer 3 switch to
allow routing of the UDP broadcast messages.
1 In the tree view in ProSoft Configuration Builder (PCB), select the MVI69E-
MBTCP module. (For instructions on opening and using a project in PCB,
please refer to the chapter Configuring the MVI69E-MBTCP Using PCB
(page 42).

2 Right-click the module icon in the tree and choose DIAGNOSTICS.
3 In the Diagnostics window, click the SET UP CONNECTION button.
4 In the Connection Setup dialog box, click BROWSE DEVICE(S) to start ProSoft
Discovery Service. Right-click the module and choose ASSIGN TEMPORARY
IP.

5 The module’s default IP address is usually 192.168.0.250. Choose an unused

IP within your subnet, and then click OK.
Important: The temporary IP address is only valid until the next time the module is initialized. For
information on how to set the module’s permanent IP address, see Ethernet 1 (page 55) .
6 Close the ProSoft Discovery Service window. Enter the temporary IP address
in the Ethernet address field of the Connection Setup dialog box, then click
TEST CONNECTION to verify that the module is accessible with the current
settings.
7 If the Test Connection is successful, click CONNECT. The Diagnostics window
is now accessible. See Using the Diagnostics Menu in ProSoft Configuration
Builder (page 98) for more information.
6.4 Using the Diagnostics Menu in ProSoft Configuration Builder

ProSoft Configuration Builder (PCB) provides diagnostic menus for debugging
and troubleshooting.
To connect to the module’s Configuration/Debug Ethernet port
1 In the tree view in ProSoft Configuration Builder (PCB), select the MVI69E-
MBTCP module. For instructions on opening and using a project in PCB,
please refer to the chapter Configuring the MVI69E-MBTCP Using PCB
(page 42).

2 Right-click the module and choose DIAGNOSTICS.
3 After the Diagnostics window opens, click the SETUP CONNECTION button to
browse for the module’s IP address.
4 In the Ethernet field of the Connection Setup dialog box, enter the current IP
address, whether it is temporary or permanent. Click TEST CONNECTION to
verify that the module is accessible with the current settings.

5 If the TEST CONNECTION is successful, click CONNECT. The Diagnostics

Window is now accessible.
6.4.1 Diagnostics Menu

The DIAGNOSTICS menu in the Diagnostics window in ProSoft Configuration
Builder is available through the Ethernet configuration port. The menu is
arranged as a tree structure.

6.4.2 Monitoring General Information

In the Diagnostics window in ProSoft Configuration Builder, click MODULE and
then click VERSION to view module version information.
6.4.3 Monitoring Backplane Information

In the Diagnostics window in ProSoft Configuration Builder, click BACKPLANE
to view the backplane information:
 STATUS

6.4.4 Modbus Server Driver Information

In the Diagnostics window in ProSoft Configuration Builder, click SERVERS to
view the server information. The menu has two sub-menus:
 CONFIGURATION
 STATUS

6.4.5 Monitoring Data Values in the Module’s Database

In the Diagnostics window in ProSoft Configuration Builder, click DATABASE
and then click DECIMAL to view the contents of the MVI69E-MBTCP internal
database. You can view data values in ASCII, Hexadecimal, and Float format.
6.4.6 Modbus Client Driver Information

In the Diagnostics window in ProSoft Configuration Builder, click MBTCP
CLIENT X to view Modbus Client driver information, where X is the number of the
Modbus Client. The Modbus Client Driver menus have four submenus:
 CLIENT X CONFIGURATION
 CLIENT X STATUS
 CLIENT X COMMAND LIST
 CLIENT X COMMAND STATUS

6.5 Communication Error Codes
Note: If an error code is reported that is not listed below, check with the documentation of the
Modbus device(s) on the module's application ports. Modbus devices can produce device-specific
error codes.
6.5.1 Standard MODBUS Protocol Exception Code Errors

Code Description
1 Illegal Function Code
2 Illegal Data Address
3 Illegal Data Value
4 Failure in Associated Device
5 Acknowledge
6 Busy, Rejected Message
6.5.2 Module Communication Error Codes

Code Description
-1 CTS modem control line not set before transmit
-2 Timeout while transmitting message
-11 Timeout waiting for response after request
253 Incorrect slave address in response
254 Incorrect function code in response
255 Invalid CRC/LRC value in response
6.5.3 Command List Entry Errors

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

6.5.4 MBTCP Client-Specific Errors

Code Description
-33 Failed to connect to server specified in command
-36 MBTCP command response timeout
-37 TCP/IP connection ended before session finished
Note: If an error code is reported that is not listed above, check with the documentation of the end
device. Device-specific error codes can be produced by the end device.
6.6 Connecting to the MVI69E-MBTCP Webpage

The module’s internal web server provides access to module version and status
information, as well as the ability to set the date and time, reboot the module, and
download firmware upgrade to the module. Enter the assigned IP address of the
module into a web browser or use the following steps in PCB.
1 In the Diagnostics window in ProSoft Configuration Builder, click the SET UP
CONNECTION button.
2 In the Connection Setup dialog box, click BROWSE DEVICE(S) to start the
ProSoft Discovery Service.

3 Right-click the module icon and choose VIEW MODULE’S WEBPAGE to launch
your default browser and display the module’s webpage.

MVI69E-MBTCP ♦ CompactLogix Platform Reference
7 Reference
In This Chapter
 Product Specifications ......................................................................... 107
 About the Modbus TCP/IP Protocol ..................................................... 108
 Floating-Point Support ......................................................................... 121
 Function Blocks ................................................................................... 127
 Ethernet Port Connection .................................................................... 145
7.1 Product Specifications

The MVI69E-MBTCP allows Rockwell Automation® CompactLogix® processors to
interface easily with other Modbus TCP/IP compatible devices.
The module acts as an input/output communications module between the
Modbus TCP/IP network and the CompactLogix backplane. The data transfer
from the CompactLogix processor is asynchronous from the actions on the
Modbus TCP/IP network. Databases are user-defined and stored in the module
to hold the data required by the protocol.
 Single-slot, 1769 backplane-compatible
 The module is recognized as an Input/Output module and has access to
processor memory for data transfer between processor and module.
 Ladder Logic is used for data transfer between module and processor.
Sample Add-On Instruction file included.
 Configuration data obtained from and stored in the processor.
 Supports CompactLogix processors with 1769 I/O bus capability and at least
500 mA of 5 Vdc backplane current available.

Reference MVI69E-MBTCP ♦ CompactLogix Platform
7.1.1 General Specifications - Modbus Client/Server

Communication Supports Modbus MBAP and encapsulated (Server) messaging
Parameters 10/100 Base-T Ethernet-compatible interface
Modbus Modes Client driver supports up to twenty connections for active reading
and writing of data with Modbus TCP/IP compatible devices
Server driver supports connections to up to five Modbus TCP/IP

clients using Service Port 502 with standard MBAP messaging,
and up to five clients using Modbus RTU/ASCII on Service Port
2000 (and others)
Floating-Point Floating-point data movement supported, including configurable
Data support for Enron, Daniel®, and other implementations
Modbus Function 1: Read Coil Status 15: Force( Write) Multiple Coils
Codes Supported 2: Read Input Status 16: Preset (Write) Multiple
3: Read Holding Registers Holding Registers
4: Read Input Registers 17: Report Slave ID (Server
5: Force (Write) Single Coil Only)
6: Preset (Write) Single 22: Mask Write Holding
Holding Register Register (Server Only)
8: Diagnostics (Server Only, 23: Read/Write Holding
Responds to Registers (Server Only)
Subfunction 00)
7.1.2 Hardware Specifications

Specification Description
Dimensions Standard 1769 Single-slot module
Current Load 500 mA max @ 5 VDC
Power supply distance rating of 2 (L43 and L45
installations on first 2 slots of 1769 bus)
Operating Temp. 32° F to 140° F (0° C to 60°C)
Storage Temp. -40° F to 185° F (-40° C to 85° C)
Relative Humidity 5% to 95% (with no condensation)
LED Indicators Module OK Status
Backplane Activity
Ethernet Port Activity
Configuration Activity
Application/Diagnostics Port Diagnostics over Ethernet connection RJ45 Port
(ETH 1)
Shipped with Unit RL-CBL025 Ethernet straight-though cable

7.2 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 MVI69E-MBTCP module
simulates up to 30 clients, and works both as a client and 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 an Internet
connection. It is important to note that not all Internet protocols are implemented
in the module; for example, HTTP and SMTP protocols are not available.
Nevertheless, the efficiency, scalability, and low cost of a Modbus TCP/IP
network make this an ideal solution for industrial applications.
The MVI69E-MBTCP module acts as an input/output module between devices on
a Modbus TCP/IP network and the Rockwell Automation backplane and
processor. 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.
7.2.1 Modbus Client

The MVI69E-MBTCP Modbus client actively issues Modbus commands to
Modbus servers on the Modbus TCP/IP network, supporting up to 16 commands
for each client. The clients have an optimized polling characteristic that polls
servers with communication problems less frequently.
Command List Up to 16 commands per client, each fully configurable for function,
server IP address, register to/from addressing and word/bit count.
Polling of command list Configurable polling of command list, including continuous and on
change of data, and dynamically user or automatic enabled.
Status Data Error codes available on an individual command basis. In addition,
a server status list is maintained per active Modbus client.

7.2.2 Modbus Server

The MVI69E-MBTCP Modbus Server driver 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 processor.
Service Port MBAP messaging on Service Port 502

Encapsulated messaging on Service Port 2000
Status Data Error codes, counters and port status available
7.2.3 Function Codes 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 Function Codes supported by the
Function Code Definition Supported as Client Supported as Server
1 Read Coil Status 0x X X
2 Read Input Status 1x X X
3 Read Holding Registers 4x X X
4 Read Input Registers 3x X X
5 Set Single Coil 0x X X
6 Single Register Write 4x X X
8 Diagnostics X
15 Multiple Coil Write 0x X X
16 Multiple Register Write 4x X X
17 Report Server ID 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 server
device.

7.2.4 Read Coil Status (Function Code 01)
Query
This function allows you to obtain the ON/OFF status of logic coils (Modbus 0x
range) 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 are 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 (37 coils) from server device number 11.
Note: This is the structure of the message being sent out to the Modbus network. The byte values
below are in hexadecimal display
Node Function Data Start Data Start Number of Number of Error Check
Address Code Point High Point Low Points High Points Low Field (2 bytes)
0B 01 00 13 00 25 CRC
Response
An example response to Read Coil Status is as shown in the table below. 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 is 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
follows. For coil quantities that are not even multiples of eight, the last characters
are 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 reflects coil status at the end of the scan. Some servers 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.
Node Func Byte Data Coil Data Coil Data Coil Data Coil Data Coil Error Check
Address Code Count Status 20 Status 28 Status 36 Status 44 Status 52 Field
to 27 to 35 to 43 to 51 to 56 (2 bytes)
0B 01 05 CD 6B B2 OE 1B CRC

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

from left to right, this shows that coils 27, 26, 23, 22, and 20 are all on. The other
Data Coil Status 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.
7.2.5 Read Input Status (Function Code 02)
Query
This function allows you to obtain the ON/OFF status of discrete inputs (Modbus
1x range) 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 are 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 (22 coils) from server number 11.
below are in hexadecimal display.
Node Function Data Start Data Start Number of Number of Error Check
Address Code Point High Point Low Points High Points Low Field (2 bytes)
0B 02 00 C4 00 16 CRC
Response
An example response to Read Input Status is as shown in the table below. 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 is 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
follows. For input quantities that are not even multiples of eight, the last
characters are 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,
the data reflect input status at the end of the scan. Some servers 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.
Node Func Byte Data Discrete Data Discrete Data Discrete Error Check
Address Code Count Input 10197 to Input 10205 to Input 10213 to Field
10204 10212 10218 (2 bytes)
0B 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.
7.2.6 Read Holding Registers (Function Code 03)
Query
This function allows you to retrieve the contents of holding registers 4xxxx
(Modbus 4x range) 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 retrieving up to 125 registers at each
request; however, the specific server device may have restrictions 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 (three registers) from
server number 11.
Node Function Data Start Data Start Data Number Data Number Error Check
Address Code Registers Registers Low of Registers of Registers Field
High High Low (2 bytes)
0B 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 reflect the register content at the end of the scan.
Some servers limit the quantity of register content provided each scan; thus for
large register quantities, multiple transmissions are 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.
Node Function Byte High Low High Low High Low Error Check
Address Code Count Data Data Data Data Data Data Field
(2 bytes)
0B 03 06 02 2B 00 00 00 64 CRC
7.2.7 Read Input Registers (Function Code 04)
Query
This function retrieves the contents of the controller's input registers from the
Modbus 3x range. 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 retrieving up to 125 registers 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 30009 in server number 11.
Node Function Data Start Data Start Data Number Data Number Error Check
Address Code Point High Point Low of Points High of Points Low Field
(2 bytes)
0B 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 reflect the register content at the end of the scan. Each PC limits
the quantity of register contents provided each scan; thus for large register
quantities, multiple PC scans are required, and the data provided is from
sequential scans.
In the example below the register 30009 contains the decimal value 0.
Node Function Byte Count Data Input Data Input Error Check
Address Code Register High Register Low Field
(2 bytes)
0B 04 02 00 00 E9
7.2.8 Force Single Coil (Function Code 05)
Query
This Function Code forces a single coil (Modbus 0x range) 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) sets the coil ON and the value zero turns it OFF; all other values are
illegal and do not affect that coil.
The use of server address 00 (Broadcast Mode) forces all attached servers to
modify the desired coil.
Note: Functions 5, 6, 15, and 16 are the only messages that are recognized as valid for broadcast.
The example below is a request to server number 11 to turn ON coil 0173.
Node Function Data Start Bit Data Start Bit Number of Number of Error Check
Address Code High Low Bits High Bits Low Field (2 bytes)
0B 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.
Node Function Data Coil Bit Data Coil Bit Data On/Off Data Error Check
Address Code High Low Field (2 bytes)
0B 05 00 AC FF 00 CRC
The forcing of a coil via Modbus function 5 happens regardless of whether the
addressed coil is disabled or not (In ProSoft products, the coil is only affected if
you implement the necessary ladder logic).
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 is "hot".
7.2.9 Preset Single Register (Function Code 06)
Query
This Function Code allows you to modify the contents of a Modbus 4x range in
the server. This writes to a single register only. 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
load the specified register with the contents specified.
Note Functions 5, 6, 15, and 16 are the only messages that are recognized as valid for broadcast.

The example below is a request to write the value ‘3’ to register 40002 in server
11.
Node Function Data Start Bit Data Start Preset Data Preset Data Error Check
Address Code High Bit Low Register High Register Low Field (2 bytes)
0B 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.
Node Function Data Register Data Register Preset Data Preset Data Error Check
Address Code High Low Register High Register Low Field (2 bytes)
0B 06 00 01 00 03 CRC
7.2.10 Diagnostics (Function Code 08)

This function 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 commands 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
monitors 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 MVI69E-MBTCP 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
The data fields in responses to other kinds of queries could contain error counts
or other data requested by the sub-function code.

7.2.11 Force Multiple Coils (Function Code 15)
Query
This function forces each coil (Modbus 0x range) 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) forces 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
are 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.
Node Function Coil Coil Number of Number of Byte Force Force Error Check
Address Code Address Address Coils High Coils Low Count Data High Data Low Field (2 bytes)
High Low 20 to 27 28 to 29
0B 0F 00 13 00 0A 02 CD 01 CRC
Response
The normal response is an echo of the server address, function code, starting
address, and quantity of coils forced.
Node Function Coil Coil Number of Number of Error Check

Address Code Address Address Coils High Coils Low Field (2 bytes)
High Low
0B 0F 00 13 00 0A CRC

Writing to coils with Modbus function 15 is accomplished regardless of whether

the addressed coils are disabled or not.
Coils that are not programmed 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 is
hot.
7.2.12 Preset Multiple Registers (Function Code 16)
Query
This Function Code allows you to modify the contents of a Modbus 4x range in
the slave. This writes up to 125 registers at time. Since the controller is actively
scanning, it also can alter the content of any holding register at any time.
Note: Function codes 5, 6, 15, and 16 are the only messages that are recognized as valid for
broadcast.
The example below is a request to write 2 registers starting at register 40002 in

slave 11.
Node Function Data Start Data Start Number Number Byte Data Data Data Data Error
Address Code Address Address of Points of Points Count High Low High Low Check
High Low High Low Field (2
bytes)
0B 10 00 01 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.
Node Function Data Start Data Start Number Number Error Check
Address Code Address Address of Points of Points Field (2 bytes)
High Low High Low
0B 10 00 01 00 02 CRC

7.3 Floating-Point Support

You can easily move floating point data between the MBTCP module and other
devices as long as the device supports IEEE 754 Floating Point format. This
IEEE format is a 32-bit single-precision floating-point format.
The logic necessary to move the floating-point data takes advantage of the COP
instruction in RSLogix 5000. The COP instruction is unique for data movement
commands in that it is an untyped function, meaning that no data conversion is
done when data is moved between controller tags with different data types (that
is, it is an image copy, not a value copy).
The COP instruction to move data from a floating-point controller tag into an
integer controller tag (something you would do to move floating-point values to
the module) is shown below.
This instruction moves one floating-point value in two 16-bit integer images to
MBTCP.DATA.WriteData[0], which is an integer tag. For multiple floating-point
values increase the Length field by a factor of 2 per floating-point value.
The COP instruction to move data from MBTCP.DATA.ReadData[0], which is an
integer tag, to a floating-point tag (something you would do to receive floating-
point values from the module) is shown below.
This instruction moves two 16-bit integer registers containing one floating point
value image into the floating-point tag. For multiple values increase the Length
field.

7.3.1 ENRON Floating Point Support

Many manufacturers have implemented special support in their drivers for what is
commonly called the Enron version of the Modbus protocol. In this
implementation, addresses greater than 7000 are presumed to contain floating-
point values. The significance to this is that the count descriptor for a data
transfer now denotes the number of floating-point values to transfer, instead of
the number of words.
7.3.2 Configuring the Floating Point Data Transfer

A common question is how to handle floating-point data when using the module
as a Modbus client. This really depends on the server device and how it
addresses this application.
Just because your application is reading or writing floating-point data, does not
mean that you must configure the Float Flag, Float Start, and Float Offset
parameters within the module.
These parameters are only used to support what is typically referred to as Enron
or Daniel Modbus, where one register address must have 32 bits, or one floating
point value. Below is an example:
Example #1
Modbus Address Data Type Parameter
47101 32 bit REAL TEMP Pump #1
47102 32 bit REAL Pressure Pump #1
With the module configured as a client, you only need to enable these
parameters to support a write to this type of addressing (Modbus FC 6 or 16).
If the server device uses addressing as shown in Example #2, then you do not
need to do anything with the Float Flag or Float Start parameters, as this
addressing scheme uses two Modbus addresses to represent each floating-point
value:
Example #2
Modbus Address Data Type Parameter
Because each 32 bit REAL value is represented by two Modbus addresses
(example 47101 and 47102 represent TEMP Pump #1), then you do not need to
set the Float Flag, or Float Start for the module for Modbus FC 6 or 16
commands being written to the server.
The next few pages show three specific examples:

Example #1: Client is issuing Modbus command with FC 16 (with Float Flag: Yes) to transfer
Float data to server.
(Float specific module parameters)

Float Flag: "Y" tells the client to consider the data values that need to be sent to
the server as floating point data where each data value is composed of 2 words
(4 bytes or 32 bits).
Float Start - Tells the client that if this address number is less than or equal to
the address number in Addr in Dev parameter to double the byte count quantity
to be included in the Command FC6 or FC16 to be issued to the server.
Otherwise the client ignores the Float Flag: Y and treat data as composed of 1
word, 2 bytes.
(Modbus Command parameters)

DB Addr - Tells the client the beginning of data in its database to obtain and
write out to the server device.
Reg Count - Tells the client how many data points to send to the server. Two
counts mean two floating points with Float Flag: Y and the Addr in Dev greater
than or equal to the Float Start Parameter.
Swap Code - Tells the client how to orient the Byte and Word structure of the
data value. This is device dependent. See MBTCP Client x Commands (page
51).
Func Code - Tells the client to write the float values to the server. FC16.
Addr in Dev - Tells the client where in the server's database to locate the data.

In the above example, the client's Modbus command to transmit inside the
Modbus packet is as follows.
Server Function Address in Reg Count Byte Count Data
Address Code Device
DEC 01 16 7100 2 8 85.37 22.86
HEX 01 10 1B BC 00 02 08 BD 71 42 AA E1 48 41 B6
In this example, the client's Modbus packet contains the data byte and data word
counts that have been doubled from the amount specified by Reg Count due to
the Float flag set to Y. Some servers look for the byte count in the data packet to
know the length of the data to read from the wire. Other servers know at which
byte the data begins and read from the wire the remaining bytes in the packet as
the data the client is sending.
Example #2: client is issuing Modbus command with FC 16 (with Float Flag: No) to transfer
Float data.
Float Flag: "N" tells the client to ignore the floating values and treat each
register data as a data point composed of 1 word, 2 bytes or 16 bits.
Float Start: Ignored.
DB Addr - same as when Float Flag: Y.
Reg Count - Tells the client how many data points to send to the server.
Swap Code - same as when Float Flag: Y.
Func Code - same as when Float Flag: Y.
Addr in Dev - same as when Float Flag: Y as long as the server's Float Flag = Y.

Server Function Address in Reg Byte Data
Address Code Device Count Count
DEC 01 16 7100 2 4 85.37
HEX 01 10 1B BC 00 02 04 BD 71 42 AA
In this example, the client's Modbus packet contains the data byte and data word
counts that have NOT been doubled from the amount specified by Reg Count
due to the Float Flag set to N. The server looks for the byte count in the data
packet to know the length of the data to read from the wire. Because of
insufficient byte count, some servers read only half the data from the client's
transmission. Other servers read all 8 bytes in this example because they know
where in the packet the data starts and ignore the byte count parameter inside
the Modbus packet.
Example #3: client is issuing Modbus command with FC 3 to transfer Float data from server.
Float Flag: Not applicable with Modbus Function Code 3.

Float Start: Not applicable with Modbus Function Code 3.
DB Addr - Tells the client where in its data memory to store the data obtained
from the server.
Reg Count - Tells the client how many registers to request from the server.
Swap Code - same as above.
Func Code - Tells the client to read the register values from the server. FC3.
Addr in Dev - Tells the client where in the server's database to obtain the data.

Server Function Code Address in Device Reg Count
Address
DEC 01 3 6100 2
HEX 01 03 17 D4 00 02
In the above example the (Enron/Daniel supporting) server's Modbus command
to transmit inside the Modbus packet is as follows.
Server Address Function Code Byte Count Data
DEC 01 3 8 32.75 275.69
HEX 01 03 08 00 00 42 03 D8 52 43 89
In the above example the (a NON-Enron/Daniel supporting) server's Modbus
command that is transmitted inside the Modbus packet is as follows.
Server Address Function Code Byte Count Data
DEC 01 3 4 32.75
HEX 01 03 04 00 00 42 03

7.4 Function Blocks

Data contained in this database is paged through the input and output images by
coordination of the CompactLogix ladder logic and the MVI69E-MBTCP module's
program. Each block transferred from the module to the processor or from the
processor to the module contains a block identification code that describes the
content of the block.
Block ID Range Description

-1000 to -1166 Get input image data for initialization
-1 to -999 Dummy block
0 Read or write data for small data sets
1 to 167 Read or write data blocks
2000 to 2019 Event Command blocks
3000 to 3019 Client status request/response blocks
4000 to 4019 Event Sequence Command blocks
4100 to 4119 Event Sequence Command Error Status blocks
4200 Get queue and event sequence block counts
5001 to 5016 Command Control blocks
8000 to 8019 Add Event with data for a client
8100 Get Event with data status
9250 Get general module status data
9500 Set driver and command active bits
9501 Get driver and command active bits
9956 Pass-Through formatted block for functions 6 and 16 with word data
9957 Pass-Through formatted block for functions 6 and 16 with float data
9958 Pass-Through formatted block for function 5
9970 Pass-Through block for function 99
9972 Set module time using received time
9973 Pass module time to processor
9997 Reset status block
9998 Warm-boot control block
9999 Cold-boot control block

7.4.1 Event Command Blocks (2000 to 2019)

Event Command blocks send Modbus commands directly from the ladder logic to
the specified MBTCP Client x. The Event Command is added to the high-priority
queue and interrupts normal polling so this special command can be sent as
soon as possible.
Note: Overusing Event Commands may substantially slow or totally disrupt normal polling. Use
Event Commands sparingly. Event Commands are meant to be used as one-shot commands
triggered by special circumstances or uncommon events.
Blocks 2000 to 2019: Request from Processor to Module

Offset Description
0 Block ID 2000 to 2019 indicates this block contains a command to execute by the
Client Driver. The last two digits indicate which client to use.
Example: ‘2015’ utilizes client 15
1 to 4 IP address for the intended server for the message. Each digit (0 to 255) of the IP
address is placed in one of the four registers
5 TCP service port to use with the message
6 Modbus node address to use with the message
7 Internal Modbus address in the module to use
8 Count parameter that determines the number of digital points or registers to
associate with the command
9 Swap type for integer data only
10 Modbus function code
11 Modbus address in the slave device associated with the command
12 to (n-1) Spare
Where n = 60, 120, or 240 depending on the Block Transfer Size parameter.
Blocks 2000 to 2019: Response from Module to Processor

Offset Description
0 Block ID 2000 to 2019 requested by the processor
1 The next read request block identification code
2 Result of the event request.
1=the command was placed in the command queue.
0= No room was found in the command queue.
-1=The client is not enabled and active.
3 Number of commands in queue
4 to (n-1) Spare

7.4.2 Client Status Request/Response Blocks (3000 to 3019)

These blocks request the status of a specific MVI69E-MBTCP client.
Block 3000 or 3019: Request from Processor to Module

Offset Description
0 Block ID 3000 to 3019 identification code indicates this block requests the
status from a specific MVI69E-MBTCP client. The last two digits indicate
which client to use.
Example: 3015 uses client 15
1 to (n-1) Spare
Block 3000 to 3019: Response from Module to Processor

Offset Description
1 Write Block ID
2 to 11 Client status data
12 to 27 Command error list data for client
28 to (n-1) Spare

7.4.3 Event Sequence Request Blocks (4000 to 4019)

These 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 x Command List in ProSoft Configuration Builder.
Block 4000 to 4019: Request from Processor to Module

Offset Description
0 Block ID 4000 to 4019 indicates this block triggers the event sequence of the
MVI69E-MBTCP client. The last two digits indicate which client to use.
1 to 4 IP address for the intended server for the message. Each digit (0 to 255) of the IP
address is placed in one of the four registers
5 TCP service port for message
6 Modbus node address for the message
7 Internal Modbus address in the module
8 Count parameter that determines the number of digital points or registers to
associate with the command
9 Swap type for integer data only
10 Modbus function code
11 Modbus address in the slave device for the command
12 Sequence number
13 to (n-1) Spare

Offset Description
1 Write Block ID
2 0=Fail
1=Success
-1=Client is not enabled and active
4 to (n-1) Spare

7.4.4 Event Sequence Command Error Status Blocks (4100 to 4119)

This block displays the result of each command sent to the client. The request
includes the client identification and the command sequence number. The
response is the event count and error code for each event. A value of ‘0’ in the
error code means there was no error detected.

Offset Description
0 Block ID 4100 to 4119 indicates this block triggers the event sequence command
error status request of a specific MVI69E-MBTCP client. The last two digits indicate
which Client client to use.
1 to (n-1) Spare

Offset Description
1 Write Block ID
2 Number of Event Sequence Messages in block (0 to 15)
3 Sequence Number
4 Return Error Code
5 Sequence Number
6 Return Error Code
7 Sequence Number
8 Return Error Code
… …
… …
31 Sequence Number
32 Return Error Code
33 to (n-1) Spare

7.4.5 Get Queue and Event Sequence Block Counts Block (4200)
This block requests the command queue count and the number of pending event
sequence commands for all module clients.
Block 4200: Request from Processor to Module

Offset Description
0 Block ID 4200
1 to (n-1) Spare
Block 4200: Response from Module to Processor

Offset Description
0 Block ID 4200
1 Write Block ID
2 Client 0 command queue count (MSB Most Significant Byte) and event sequence
messages waiting (LSB Least Significant Bit)
… …
22 to (n-1) Spare
7.4.6 Command Control Blocks (5001 to 5016)

Command Control blocks place commands into the module’s command priority
queue. Unlike Event Command blocks, which contain all the values needed for
one command, Command Control is used with commands already defined in the
MNET Client x Command List in ProSoft Configuration Builder.

Offset Description
0 Command queue block identification code of 5001 to 5016
1 Client index (0 to 19) to be used
2 Command Index in the command list for the first command to be entered into the
command queue
3 to 17 Command indexes of the next commands to be placed in the command queue
18 to (n-1) Spare


Offset Description
0 Command queue block identification code of 5001 to 5016
1 The next write block ID
2 Client index (0 to 19) to be used
3 Number of commands in the block placed in the command queue. Return values:
-2 = Client index is not valid.
-1 = Client is not enabled and active.
5 to (n-1) Spare
7.4.7 Add Event with Data for Client Blocks (8000)

The 8000-series blocks are similar to the 2000-series Event Command blocks.
The 8000-series blocks get the command data from the processor, instead of
from the module’s database. These blocks use "write" Modbus Function Codes
(5, 6, 15, 16) only.

Offset Description
0 Block ID 8000 indicates this block adds an event with data of a specific MVI69E-
MBTCP client. The last two digits indicate which client to use.
1 to 4 IP address for the server for the message. Each digit (0 to 255) of the IP address is
placed in one of the four registers.
5 TCP service port to use with the message
6 Modbus node address to use with the message
7 Modbus Function Code: 5, 6, 15 or 16 only
8 Modbus address in the slave device to associate with the command
9 Count value for operation: bit count for function 15 (1 to 800 points) and word count
for function 16 (1 to 50 words or 1 to 25 float values). For functions 5 and 6, the
count is assumed to be 1.
10 to 59 Data values to be used by the command
60 to (n-1) Spare


Offset Description
0 Block ID 8000 for event command with data request
2 Error Code for request:
0 = No error
-1 = Client is not enabled
-3 = Client is not active
-4 = Client busy with previous event command
-5 = Invalid Modbus command
-6 = Invalid point count for command
3 to (n-1) Spare
7.4.8 Get Event with Data Status Block (8100)

This block requests status data for Event with Data Commands.

Offset Description
0 Block ID 8100 status data request for Event with Data Commands.
1 to (n-1) Spare

Offset Description
0 Block ID 8100 status data for Event with Data Commands
2 Number of client records contained in block (0-19)
3 Client Index (0-19)
4 Error code for last command executed for client
5 Client Index (0-19)
6 Error code for last command executed for client
7 to 42 Data for other clients being reported
43 to (n-1) Spare

7.4.9 Get General Module Status Data Block (9250)

This block requests general module status.

Offset Description
0 Block ID 9250 to request the general module status response block

Offset Description
0 Block ID 9250 requested by processor
2 Program Scan Count: this value is incremented each time a complete program cycle
occurs in the module.
3 to 4 Product Code: these two registers contain the product code of "MB6E" for the
5 to 6 Product Version: these two registers contain the product version for the current
running software
7 to 8 Operating System: these two registers contain the month and year values for the
program operating system.
9 to 10 Run Number: these two registers contain the run number value for the currently
running software.
11 Read Block Count: total number of read blocks transferred from the module to the
processor.
12 Write Block Count: total number of write blocks transferred from the processor to the
module.
13 Parse Block Count: total number of blocks successfully parsed that were received
from the processor.
14 Event Command Block Count: total number of Event Command blocks received
from the processor.
15 Command Block Count: total number of command blocks received from the
processor.
16 Error Block Count: Total number of block errors recognized by the module.
17 Client 0 command execution word: each bit in this word enables/disables the
commands for client 0. If the bit is set, the command executes. If the bit is clear, the
command is disabled
18 to 36 Client 1 to client 19 command execution words
37 to 38 Event Sequence Ready: bit mapped -1 bit for each client 0-19
Bit=0: No event sequence status data ready
Bit=1: Event seq. status data ready
39 Encapsulated Modbus TCP/IP request count: this counter increments each time the
module receives an Encapsulated Modbus TCP/IP (Service Port 2000) request from
a remote Modbus TCP/IP client,
40 Encapsulated Modbus TCP/IP response count: this counter increments each time
an Encapsulated Modbus TCP/IP (Service Port 2000) response is sent back to a
remote Modbus TCP/IP client command.

Offset Description
41 Encapsulated Modbus TCP/IP error sent: this counter increments each time the
server sends an error to the remote Modbus TCP/IP client.
42 Encapsulated Modbus TCP/IP error received: this counter increments each time an
error is received from a remote Modbus TCP/IP client.
43 Modbus MBAP request count: this counter increments each time an MBAP (Service
Port 502) request is received from a remote Modbus TCP/IP client.
44 Modbus MBAP response count: this counter increments each time an MBAP
(Service Port 502) response is sent back to a remote Modbus TCP/IP client
command.
45 Modbus MBAP error sent: this counter increments each time the server sends an
error to the remote MBAP Modbus TCP/IP client.
46 Modbus MBAP error received: this counter increments each time an error is
received from a remote MBAP Modbus TCP/IP client
47 to (n-1) Spare
7.4.10 Set Driver and Command Active Bits Block (9500)

This block enables and disables the Modbus TCP/IP clients and servers of the
module.
Offset Description
0 Block ID 9500 to set server and client enable/disable state
1 Server active state
0=Disabled
1=Enabled
2 Client 0 to client 15 bit map for active status of clients
3 Client 16 to client 19 bit map for active status of clients
4 to 23 Client 0 to client 19 command active bits. One word for each client with each bit
used to turn on and off the commands for the client.
0=Disabled
1=Enabled
24 to (n-1) Spare

Offset Description
0 Block ID 9500 requested by processor
2 to (n-1) Spare

7.4.11 Get Driver and Command Active Bits Block (9501)

This block requests the active state of MBTCP Driver and Client commands.

Offset Description
0 Block ID 9501 to get MBTCP Driver and command active status
1 to (n-1) Spare

Offset Description
0 Block ID 9501 requests the active state of MBTCP Driver and Client commands
2 Server active state
0=disabled
1=enabled
3 Client 0 to 15 bit map for active status of clients
4 Client 16 to 19 bit map for active status of clients
5 to 24 Client 0 to client 19 command active bits. One word for each client with each bit
used to turn on and off the commands for the client.
0=Disabled
1=Enabled
25 to (n-1) Spare

7.4.12 Pass-Through Formatted Block for Functions 6 and 16 with

Word Data Block (9956)
If the server port on the module is configured for formatted Pass-Through mode,
the module sends input image blocks with identification codes of 9956, 9957,
9958 or 9959 to the processor for each write command received. Any incoming
Modbus Function 5, 6, 15 or 16 command is passed from the port to the
processor using a block identification number that identifies the Function Code
received in the incoming command.
The MBTCP Add-On Instruction handles the receipt of all Modbus write functions
and responds as expected to commands issued by the remote Modbus client
device.
Note: Mutual exclusion on Pass-Through Block IDs 9956, 9957, 9958, and 9959 from all server
connections. When multiple server connections are active and they receive write commands with
the same Function Code, the same block identifier from the above list is needed. The module
processes the command from the server which first received a command.
The module returns an Exception Code error code 6 (Node is busy - retry command later error)
from the other server that received the command last. The client retries the command on the busy
port after a short delay. This prevents Pass-Through blocks on multiple servers from overwriting
each other.
Block 9956: Request from Module to Processor

Offset Description
0 Read Block ID 9956
1 Write Block ID 9956
2 Number of word registers in the Modbus data set
3 Starting address for the Modbus data set
4 to 53 Modbus Data
54 to (n-1) Spare
The ladder logic is responsible for parsing and copying the received message
and performing the proper control operation as expected by the client device.
The processor must then respond to the Pass-Through control block with an
output image write block with the following format. This informs the module that
the command has been processed and can be cleared from the Pass-Through
queue.
Block 9956: Response from Processor to Module

Offset Description
1 to (n-1) Spare

7.4.13 Pass-Through Formatted Block for Functions 6 and 16 with

Float Data Block (9957)

Offset Description
2 Number of word registers in Modbus data set
3 Starting address for Modbus data set
4 to 53 Modbus Data
54 to (n-1) Spare
The processor must then respond to the Pass-Through block with a write block
with the following format. This informs the module that the command has been
processed and can be cleared from the Pass-Through queue.

Offset Description
1 to n Spare (Length in words = n - 2)
7.4.14 Pass-Through Formatted Block for Function 5 (9958)

Offset Description
1 Write Block ID: 9958
2 Number of word registers in the Modbus data set
3 Starting address for the Modbus data set
4 to 53 Modbus Data
54 to (n-1) Spare

queue.

Offset Description

When the module receives a function code 15 in Pass-Through mode, the
module writes the data using block ID 9959 for multiple-bit data. First the bit
mask clears the bits to be updated. This is accomplished in RSLogix 5000 by
ANDing the inverted mask with the existing data.
Next, the new data ANDed with the mask is ORed with the existing data. This
protects the other bits in the INT registers from being affected. This function can
only be used if the Block Transfer Size parameter is set to 120 or 240 words.

Offset Description
2 Length in words
3 Data address
4 to 28 Modbus Data
29 to 53 Bit mask to use with the data set. Each bit to be considered with the data set have
a value of 1 in the mask. Bits to ignore in the data set have a value of 0 in the
mask.
54 to (n-1) Spare
The processor must then respond to the Pass-Through control block with a write
block with the following format. This informs the module that the command has
been processed and can be cleared from the Pass-Through queue.


Offset Description
1 to n Spare

Offset Description
2 Number of word registers in Modbus data set
3 Starting address for Modbus data set
4 to 53 Modbus Data
54 to (n-1) Spare
queue.

Offset Description
7.4.17 Pass-Through Block for Function 99 (9970)

Offset Description
2 1
3 0
4 to (n-1) Spare data area

queue.

Offset Description
7.4.18 Set Module Time Using Received Time Block (9972)

This block uses the time information of the processor to set the module time.

Offset Description
0 Block ID 9972
1 Year (0-9999)
2 Month (1-12)
3 Day (1-31)
4 Hour (0-23)
5 Minutes (0-59)
6 Seconds (0-59)
7 Milliseconds (0-999)
8 to (n-1) Spare

Offset Description
0 Block ID 9972
1 Write Block ID
Return code:
0=OK
2 -1=error
3-n Spare

7.4.19 Pass Module Time to Processor Block (9973)

This block uses the time information of the module to set the processor time.

Offset Description
0 Block ID 9973
1-n Spare

Offset Description
0 Block ID 9973
1 Write Block ID
2 Year (0-9999)
3 Month (1-12)
4 Day (1-31)
5 Hour (0-23)
6 Minutes (0-59)
7 Seconds (0-59)
8 Milliseconds
9 to (n-1) Spare
7.4.20 Reset Status Block (9997)

This block resets the module, port 1, and/or port 2 status.

Offset Description
0 Block ID 9997
Reset Module status:
1 0=no, else yes
Reset Port 1 status:
2 0=no, else yes
Reset Port 2 status:
3 0=no, else yes
4 to (n-1) Spare


Offset Description
0 Block ID 9997
1 Write Block ID
2-n Spare
7.4.21 Warm-boot Control Block (9998)

If the CompactLogix sends a block number 9998, the module performs a warm-
boot operation. The module reconfigures the communication ports and reset the
error and status counters.

Offset Description
0 Block ID 9998
1 to (n-1) Spare
7.4.22 Cold-boot Control Block (9999)

If the CompactLogix processor sends a block number 9999, the firmware
performs a cold-boot operation. The firmware reloads the configuration file from
the processor to the module and resets all MBTCP memory, error and status
data.

Offset Description
0 Block ID 9999
1 to (n-1) Spare

7.5 Ethernet Port Connection
7.5.1 Ethernet Cable Specifications

The recommended cable is Category 5 or better. A Category 5 cable has four
twisted pairs of wires, which are color-coded and cannot be swapped. The
module uses only two of the four pairs.
The Ethernet port or ports on the module are Auto-Sensing. You can use either a
standard Ethernet straight-through cable or a crossover cable when connecting
the module to an Ethernet hub, a 10/100 Base-T Ethernet switch, or directly to a
PC. The module detects the cable type and uses the appropriate pins to send
and receive Ethernet signals.
Some hubs have one input that can accept either a straight-through or crossover
cable, depending on a switch position. In this case, you must ensure that the
switch position and cable type agree.
Refer to Ethernet Cable Configuration (page 145) for a diagram of how to
configure Ethernet cable.
Ethernet Cable Configuration
Note: The standard connector view shown is color-coded for a straight-through cable.
Crossover cable Straight- through cable

RJ-45 PIN RJ-45 PIN RJ-45 PIN RJ-45 PIN
1 Rx+ 3 Tx+ 1 Rx+ 1 Tx+
2 Rx- 6 Tx- 2 Rx- 2 Tx-
3 Tx+ 1 Rx+ 3 Tx+ 3 Rx+
6 Tx- 2 Rx- 6 Tx- 6 Rx-

Ethernet Performance
Ethernet performance in the MVI69E-MBTCP module can be affected in the
following way:
 Accessing the web interface (refreshing the page, downloading files, and so
on) may affect performance
 Also, high Ethernet traffic may impact MBTCP performance, so consider one
of these options:
o Use managed switches to reduce traffic coming to module port
o Use CIPconnect for these applications and disconnect the module
Ethernet port from the network

MVI69E-MBTCP ♦ CompactLogix Platform Support, Service & Warranty
8 Support, Service & Warranty
In This Chapter
 Contacting Technical Support ............................................................. 147
 Warranty Information ........................................................................... 148
8.1 Contacting Technical Support

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

Support, Service & Warranty MVI69E-MBTCP ♦ CompactLogix Platform
Internet Website: www.prosoft-technology.com/support

E-mail address: support@prosoft-technology.com
Asia Pacific Tel: +603.7724.2080
(location in Malaysia) E-mail: asiapc@prosoft-technology.com
Languages spoken include: Chinese, English
Asia Pacific Tel: +86.21.5187.7337 x888
(location in China) E-mail: asiapc@prosoft-technology.com
Languages spoken include: Chinese, English
Europe Tel: +33 (0) 5.34.36.87.20
(location in Toulouse, E-mail: europe@prosoft-technology.com
France) Languages spoken include: French, English
Europe Tel: +971-4-214-6911
(location in Dubai, UAE) E-mail: mea@prosoft-technology.com
Languages spoken include: English, Hindi
North America Tel: +1.661.716.5100
(location in California) E-mail: support@prosoft-technology.com
Languages spoken include: English, Spanish
Latin America Tel: +1-281-2989109
(Oficina Regional) E-Mail: latinam@prosoft-technology.com
Languages spoken include: Spanish, English
Latin America Tel: +52-222-3-99-6565
(location in Puebla, Mexico) E-mail: soporte@prosoft-technology.com
Languages spoken include: Spanish
Brasil Tel: +55-11-5083-3776
(location in Sao Paulo) E-mail: brasil@prosoft-technology.com
Languages spoken include: Portuguese, English
8.2 Warranty Information

For complete details regarding ProSoft Technology’s TERMS & CONDITIONS
OF SALE, WARRANTY, SUPPORT, SERVICE AND RETURN MATERIAL
AUTHORIZATION INSTRUCTIONS please see the documents at:
www.prosoft-technology/legal.
Documentation is subject to change without notice.

MVI69E-MBTCP ♦ CompactLogix Platform Support, Service & Warranty
Downloading the Configuration File to the Processor •

57
E
Index Editing Configuraiton Parameters • 44
ENRON Floating Point Support • 122
0 Ethernet 1 • 55, 98
Ethernet Cable Configuration • 145
00 Return Query Data • 117 Ethernet Cable Specifications • 145
Ethernet LED Indicators • 93
A Ethernet Performance • 146
Ethernet Port Connection • 145
About the Modbus TCP/IP Protocol • 109
Event Command Blocks (2000 to 2019) • 128
Add Event with Data for Client Blocks (8000) • 133
Event Sequence Command Error Status Blocks (4100
Adding another module in PCB • 34
to 4119) • 131
Adding Another Module in RSLogix 5000 • 36
Event Sequence Request Blocks (4000 to 4019) • 130
Adding Multiple Modules in the Rack (Optional) • 34
Example and State Diagram • 118
Adding the Module to RSLogix • 17, 43, 44
B F
Floating-Point Support • 121
Backplane Data Transfer • 64
Force Multiple Coils (Function Code 15) • 119
Basic PCB Functions • 44
Force Single Coil (Function Code 05) • 115
C Function Blocks • 127
Function Codes Supported by the Module • 110
Clearing a Fault Condition • 94
Client Command List • 73 G
Client Status Request/Response Blocks (3000 to
General Concepts of the MVI69E-MBTCP Data
3019) • 129
Transfer • 63
Cold-boot Control Block (9999) • 144
General Specifications - Modbus Client/Server • 108
Command Control Blocks (5001 to 5016) • 132
Generating the AOI (.L5X File) in ProSoft
Command Error Codes • 73
Configuration Builder • 25
Command List Entry Errors • 104
Get Driver and Command Active Bits Block (9501) •
Communication Error Codes • 73, 104
137
Configuring the Floating Point Data Transfer • 122
Get Event with Data Status Block (8100) • 134
Configuring the MVI69E-MBTCP Using PCB • 43, 96,
Get General Module Status Data Block (9250) • 135
98
Get Queue and Event Sequence Block Counts Block
Connecting the PC to the Module's Ethernet Port • 96
(4200) • 132
Connecting to the Module’s Webpage • 105
Contacting Technical Support • 147 H
Content Disclaimer • 2
Controller Tags • 75 Hardware Specifications • 108
Creating a Module in the Project Using a Generic 1769
Module Profile • 17, 21 I
Creating a Module in the Project Using an Add-On If Block Transfer Size = 120 • 68
Profile • 17, 18 If Block Transfer Size = 240 • 69
Creating a New PCB Project and Exporting an .L5X If Block Transfer Size = 60 • 67
File • 44 Important Safety Information • 3
Creating a New RSLogix 5000 Project • 30 Importing the Add-On Instruction • 31
Creating and Exporting the .L5X File • 27, 32, 35, 43 Installing an Add-On Profile • 18
Creating the Module in an RSLogix 5000 Project • 17 Installing ProSoft Configuration Builder • 24
D Installing the Module in the Rack • 12
Data Flow Between the Module and Processor • 48, 70 L

Deployment Checklist • 11 LED Status Indicators • 94
Diagnostics (Function Code 08) • 117
Diagnostics and Troubleshooting • 73, 93 M
Diagnostics Menu • 100
Master Mode • 72

Support, Service & Warranty MVI69E-MBTCP ♦ CompactLogix Platform
MBTCP Client x • 50 Pass-Through Formatted Block for Functions 6 and 16

MBTCP Client x Commands • 51, 123 with Word Data Block (9956) • 138
MBTCP Client-Specific Errors • 105 Pinouts • 145
MBTCP Controller Tag Overview • 79 Preset Multiple Registers (Function Code 16) • 120
MBTCP Servers • 48 Preset Single Register (Function Code 06) • 116
MBTCP.CONFIG • 79 Printing a Configuration File • 46
MBTCP.CONTROL • 80 Product Specifications • 107
MBTCP.CONTROL. ColdBoot • 86
MBTCP.CONTROL.ClientServerControl • 84 R
MBTCP.CONTROL.EventCommand_DBData • 81 Read and Write Block Transfer Sequences • 66
MBTCP.CONTROL.EventCommand_PLCData • 82 Read Block
MBTCP.CONTROL.EventSequenceCommand • 83 Response from the Module to the Processor • 65
MBTCP.CONTROL.EventSequenceCounts • 85 Read Coil Status (Function Code 01) • 111
MBTCP.CONTROL.EventSequenceStatus • 85 Read Holding Registers (Function Code 03) • 113
MBTCP.CONTROL.GetEventDataStatus • 86 Read Input Registers (Function Code 04) • 114
MBTCP.CONTROL.GetGeneralStatus • 85 Read Input Status (Function Code 02) • 112
MBTCP.CONTROL.ResetStatus • 85 Reference • 107
MBTCP.CONTROL.Time • 84 Renaming PCB Objects • 44
MBTCP.CONTROL.WarmBoot • 86 Reset Status Block (9997) • 143
MBTCP.DATA • 80
MBTCP.STATUS • 86 S
MBTCP.STATUS.Block • 86
MBTCP.STATUS.ClientStatus • 87 Server Mode • 70
MBTCP.STATUS.EventSeqCounts • 88 Set Driver and Command Active Bits Block (9500) •
MBTCP.STATUS.EventSeqStatus • 87 136
MBTCP.STATUS.GeneralStatus • 47, 88 Set Module Time Using Received Time Block (9972) •
MBTCP.STATUS.GetEventDataStatus • 89 142
MBTCP.UTIL • 90 Setting Jumpers • 11
Modbus Client • 109 Setting Up a Temporary IP Address • 96
Modbus Client Driver Information • 103 Setting Up the Project in PCB • 25
Modbus Server • 110 Standard MODBUS Protocol Exception Code Errors •
Modbus Server Driver Information • 102 104
Module • 47 Start Here • 9
Module Communication Error Codes • 104 Static ARP Table • 56
Module Configuration Parameters • 20, 35, 47 Sub-function Codes Supported • 117
Monitoring Backplane Information • 101 Support, Service & Warranty • 147
Monitoring Data Values in the Module’s Database • System Requirements • 10, 36
103
Monitoring General Information • 101
T
MVI69E-MBTCP Backplane Data Exchange • 63 Troubleshooting • 95
MVI69E-MBTCP Controller Tags • 76
MVI69E-MBTCP User-Defined Data Types • 77 U
N Uploading the Configuration File from the Processor •
60
Normal Data Transfer • 27, 65 User-Defined Data Types (UDTs) • 76
Using an Add-On Profile • 19
P Using Controller Tags • 75
Package Contents • 15 Using the Diagnostics Menu in ProSoft Configuration
Pass Module Time to Processor Block (9973) • 143 Builder • 98
Pass-Through Block for Function 99 (9970) • 141
Pass-Through Formatted Block for Function 15 (9959)
W
• 140 Warm-boot Control Block (9998) • 144
Pass-Through Formatted Block for Function 23 (9961) Warranty Information • 148
• 141 Write Block
Pass-Through Formatted Block for Function 5 (9958) • Request from the Processor to the Module • 65
139
Pass-Through Formatted Block for Functions 6 and 16
with Float Data Block (9957) • 139

Mvi69E-Mbtcp: User Manual

Uploaded by

Copyright:

Available Formats

Mvi69E-Mbtcp: User Manual

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Mvi69E-Mbtcp: User Manual

Uploaded by

Copyright:

Available Formats

MVI69E-MBTCP

MVI69E-MBTCP User Manual

North America Warnings

ATEX Warnings and Conditions of Safe Usage:

Agency Approvals & Certifications

2 Adding the Module to RSLogix 17

3 Configuring the MVI69E-MBTCP Using PCB 43

4 MVI69E-MBTCP Backplane Data Exchange 63

ProSoft Technology, Inc. Page 5 of 150

4.3 Normal Data Transfer ............................................................................................. 65

5 Using Controller Tags 75

6 Diagnostics and Troubleshooting 93

Page 6 of 150 ProSoft Technology, Inc.

7.2.5 Read Input Status (Function Code 02) .................................................................. 112

8 Support, Service & Warranty 147

ProSoft Technology, Inc. Page 7 of 150

ProSoft Technology, Inc. Page 8 of 150

ProSoft Technology, Inc. Page 9 of 150

1.1 System Requirements

 The module requires 500 mA of available 5 Vdc power

Page 10 of 150 ProSoft Technology, Inc.

1.2 Deployment Checklist

1.3 Setting Jumpers

ProSoft Technology, Inc. Page 11 of 150

1.4 Installing the Module in the Rack

Page 12 of 150 ProSoft Technology, Inc.

4 Close all DIN-rail latches.

ProSoft Technology, Inc. Page 13 of 150

Page 14 of 150 ProSoft Technology, Inc.

1.5 Package Contents

Qty. Part Name Part Number Part Description

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

ProSoft Technology, Inc. Page 15 of 150

Page 16 of 150 ProSoft Technology, Inc.

2 Adding the Module to RSLogix

To add the MVI69E-MBTCP module in RSLogix 5000, you must:

2.1 Creating the Module in an RSLogix 5000 Project

ProSoft Technology, Inc. Page 17 of 150

2.1.1 Creating a Module in the Project Using an Add-On Profile

Installing an Add-On Profile

2 Continue to follow the steps in the wizard to complete the installation.

Page 18 of 150 ProSoft Technology, Inc.

Using an Add-On Profile

This opens the Select Module Type dialog box.

ProSoft Technology, Inc. Page 19 of 150

3 Select the MVI69E-MBTCP module in the list and click CREATE.

A Block Transfer Size of 60 uses an I/O TABLE SIZE of 62/61 words.

Page 20 of 150 ProSoft Technology, Inc.

The MVI69E-MBTCP module is now visible in the I/O Configuration tree.

2.1.2 Creating a Module in the Project Using a Generic 1769 Module

This opens the Select Module Type dialog box.

ProSoft Technology, Inc. Page 21 of 150

3 Set the Module Properties values as follows:

Page 22 of 150 ProSoft Technology, Inc.

The following illustration shows an example where the module was

The following options are available:

ProSoft Technology, Inc. Page 23 of 150

The MVI69E-MBTCP module is now visible in the I/O Configuration tree.

2.2 Installing ProSoft Configuration Builder