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
9201 Camino Media, Suite 200
Bakersfield, CA 93311
+1 (661) 716-5100
+1 (661) 716-5101 (Fax)
www.prosoft-technology.com
support@prosoft-technology.com
MVI69E-MBS User Manual
June 28, 2017
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:
http://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.
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
Page 3
Agency
ATEX; Category 3, Zone 2
CE Mark
CSA; CB Safety
Environmental
KCC
RoHS Compliant
UL/cUL; Class 1, Div. 2 Groups A, B, C, D
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/IECEx 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 ATEX/IECEx Certified, tool-secured, 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 Before operating the reset switch, be sure the area is known to be non-hazardous.
If the equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment
may be impaired.
Agency Approvals and Certifications
Page 4
Page 5
MVI69E-MBS ♦ CompactLogix Platform Contents
Modbus Serial Enhanced Communication Module User Manual
Contents
Your Feedback Please ........................................................................................................................ 2
Installing the Module in the Rack ........................................................... 13
Modbus Serial Enhanced Communication Module User Manual
1 Start Here
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 or MicroLogix 1500-LRP devices to a power
source and to the MVI69E-MBS module’s application port(s)
ProSoft Technology, Inc. Page 9 of 154
June 28, 2017
Page 10
Start Here MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
1.1 System Requirements
The MVI69E-MBS module requires the following minimum hardware and
software components:
Rockwell Automation CompactLogix or MicroLogix 1500-LRP® processor
(firmware version 10 or higher), with compatible power supply and one free
slot in the rack, for the MVI69E-MBS module.
Important: The MVI69E-MBS 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
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)
®
7
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.
Page 10 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 11
MVI69E-MBS ♦ CompactLogix Platform Start Here
Qty.
Part Name
Part Number
Part Description
1
MVI69E-MBS Module
MVI69E-MBS
Modbus Serial Enhanced Communication
Module
2
Adapter Cable
Cable #14
RJ45 to DB9 Male Adapter cable. For DB9
connection to module’s serial application
ports
2
Screw Terminal
Adapter
1454-9F
DB9 female to 9-pin screw terminal. Used
for RS422 or RS485 connections to Port 1
and 2 of the module
1
Ethernet Cable
RL-CBL025
Ethernet straight-through cable
Modbus Serial Enhanced Communication Module User Manual
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-MBS 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 or
MicroLogix 1500-LRP processor.
How many words of data do you need to transfer in your application (from
CompactLogix or MicroLogix 1500-LRP to Module / to CompactLogix or
MicroLogix 1500-LRP from Module)?
1.3 Package Contents
The following components are included with your MVI69E-MBS module, and are
all required for installation and configuration.
Important: Before beginning the installation, please verify that all of the following items are
present.
If any of these components are missing, please contact ProSoft Technology
Technical Support for replacement parts.
ProSoft Technology, Inc. Page 11 of 154
June 28, 2017
Page 12
Start Here MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
1.4 Setting Jumpers
When the module is manufactured, the port selection jumpers are set to RS-232.
To use RS-422 or RS-485, you must set the jumpers to the correct position. The
following diagram describes the jumper settings.
Note: Jumper pin placement on the circuit board may vary.
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. If an
update of the firmware is needed, apply the Setup jumper to both pins.
Page 12 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 13
MVI69E-MBS ♦ CompactLogix Platform Start Here
Modbus Serial Enhanced Communication Module User Manual
The following illustration shows the MVI69E-MBS jumper configuration, with the
Setup Jumper OFF.
1.5 Installing the Module in the Rack
Make sure the processor and power supply are installed and configured before
installing the MVI69E-MBS 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-MBS into the rack.
Use the same technique recommended by Rockwell Automation to remove and
install CompactLogix or MicroLogix 1500-LRP 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.
ProSoft Technology, Inc. Page 13 of 154
June 28, 2017
Page 14
Start Here MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
1 Align the module using the upper and lower tongue-and-groove slots with the
adjacent module and slide forward in the direction of the arrow.
2 Move the module back along the tongue-and-groove slots until the bus
connectors on the MVI69 module and the adjacent module line up with each
other.
Page 14 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 15
MVI69E-MBS ♦ CompactLogix Platform Start Here
Modbus Serial Enhanced Communication Module User Manual
3 Push the module’s bus lever back slightly to clear the positioning tab and
move it firmly to the left until it clicks. Ensure that it is locked firmly in place.
4 Close all DIN-rail latches.
ProSoft Technology, Inc. Page 15 of 154
June 28, 2017
Page 16
Start Here MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
5 Press the DIN-rail mounting area of the controller against the DIN-rail. The
latches momentarily open and lock into place.
Page 16 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 17
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
In This Chapter
Creating the Module in an RSLogix 5000 Project .................................. 17
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) .................................... 35
Modbus Serial Enhanced Communication Module User Manual
2 Adding the Module to RSLogix
To add the MVI69E-MBS 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:
oYou can use the Add-On Profile from ProSoft Technology. This is the
preferred way, but requires RSLogix version 15 or later.
oYou 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-MBS 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-MBS
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
ProSoft Technology, Inc. Page 17 of 154
June 28, 2017
Generic 1769 Module Profile (page 22).
Page 18
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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.
Page 18 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 19
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
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 theI/OCONFIGURATION folder in the Project tree.
Right-click the appropriate communications bus and, and then click NEW MODULE.
ProSoft Technology, Inc. Page 19 of 154
June 28, 2017
Page 20
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
This opens the Select Module Type dialog box. In the Module Type Vendor
Filters area, uncheck all boxes except the PROSOFT TECHNOLOGY box. A list
of ProSoft Technology modules appears in the dialog box.
2 Select theMVI69E-MBS module in the list and click CREATE:
Page 20 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 21
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
3 A New Module dialog box opens. Edit the NAME and SLOT for the module and
click OK.
Note : The I/OTABLE SIZES above should reflect the Block Transfer Size parameter set in PCB
(Section Module Configuration Parameters (page 47)).
A Block Transfer Size of 60 uses an I/OTABLE SIZE of 62/61 words.
A Block Transfer Size of 120 uses an I/OTABLE SIZE of 122/121 words.
A Block Transfer Size of 240 uses an I/OTABLE SIZE of 242/241 words.
Applications that require smaller amounts of data or faster update times, such as ControlNet
networks, will benefit from smaller block transfer sizes.
The MVI69E-MBS module is now visible in the I/O Configuration tree.
ProSoft Technology, Inc. Page 21 of 154
June 28, 2017
Page 22
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
2.1.2 Creating a Module in the Project Using a Generic 1769 Module
Profile
This procedure is not required if you installed the ProSoft Technology Add-On
Profile for this module.
1 Expand theI/OCONFIGURATION 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 1769MODULE. If
you're using an earlier version of RSLogix, expand OTHER in the Select Module dialog box, and then select the GENERIC 1769MODULE.
Page 22 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 23
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Parameter
Value
Name
Enter a module identification string. Example: MVI69EMBS
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 MV69E-MBS
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
Block Transfer Size
Input Block Size
Output Block Size
60
62
61
120
122
121
240
242
241
Modbus Serial Enhanced Communication Module User Manual
3 Set the Module Properties values as follows:
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:
ProSoft Technology, Inc. Page 23 of 154
June 28, 2017
Page 24
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
4 On the Connection tab, set the REQUESTED PACKET INTERVAL value for your
project and click OK.
The MVI69E-MBS 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
web site: http://www.prosoft-technology.com. The installation filename contains
the PCB version number. For example, PCB_4.3.4.5.0238.EXE.
Installing PCB from the ProSoft website:
1 Open a browser window and navigate to http://www.prosoft-technology.com
2 Navigate to the ProSoft Configuration Builder download link, and save the file
to your Windows desktop.
3 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.
4 If you want to find additional software specific to your MVI69E-MBS, enter the
model number into the ProSoft website search box and press the Enter key.
Page 24 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 25
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
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).
ProSoft Technology, Inc. Page 25 of 154
June 28, 2017
Page 26
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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-MBS module to the project.
Page 26 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 27
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
1 In the Tree view, right-click DEFAULT MODULE, and then click CHOOSE
MODULE TYPE. This opens theChoose 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-MBS, and then click OKto save
your settings and return to the ProSoft Configuration Builder window. The
MVI69E-MBS icon is now visible in the tree view.
ProSoft Technology, Inc. Page 27 of 154
June 28, 2017
Page 28
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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-MBS icon by clicking the [+] symbol beside it. Similarly,
expand the icon. Double-click the icon to open the Edit - Module dialog box.
2 Set the Block Transfer Size to the desired size of the data blocks transferred
between the module and processor (60, 120 or 240 words). Block transfer
size information can be found starting in the section on Normal Data Transfer
(page 65).
Page 28 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 29
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
3 Edit the Slot Number indicating where the module is placed in the 1769 bus.
4 Click OK to close the Edit – Module dialog box. The .L5X file is now ready to
be exported to the PC/Laptop.
5 Right-click the MVI69E-MBS icon in the project tree and choose EXPORT AOI
FILE.
ProSoft Technology, Inc. Page 29 of 154
June 28, 2017
Page 30
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
6 Save the .L5X file to the PC/Laptop in an easily found location, such as
Windows Desktop.
2.4 Creating a New RSLogix 5000 Project
1 Click the FILE menu and then choose NEW.
2 Select your CompactLogix or MicroLogix 1500-LRP controller model.
3 Select REVISION 16 or newer.
4 Enter a name for your controller, such as My_Controller.
5 Select your CompactLogix or MicroLogix 1500-LRP chassis type.
Page 30 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 31
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
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. 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.
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.
ProSoft Technology, Inc. Page 31 of 154
June 28, 2017
Page 32
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
5 Select the .L5Xfile that you exported from PCB (Creating and Exporting the
.L5X File (page 28)).
This opens the Import Configuration dialog box. Click TAGS under
MAINROUTINE to display the controller tags in the Add-On Instruction.
Page 32 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 33
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
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 OKto confirm the import. RSLogix indicates that the import is in
progress:
ProSoft Technology, Inc. Page 33 of 154
June 28, 2017
Page 34
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
When the import is completed, the new rung with the Add-On Instruction is
visible.
The procedure also imports new user-defined data types, data objects and
the Add-On instruction to be used in the project with the MVI69E-MBS
module.
Page 34 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 35
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
2.6 Adding Multiple Modules in the Rack (Optional)
Important: This procedure is for multiple MVI69E-MBS modules running in the same
CompactLogix or MicroLogix 1500-LRP rack
You can add additional modules of the same type to the rack.
1 Add a new MVI69E-MBS module to the ProSoft Configuration Builder (PCB)
project.
2 Export the module configuration as an L5X file.
3 Add a new MVI69E-MBS 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 another module in PCB
1 Start ProSoft Configuration Builder.
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-MBS as the MODULE TYPE. Click OK.
5 Select the MVI69E-MBS module in the tree and repeat the above steps to
add a second (or more) module in the PCB project.
ProSoft Technology, Inc. Page 35 of 154
June 28, 2017
Page 36
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
Note: You must give each MVI69E-MBS module a unique name. The default name on a duplicate
module appends a number to the end such as MVI69E-MBS_000, MVI69E-MBS_001, etc.
6 You can rename the module by right clicking the module and choosing
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 choose EXPORT AOIFILE. See Creating and Exporting the .L5X
File (page 28).
Page 36 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 37
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
2.6.2 Adding Another Module in RSLogix 5000
You can place multiple MVI69E-MBS modules in the same rack provided it does
not exceed the power distance rating of the CompactLogix or MicroLogix 1500LRP rack (see System Requirements (page 10)). Adding an additional module to
the rack 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/OCONFIGURATION folder. Right click
COMPACTBUS LOCAL and choose NEW MODULE.
3 In the Select Module Type dialog box, select the MVI69E-MBS module.
oIf you are using an Add-On Profile (AOP), this adds the MVI69E-MBS
module and configures the relevant parameters. You must be using
RSLogix version 15 or later to to use an AOP.
oIf using an AOP is not an option, select GENERIC 1769MODULE and click
CREATE.
ProSoft Technology, Inc. Page 37 of 154
June 28, 2017
Page 38
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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 (page 35)). In the Controller Organizer pane,
double-click MAINROUTINE to open the ladder for the routine.
Page 38 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 39
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
7 Right-click an empty rung in the routine, and then choose IMPORT RUNGS…
ProSoft Technology, Inc. Page 39 of 154
June 28, 2017
Page 40
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
8 Select the .L5X file you created and exported for the new module, and click
IMPORT.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 AOI. You must edit the FINAL NAME column of the tags
for the second module to make them unique.
Page 40 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 41
MVI69E-MBS ♦ CompactLogix Platform Adding the Module to RSLogix
Modbus Serial Enhanced Communication Module User Manual
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.
ProSoft Technology, Inc. Page 41 of 154
June 28, 2017
Page 42
Adding the Module to RSLogix MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
11 Click OK.
The setup procedure is now complete. Save the project. It is ready to download
to the CompactLogix or MicroLogix 1500-LRP processor.
Page 42 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 43
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Downloading the Configuration File to the Processor ............................ 56
Uploading the Configuration File from the Processor ............................ 59
Modbus Serial Enhanced Communication Module User Manual
3 Configuring the MVI69E-MBS Using PCB
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 or
MicroLogix 1500-LRP processor, where it is stored in the MBS.CONFIG
controller tag generated by the previously exported AOI. See Creating and
Exporting the .L5X File (page 28). When the MVI69E-MBS 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 17) 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.
ProSoft Technology, Inc. Page 43 of 154
June 28, 2017
Page 44
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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 17).
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 choose RENAME.
2 Type the new name for the object and press Enter.
3.1.3 Editing Configuration Parameters
1 Click the [+] sign next to the module icon to expand module information.
2 Click the[+]sign next to any icon to view module information and
configuration options.
3 Double-click any icon to open an Edit dialog box.
To edit a parameter, select the parameter in the left pane and 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 OKto save your changes.
Page 44 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 45
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Modbus Serial Enhanced Communication Module User Manual
5 Double-click any icon to open an Edit dialog box with a table. Use this
dialog box to build and edit Modbus Master commands.
6 To add a row to the table, click ADD ROW.
ProSoft Technology, Inc. Page 45 of 154
June 28, 2017
Page 46
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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-MBS 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.
Page 46 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 47
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Parameter
Value
Description
Module Name
ASCII
characters
(max. 80)
Assigns a name to the module that can be viewed using the
configuration/debug port. Use this parameter to identify the module
and the configuration file.
Read Register Start
0 to 9999
Specifies the start of the Read Data area in module memory. 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 from the processor to the module.
Write Register Count
0 to 10,000
Specifies the size of the Write Data area.
Backplane Fail Count
0 to 65535
Specifies the number of consecutive backplane transfer failures
that can occur before communications are halted.
Error/Status Block Pointer
-1 to 9939
Starting register location in the module’s database for the
error/status table. If a value of -1 is entered, the error/status data is
not placed in the database. This data must be placed in the read
data range of module memory.
This data ncludes the module version information and all server
error/status data. Refer to MBS.STATUS (page 85) 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. This
option requires associated ladder logic to pass the data from the
processor to the module.
Block Transfer Size
60, 120 or 240
Specifies the number of words in each block transferred between
the module and processor.
Slot Number
1 to x
Specifies the slot in the CompactLogix or MicroLogix 1500-LRP
rack for the module.
Modbus Serial Enhanced Communication Module User Manual
3.2 Module Configuration Parameters
3.2.1 Module Parameters
This section contains general module configuration parameters, including
database allocation and backplane transfer options.
In the ProSoft Configuration Builder (PCB) tree view, double-click 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 not overlap.
ProSoft Technology, Inc. Page 47 of 154
June 28, 2017
Page 48
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
Parameter
Value
Description
Start Active
Yes or No
Specifies whether or not the port and commands are active
upon module boot-up.
Type
Master, Slave,
or Slave with
Pass-Through
This parameter specifies which device type the port emulates.
See Slave Mode (page 70) for more information on Slave
Pass-Through options.
Protocol
RTU or ASCII
Specifies the Modbus protocol for the port.
Baud Rate
Multiple options
Specifies the baud rate for the port.
Parity
None, Odd,
Even
Specifies the type of parity error checking. All devices on this
port must use the same parity setting.
Data Bits
7 or 8
Sets the number of data bits for each word used by the
protocol. All devices communicating through this port must use
the same number of data bits.
Stop Bits
1 or 2
Sets the number of stop bits that signal the end of a character
in the data stream. For most applications, use one stop bit. For
slower devices that require more time to re-synchronize, use
two stop bits. All devices communicating through this port must
use the same number of stop bits.
RTS On
0 to 65535
milliseconds
Sets the number of milliseconds to delay after Ready To Send
(RTS) is asserted before data is transmitted.
RTS Off
0 to 65535
milliseconds
Sets the number of milliseconds to delay after the last byte of
data is sent before the RTS modem signal is set low.
Use CTS Line
Yes or No
Specifies if the Clear To Send (CTS) modem control line is to
be used or not. If you set the parameter to NO, the CTS line is
not monitored. If you set the parameter to YES, the CTS line is
monitored and must be high before the module sends data.
Normally, this parameter is required when half-duplex modems
are used for communication (2-wire). This procedure is
commonly referred to as hardware handshaking.
User Manual Modbus Serial Enhanced Communication Module
3.2.2 Modbus Port x Parameters
This section applies to both MBSPORT 1 and MBSPORT 2.
In the ProSoft Configuration Builder tree view, double-click the MODBUS PORT X
icon.
Configuration Parameters Common to Master and Slave
Page 48 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 49
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Float Flag
Yes or No
Specifies how the Slave driver responds to Function Code 3, 6,
and 16 commands (read and write Holding Registers) from a
remote Master when it is moving 32-bit floating-point data.
Note: Most applications using floating-point data do not need
this parameter enabled.
If the remote Master expects to receive or sends one complete
32-bit floating-point value for each count of one (1), then set
this parameter to YES. When set to YES, the Slave 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 Master for write commands.
Example: Count = 10, Slave driver sends 20 16-bit registers for
10 total 32-bit floating-point values.
If, however, the remote Master sends a count of two (2) for
each 32-bit floating-point value it expects to receive or send,
or, if you do not plan to use floating-point data in your
application, then set this parameter to NO, which is the default
setting.
You also need to set the Float Start and Float Offset
parameters to appropriate values whenever the Float Flag
parameter is set to YES.
Float Start
0 to 32767
Defines the first register of floating-point data. All requests with
register values greater-than or equal to this value is 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 9999
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 the float start parameter to 7000, data requests for
register 7000 use the internal Modbus register 3000.
Modbus Serial Enhanced Communication Module User Manual
ProSoft Technology, Inc. Page 49 of 154
June 28, 2017
Page 50
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
Parameter
Value
Description
Response
Timeout
0 to 65535
milliseconds
Specifies the command response timeout period in 1
millisecond increments. This is the time that a port configured
as a Master waits for a response from the addressed slave
before re-transmitting the command (Retries) or skipping to the
next command in the Command List. The value to specify
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.
Minimum
Command Delay
0 to 32767
milliseconds
Specifies the number of milliseconds to wait between receiving
the end of a slave'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
slaves can receive them. This parameter does not affect retries
of a command, as retries are issued when a command failure
is recognized.
Error Delay
Counter
0 to 60000
Specifies the number of poll attempts to be skipped before
trying to re-establish communications with a slave that has
failed to respond to a command within the time limit set by the
Response Timeout parameter. After the slave fails to respond,
the master skips sending commands that should have been
sent to the slave until the number of skipped commands
matches the value entered in this parameter. This creates a
sort of slow poll mode for slaves that are experiencing
communication problems.
Inter-character
Timeout
0 to 65535
milliseconds
Specifies a time delay in milliseconds to be added to the 3.5
character time delay used by the module to recognize the end
of a message. Certain applications may require validation of
Modbus messages with more than 3.5 character time between
consecutive bytes (example: modem applications). A value of
0 causes the default end of message delay to be used
Command Error
Offset
-1 to 9998
Sets the address in the module’s database where the
command error data is placed. If the value is set to -1, the data
is not transferred to the database. The valid range of values for
this parameter is -1 to 4899. For example, if this parameter is
configured for 1000, the command errors are copied to the
database as follows:
1000: error code for command 0
1001: error code for command 1
…
An error code of 0 means that the command was successfully
sent (no error).
User Manual Modbus Serial Enhanced Communication Module
Additional Configuration Parameters as Master
The Type parameter must be MASTER to configure these parameters. See
Configuration Parameters Common to Master and Slave (page 48).
Page 50 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 51
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Parameter
Value
Description
Minimum
Response Delay
0 to 65535
milliseconds
Sets the number of milliseconds to wait before responding to a
command received on the port from a remote Master. This
delay is sometimes required to accommodate slower Master
devices.
Internal Slave ID
1 to 247
Defines the Slave Node Address for the internal database. All
requests received by the port with this address are processed
by the module. Verify that each device has a unique address
on a network.
Bit Input Offset
0 to 9998
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.
Word Input Offset
0 to 9998
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.
Output Offset
0 to 9998
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.
Holding Register
Offset
0 to 9998
Specifies the offset address in the internal Modbus database
for network requests for Modbus function 3, 6, or 16
commands. For example, if you set the value to 50, a request
for address 0 corresponds to the register 50 in the database.
Modbus Serial Enhanced Communication Module User Manual
Additional Configuration Parameters as Slave
The Type parameter must be SLAVE or PASSTHRU SLAVE to configure these
parameters. See Configuration Parameters Common to Master and Slave (page
48).
ProSoft Technology, Inc. Page 51 of 154
June 28, 2017
Page 52
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
3.2.3 Modbus Port x Commands
This section defines the master command list specifications for a Master port.
The information in this section applies to both MBSPORT 1 and MBSPORT 2.
In the ProSoft Configuration Builder tree view, double-click the MODBUS PORT X COMMANDS icon.
In order to interface the MVI69E-MBS with Modbus slave devices, you must
create a command list. The commands in the list specify the slave device to be
addressed, the function to be performed (read or write), the data area in the
device to interface with and the registers in the internal database to be
associated with the device data.
The Master command list supports up to 250 commands. 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.
The MVI69E-MBS Master (and Slave) communication drivers support several
data read and write commands. When a command is configured, the type of data
(bit, 16-bit integer, 32-bit float, etc), and the level of Modbus support in the slave
equipment needs to be considered.
Page 52 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 53
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Parameter
Value
Description
Enable
0 to 4
This field defines whether the command is to be executed
under certain conditions.
Disabled (0) = The command is disabled and is not executed
in the normal polling sequence.
Continuous (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 upon Error (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 upon Error (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 (wordlevel)
or
0 to 65535 (bit-
level)
Specifies the module’s internal database register to be
associated with the command. Allowable range is 0 to 9999
for Modbus Function Codes 3, 4, 6, or 16, and 0 to 65535 for
Modbus Function Codes 1, 2, 5, or 15.
If the command is a read function, the data read from the
slave device is storedbeginning 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
slave device is sourcedbeginning 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.
Note: When using a bit level command, you must define this
field at the bit level. For example, when using function codes 1
or 2 for a Read command, you must have a enter of 160 to
place the data in the MBS.DATA.ReadData[10] controller tag
in RSLogix 5000 . Think of it as the 160th bit of MBS internal
memory (MBS Internal register 10 * 16 bits per register =
160). Use this formula for function codes 5 or 15 for writing
bits also.
This controller tag is a 16bit signed integer. This means you
can only enter values of -32768 to 32767 in the tag. If a value
to be entered is above the 32767 (but below 65535) threshold,
it displays as a negative value in the tag. Simply subtract
65536 from the value to get the 'acceptable' value to enter into
the tag.
Example: You need to use an Internal bit Address of 48000,
but you cannot enter '48000' into the tag because it causes an
error. 48000 - 65536 = -17536 You enter -17536 in the
Internal Address parameter for this command.
Modbus Serial Enhanced Communication Module User Manual
ProSoft Technology, Inc. Page 53 of 154
June 28, 2017
Page 54
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
Poll Interval
0 to 65535
seconds
Specifies the minimum interval between executions of
continuous commands (Enable code = 1).
Example: If you set the value to 10, the command executes
no more frequently than once 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)
or
1 to 800 (coils)
Specifies the number of registers or digital points to be
associated with the command. Modbus Function Codes 5 and
6 ignore this 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
0,1,2,3
Defines if the data received from the Modbus slave is to be
ordered differently than received from the slave 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 slave devices. You can set this
parameter to order the register data received in an order
useful by other applications.
No Change (0)= No change is made in the byte ordering
(ABCD = ABCD)
Word Swap (1)= The words are swapped (ABCD= CDAB)
Word and Byte Swap (2) = The words are swapped, then the
bytes in each word are swapped (ABCD=DCBA)
Byte Swap (3) = The bytes in each word are swapped
(ABCD=BADC)
Note: Each pair of characters is a byte. Ex: AB and CD. Two
pairs of characters is 16-bit register Ex: ABCD.
Node Address
1 to 255
(0 = broadcast)
Specifies the Modbus slave node address on the network to
be considered. Most Modbus devices only accept an address
in the range of 1 to 247. 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,16
Specifies the Modbus function to be executed by the
command. These function codes are defined in the Modbus
protocol.
Specifies the register or digital point address offset within the
Modbus slave device. The MBS Master reads or writes
from/to this address within the slave.
Refer to the documentation of each Modbus slave device for
User Manual Modbus Serial Enhanced Communication Module
Page 54 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 55
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
their register and digital point address assignments.
Note: The value entered 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: Using a Modbus Function Code 3 to read from
address 40010 in the slave, a value of ‘9’ would be entered in
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
Upon Error
This parameter is only applicable for Enable Codes 3
(Bit/Word Override) or 4 (Float Override).
If an error occurs associated to a read command the module
automatically populates the associated database area with
this override value.
Parameter
Description
IP Address
Unique IP address assigned to the module
Netmask
Subnet mask of module
Gateway
Gateway (if used)
Modbus Serial Enhanced Communication Module User Manual
3.2.4 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.
ProSoft Technology, Inc. Page 55 of 154
June 28, 2017
Page 56
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
3.3 Downloading the Configuration File to the Processor
1 In the ProSoft Configuration Builder tree view, right-click the module icon and
choose DOWNLOAD FROM PC TO DEVICE.
2 In the Download Configuration File dialog box, click RSWHO.
Page 56 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 57
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Modbus Serial Enhanced Communication Module User Manual
3 Browse to, and then highlight the CompactLogix or MicroLogix 1500-LRP
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.
ProSoft Technology, Inc. Page 57 of 154
June 28, 2017
Page 58
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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.
Page 58 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 59
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Modbus Serial Enhanced Communication Module User Manual
3.4 Uploading the Configuration File from the Processor
1 In the ProSoft Configuration Builder tree view, right-click the MVI69E-MBS
icon and choose UPLOAD FROM DEVICE TO PC.
ProSoft Technology, Inc. Page 59 of 154
June 28, 2017
Page 60
Configuring the MVI69E-MBS Using PCB MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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, then select the
CompactLogix or MicroLogix 1500-LRP Processor, and click OK.
Page 60 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 61
MVI69E-MBS ♦ CompactLogix Platform Configuring the MVI69E-MBS Using PCB
Modbus Serial Enhanced Communication Module User Manual
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.
ProSoft Technology, Inc. Page 61 of 154
June 28, 2017
Page 62
MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
Page 62 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 63
MVI69E-MBS ♦ CompactLogix Platform MVI69E-MBS Backplane Data Exchange
In This Chapter
General Concepts of the MVI69E-MBS Data Transfer .......................... 63
Backplane Data Transfer ....................................................................... 64
Normal Data Transfer ............................................................................ 65
Data Flow Between the Module and Processor ..................................... 70
Modbus Serial Enhanced Communication Module User Manual
4 MVI69E-MBS Backplane Data Exchange
4.1 General Concepts of the MVI69E-MBS Data Transfer
The MVI69E-MBS module uses ladder logic to communicate with the
CompactLogix or MicroLogix 1500-LRP 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-MBS 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 or MicroLogix 1500-LRP backplane driver
o Test and clear all RAM
2 Read configuration from the CompactLogix or MicroLogix 1500-LRP
processor through ladder logic
3 Allocate and initialize Module Register space
4 Enable Modbus application port(s)
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.
ProSoft Technology, Inc. Page 63 of 154
June 28, 2017
Page 64
MVI69E-MBS Backplane Data Exchange MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
4.2 Backplane Data Transfer
The MVI69E-MBS module communicates directly over the CompactLogix or
MicroLogix 1500-LRP backplane. Data is paged between the module and the
CompactLogix or MicroLogix 1500-LRP 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. Applications that
require smaller amounts of data or faster update times, such as ControlNet
networks, will benefit from smaller block transfer sizes.
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 or MicroLogix 1500-LRP processor, the MVI69EMBS module and the Modbus Network.
Page 64 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 65
MVI69E-MBS ♦ CompactLogix Platform MVI69E-MBS Backplane Data Exchange
Offset
Description
Length (words)
0
Write Block ID
1
1 to (n)
Write Data
(n)
Offset
Description
Length (words)
0
Read Block ID
1 1 Write Block ID
1
2 to (n+1)
Read Data
(n)
Modbus Serial Enhanced Communication Module User Manual
All data transferred between the module and the processor over the backplane is
through the input and output images. Ladder logic in the CompactLogix or
MicroLogix 1500-LRP 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 MBS data tables with
addresses from 0 to the maximum number of points for each data type.
4.3 Normal Data Transfer
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:
(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:
(n) = 60, 120, or 240 depending on the Block Transfer Size parameter (refer to the configuration
file).
ProSoft Technology, Inc. Page 65 of 154
June 28, 2017
Page 66
MVI69E-MBS Backplane Data Exchange MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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:
R1W1R2W2R3W1R1W2R2W1R3W2R1W1
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:
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).
Page 66 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 67
MVI69E-MBS ♦ CompactLogix Platform MVI69E-MBS Backplane Data Exchange
Modbus Serial Enhanced Communication Module User Manual
If Block Transfer Size = 60
ProSoft Technology, Inc. Page 67 of 154
June 28, 2017
Page 68
MVI69E-MBS Backplane Data Exchange MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
If Block Transfer Size = 120
Page 68 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 69
MVI69E-MBS ♦ CompactLogix Platform MVI69E-MBS Backplane Data Exchange
Modbus Serial Enhanced Communication Module User Manual
If Block Transfer Size = 240
ProSoft Technology, Inc. Page 69 of 154
June 28, 2017
Page 70
MVI69E-MBS Backplane Data Exchange MVI69E-MBS ♦ CompactLogix Platform
Step
Description
1
Any time the module restarts (boots or reboots), the Modbus slave port driver receives
configuration information from the MBS controller tags. This information configures the
serial ports and defines slave node 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 Master device, such as a Modicon PLC or an HMI application, issues a read or
write command to the module’s node address. The port 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 Master.
5
Counters are available in the Status Block to permit the ladder logic program to determine
the level of activity of the Slave driver.
User Manual Modbus Serial Enhanced Communication Module
4.4 Data Flow Between the Module and Processor
The following topics describe the flow of data between the two pieces of
hardware (CompactLogix or MicroLogix 1500-LRP processor and MVI69E-MBS
module) and other nodes on the Modbus network. You can configure each port
on the module to emulate a Modbus Master device or a Modbus Slave device.
4.4.1 Slave Mode
In Slave Driver mode, the MVI69E-MBS module responds to read and write
commands issued by a master on the Modbus network. The following diagram
shows the data flow for normal Slave mode.
Page 70 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 71
MVI69E-MBS ♦ CompactLogix Platform MVI69E-MBS Backplane Data Exchange
Step
Description
1
Same as normal mode.
2
Same as normal mode.
3
a. In Pass-Through mode, if the Slave 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 Slave driver so it can build a response message.
c. In Pass-Through mode, if the Slave 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
Same as normal mode.
5
Same as normal mode.
Modbus Serial Enhanced Communication Module User Manual
In Slave Pass-Through mode, write commands from the Master are handled
differently than they are in Normal mode. In Slave 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 Master 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 slave port with pass-through enabled:
ProSoft Technology, Inc. Page 71 of 154
June 28, 2017
Page 72
MVI69E-MBS Backplane Data Exchange MVI69E-MBS ♦ CompactLogix Platform
Step
Description
1
Upon module boot-up, the Master driver obtains configuration data from the MBS
controller tags. The configuration data retrieved includes port configuration and the
Master Command List.
Special Commands can be issued directly from the CompactLogix or MicroLogix 1500LRP processor using Event Commands and Command Control. These command values
are used by the Master driver to determine the types and order of commands to send to
slaves on the network.
2
After configuration, the Master driver begins transmitting read and/or write commands to
slave nodes on the network. If the Master driver is writing data to a slave, the data for the
write command is retrieved from the module’s internal database.
3
Once the specified slave has successfully processed the command, it returns a response
message to the Master driver for processing.
4
Data received from a slave 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 Master Command List.
User Manual Modbus Serial Enhanced Communication Module
4.4.2 Master Mode
In Master mode, the MVI69E-MBS module issues read or write commands to
slave devices on the Modbus network. These commands are user-configured in
PCB; refer to Modbus Port x Commands (page 52). 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 or MicroLogix
1500-LRP 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.
Page 72 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 73
MVI69E-MBS ♦ CompactLogix Platform MVI69E-MBS Backplane Data Exchange
Modbus Serial Enhanced Communication Module User Manual
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.
Master Command List
For a port to function in Master Mode, its Master Command List must be defined
in Prosoft Configuration Builder; refer to Modbus Port x Commands (page 52).
This list contains up to 310 individual entries, with each entry containing the
information required to construct a valid command. A valid command includes
the following items:
Command enable mode: (0) disabled, (1) continuous or (2) conditional
Source or destination database address: The module 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.
Slave node address
Modbus Function Code: This is the type of command that is issued.
Source or destination address in the slave 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 100).
You can view the command error codes through the Ethernet diagnostics port;
refer to Diagnostics and Troubleshooting (page 87). 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; refer to Additional Configuration Parameters as
Master (page 50).
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.
ProSoft Technology, Inc. Page 73 of 154
June 28, 2017
Page 74
MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
Page 74 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 75
MVI69E-MBS ♦ CompactLogix Platform Using Controller Tags
User-Defined Data Types (UDTs) ......................................................... 77
MBS Controller Tag Overview ............................................................... 79
Modbus Serial Enhanced Communication Module User Manual
5 Using Controller Tags
Controller tags are a feature of the RSLogix software and are part of the MVI69EMBS Add-On Instruction. Refer to the section Adding the Module to RSLogix
(page 17) for information on importing the Add-On Instruction into RSLogix.
5.1 Controller Tags
Data related to the MVI69E-MBS is stored in the ladder logic in variables called
controller tags. You use controller tags to manage communication between the
MVI69E-MBS module and the CompactLogix or MicroLogix 1500-LRP processor:
View the read and write data 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).
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 are included in the MVI69E-MBS Add-On Instruction 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.
The Add-On Instruction also includes user-defined data types (UDTs). UDTs are
collections of data types and declares the data types for the controller tag
structures.
The MVI69E-MBS 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 Add-On Instruction works without
needing any modification.
ProSoft Technology, Inc. Page 75 of 154
June 28, 2017
Page 76
Using Controller Tags MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
5.1.1 MVI69E-MBS Controller Tags
The main controller tag structure, MBS, 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 MBS.DATA controller tag structure, you see that
it contains two controller tag arrays, MBS.DATA.ReadData and MBS.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).
Page 76 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 77
MVI69E-MBS ♦ CompactLogix Platform Using Controller Tags
Modbus Serial Enhanced Communication Module User Manual
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 for the MVI69E-MBS 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-MBS User-Defined Data Types
Twenty different UDTs are defined for the MVI69E-MBS Add-On Instruction. The
main UDT, MBSMODULEDEF, contains all the data types for the module and
was used to create the main controller tag structure, MBS. There are five UDTs
one level below MBSMODULEDEF. These lower-level UDTs were used to create
the MBS.CONFIG, MBS.DATA, MBS. CONTROL, MBS.STATUS, and MBS.UTIL
controller tag structures.
Click the [+] signs to expand the UDT structures and view lower-level UDTs.
ProSoft Technology, Inc. Page 77 of 154
June 28, 2017
Page 78
Using Controller Tags MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
For example, if you expand MBS.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
MBS.DATA.ReadData and MBS.DATA.WriteData controller tag arrays.
The UDTs are commented in the DESCRIPTION column.
Page 78 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 79
MVI69E-MBS ♦ CompactLogix Platform Using Controller Tags
Tag Name
Description
MBS.CONFIG
Configuration information
MBS.DATA
MBS input and output data transferred between the processor
and the module
MBS.CONTROL
Governs the data movement between the PLC rack and the
module
MBS.STATUS
Status information
MBS.UTIL
Generic tags used for internal ladder processing (DO NOT
MODIFY)
Modbus Serial Enhanced Communication Module User Manual
Tip: If more than 600 words of Read or Write Data are needed, the MBS.DATA.ReadData and
MBS.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 MBSDATA 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 MBS Controller Tag Overview
This and the following sections describe the MBS controller tags in detail.
ProSoft Technology, Inc. Page 79 of 154
June 28, 2017
Page 80
Using Controller Tags MVI69E-MBS ♦ CompactLogix Platform
Tag Name
Description
MBS.CONFIG.FileData
This parameter contains the MBS configuration data after it has
been downloaded from PCB. It is displayed in ASCII format.
Note: MBS configuration changes cannot be made directly in
this array; the configuration must be downloaded with PCB.
MBS.CONFIG.FileSize
Configuration file size (MBS.CONFIG.FileData array) in bytes.
MBS.CONFIG.FileCRC32
CRC checksum of the configuration file stored in the array.
Data area copied from the module to the processor. This array
stores the Modbus data coming into the module from the
Modbus network.
MBS.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.
Tag Name
Range
Description
MBS.CONTROL.PortControl.
Set
0 or 1
Sends Port Control to module
MBS.CONTROL.PortControl.
Get
0 or 1
Reads Port Control from module
MBS.CONTROL.PortControl.
Portx
n/a
Definition of Port x Control
MBS.CONTROL.PortControl.
Portx.Active
0 or 1
Port Control: Disable = 0, Enable = 1
MBS.CONTROL.PortControl.
Portx.CmdEnableBits[x]
0 or 1
Index of command to be controlled. Example:
Command 20 in port 1 command list can be controlled
at CmdEnableBits[1].3. This is the 20th bit offset.
User Manual Modbus Serial Enhanced Communication Module
5.3.1 MBS.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
MBS.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 will not match the
calculated CRC.
5.3.2 MBS.DATA
This structure contains the Read Data and Write Data arrays for processor-tomodule communication.
5.3.3 MBS.CONTROL
This array handles special tasks requested by the processor.
MBS.CONTROL.PortControl
This array allows port commands to be controlled by the processor.
Page 80 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 81
MVI69E-MBS ♦ CompactLogix Platform Using Controller Tags
Tag Name
Range
Description
MBS.CONTROL.CmdControl.
CmdControlTrigger
0 or 1
Command Control:
Disable = 0, Enable = 1
MBS.CONTROL.CmdControl.
NumberOfCommands
0 to 6
Total number of commands to be executed via
Command Control
MBS.CONTROL.CmdControl.
PortNumber
1 or 2
Port number to be associated with Command Control
function
MBS.CONTROL.CmdControl.
CommandIndex[x]
0 or 1
Command Index of port command [x] to be enabled.
Up to 6 command indexes can be populated at a
time.
Modbus Serial Enhanced Communication Module User Manual
MBS.CONTROL.CmdControl
This array allows the processor to dynamically enable configured commands for
execution.
MBS.CONTROL.EventCmd_DBData
This array allows the processor to dynamically build Modbus commands with
data associated to the MBS database. This feature is meant for periodic
execution such as resetting the clock and zeroing-out counters.
ProSoft Technology, Inc. Page 81 of 154
June 28, 2017
Page 82
Using Controller Tags MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
MBS.CONTROL.EventCmd_ProcessorData
This array allows the processor to dynamically build Modbus commands with
processor data. This feature is meant for periodic execution such as resetting the
clock and zeroing-out counters.
Page 82 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 83
MVI69E-MBS ♦ CompactLogix Platform Using Controller Tags
Tag Name
Range
Description
MBS.CONTROL.SlavePoll.Portx
-
Port x slave polling control
MBS.CONTROL.SlavePoll.Portx.
EnableSlaves
0 or 1
Slave Poll request
0 = Disable, 1 = Enable
MBS.CONTROL.SlavePoll.Portx.
EnableSlaveCount
1 to 60
Number of slaves to be enabled
MBS.CONTROL.SlavePoll.Portx.
EnableSlavesIDs[x]
-
Data array associated to enable slave request
where word x corresponds to slave ID x (0-based).
1 = Enable slave
Triggers a cold boot of the module
0 = Disable, 1 = Enable
Tag Name
Range
Description
WarmBoot
0 or 1
Triggers a warm boot the module
0 = Disable, 1 = Enable
User Manual Modbus Serial Enhanced Communication Module
MBS.CONTROL.GetStatus
This tag allows the processor to retrieve status from the module.
MBS.CONTROL.ResetStatus
This tag allows the processor to reset the module status counters.
MBS.CONTROL.ColdBoot
This tag allows the processor to Coldboot the module (full reboot).
MBS.CONTROL.WarmBoot
This tag allows the processor to Warmboot the module (driver reboot).
Page 84 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 85
MVI69E-MBS ♦ CompactLogix Platform Using Controller Tags
Tag Name
Description
MBS.STATUS.PassCnt
Program cycle counter – this value is incremented each
time a complete program cycle occurs in the module
MBS.STATUS.Product
Product code
MBS.STATUS.Rev
Firmware revision level number
MBS.STATUS.OP
Operating level number
MBS.STATUS.Run
Run number
MBS.STATUS.PortxStats
Port x status
MBS.STATUS.PortxStats.CmdListReq
Total number of requests made from this port to slave
devices on the network
MBS.STATUS.PortxStats.CmdListResp
Total number of slave response messages received on
the port
MBS.STATUS.PortxStats.CmdListErr
Total number of command errors processed on the port.
These errors could be due to a bad response or
command
MBS.STATUS.PortxStats.PortReq
Total number of messages sent out of the port
MBS.STATUS.PortxStats.PortResp
Total number of messages received on the port
MBS.STATUS.PortxStats.PortErrSent
Total number of message errors sent out of the port.
MBS.STATUS.PortxStats.PortErrRec
Total number of message errors received on the port
MBS.STATUS.PortxStats.CurrErr
Not used
MBS.STATUS.PortxStats.LastErr
Not used
MBS.STATUS.Block
Backplane transfer status
MBS.STATUS.Block.Read
Total number of read blocks transferred from the module
to the processor
MBS.STATUS.Block.Write
Total number of write blocks transferred from the
processor to the module
MBS.STATUS.Block.Parse
Total number of blocks successfully parsed that were
received from the processor
MBS.STATUS.Block.Event
Total number of event command blocks received from
the processor
MBS.STATUS.Block.Cmd
Total number of command blocks received from the
processor
MBS.STATUS.Block.Err
Total number of block transfer errors recognized by the
module
MBS.STATUS.PortxLastErr
For a slave port, this field contains the value of the
current error code returned.
For a master port, this field contains the index of the
currently executing command.
MBS.STATUS.PortxPreviousErr
For a slave port, this field contains the value of the last
error code returned.
For a master port, this field contains the index of the
command with an error.
Modbus Serial Enhanced Communication Module User Manual
5.3.4 MBS.STATUS
This array contains status data for the module.
ProSoft Technology, Inc. Page 85 of 154
June 28, 2017
Page 86
Using Controller Tags MVI69E-MBS ♦ CompactLogix Platform
Tag Name
Description
MBS.UTIL.ReadDataSizeGet
Holds Read Data array size
MBS.UTIL.WriteDataSizeGet
Holds Write Data array size
MBS.UTIL.ReadDataBlkCount
Number of Read Data blocks – this value is the Read Register Count divided by the Block Transfer Size
MBS.UTIL.WriteDataBlkCount
Number of Write Data blocks – this value is the Write Register Count divided by the Block Transfer Size
MBS.UTIL.RBTSremainder
Remainder from the Read Register Count divided by the
Block Transfer Size
MBS.UTIL.WBTSremainder
Remainder from the Write Register Count divided by the
Block Transfer Size
MBS.UTIL.BlockIndex
Computed block offset for data
MBS.UTIL.LastRead
Latest Read Block ID received from the module
MBS.UTIL.LastWrite
Latest Write Block ID to be sent to the module
MBS.UTIL.LastWriteInit
Latest Write Block ID used during initialization
MBS.UTIL.ConfigFile
Holds variables for configuration file transfer
MBS.UTIL.ConfigFile.WordLength
Length of configuration data to be included in block transfer
MBS.UTIL.ConfigFile.BlockCount
Not used
MBS.UTIL.ConfigFile.FileOffset
Offset in configuration file to use as a starting point for
copying over configuration data
MBS.UTIL.ConnectionInputSize
Holds size of the Connection Input array
MBS.UTIL.BlockTransferSize
Size of the backplane transfer blocks
MBS.UTIL.SlotNumber
Slot number of the module in the rack
MBS.UTIL.EventBlockID
Holds Block ID for Event Command
MBS.UTIL.EventCmdPending
Keeps an Event Command message from being sent to the
module before the previous Event Command is completed
MBS.UTIL.PollStatusOffset
Offset in slave status data array to use as a starting point for
copying over slave status data
MBS.UTIL.CmdsAddedToQueue
Number of Command Control messages added to the
command queue
MBS.UTIL.CmdControlBlockID
Holds Block ID for Command Control
MBS.UTIL.CmdCntrlPending
Keeps a Command Control message from being sent to the
module before the previous Command Control is completed
MBS.UTIL.EventDataCmdPending
Keeps an Event Command with Data message from being
sent to the module before the previous Event Command with
Data is completed
MBS.UTIL.BootTimer
Timer used to clear both cold and warm boot requests
MBS.UTIL.PassThru[ ] Array
Holds variables used for processing pass-through messages
User Manual Modbus Serial Enhanced Communication Module
5.3.5 MBS.UTIL
The array is used for internal ladder processing, and must not be modified.
Page 86 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 87
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
In This Chapter
Ethernet LED Indicators ........................................................................ 88
LED Status Indicators ............................................................................ 88
Connecting the PC to the Module's Ethernet Port ................................. 90
Using the Diagnostics Menu in PCB ...................................................... 93
Communication Error Codes ............................................................... 100
Connecting to the Module’s Web Page ............................................... 101
Modbus Serial Enhanced Communication Module User Manual
6 Diagnostics and Troubleshooting
The MVI69E-MBS 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.
ProSoft Technology, Inc. Page 87 of 154
June 28, 2017
Page 88
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
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
or Blinking
Physical network connection detected. This LED must be ON solid
for Ethernet communication to be possible.
LED
Status
Indication
ETH
On
Ethernet communications are ok
Off
No Ethernet cable connected
P1
Green
Data is being transferred between the module and the Modbus
network on Port 1
Red
Communication error detected
Off
No Modbus network activity detected
P2
Green
Data is being transferred between the module and the Modbus
network on Port 2
Red
Communication error detected
Off
No Modbus network activity detected
CFG
Green
Configuration is ok
Yellow
Module is reading configuration
Red
Error setting up Modbus protocol driver, failed startup, or module
shutting down
Off
Processor is in Program mode
BP
Green
The LED is on when the module is performing a write operation on
the backplane. Under normal operation, the LED should blink
rapidly on and off.
Red
Major fault or module shutting down
OK
Green
Module is ok
Red
The program has detected an error or is being configured. If the
LED remains red for over 10 seconds, the program has probably
halted.
User Manual Modbus Serial Enhanced Communication Module
6.1 Ethernet LED Indicators
The Ethernet LEDs indicate the module's Ethernet port status.
6.2 LED Status Indicators
The LEDs indicate the module’s operating status.
During module configuration, the OK LED is red and the BP ACT LED is on. If
the APP, BP ACT and OK LEDs blink at a rate of every one-second, this
indicates a serious problem with the module. Call ProSoft Technology Technical
Support to arrange for repairs.
Page 88 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 89
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
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
flashes
This indicates a problem with backplane communications. A problem
could exist between the processor and any installed I/O module, not just
the MVI69E-MBS. Verify that all modules in the rack are correctly
configured.
Problem description
Steps to take
BP ACT LED (not
present on MVI56E
modules) remains OFF
or blinks slowly
MVI69 modules with
scrolling LED display:
<Backplane Status>
condition reads ERR
This indicates that backplane transfer operations are failing. Connect to
the module’s Configuration/Debug port to check this.
To establish backplane communications, verify the following items:
The processor is in RUN or REM RUN mode.
The backplane driver is loaded in the module.
The module is configured for read and write data block transfer.
The ladder logic handles all read and write block situations.
The module is properly configured in the processor I/O configuration
and ladder logic.
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, then re-insert it, and then restore power to the rack.
Modbus Serial Enhanced Communication Module User Manual
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 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 it is installed correctly.
5 Re-insert the card in the rack and turn the power back on.
6 Verify correct configuration data is being transferred to the module from the
CompactLogix or MicroLogix 1500-LRP 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
Module Errors
ProSoft Technology, Inc. Page 89 of 154
June 28, 2017
Page 90
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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 ETH1Port on the module.
6.3.1 Setting Up a Temporary IP Address
Important:ProSoft Configuration Builder (PCB) locates MVI69E-MBS modules through UDP
broadcast messages. These messages may be blocked by routers or layer 3 switches. In that
case, 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-
MBSmodule. (For instructions on opening and using a project in PCB, please
refer to Configuring the MVI69E-MBS Using PCB (page 43).
Page 90 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 91
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
Modbus Serial Enhanced Communication Module User Manual
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.
ProSoft Technology, Inc. Page 91 of 154
June 28, 2017
Page 92
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
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.
Page 92 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 93
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
Modbus Serial Enhanced Communication Module User Manual
6.4 Using the Diagnostics Menu in PCB
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, right-click the MVI69E-MBS
module and then choose DIAGNOSTICS. For instructions on opening and using
a project in PCB, please refer to Configuring the MVI69E-MBS Using PCB
(page 43).
2 After the Diagnostics window opens, click the SET UP CONNECTION button to
browse for the module’s IP address.
ProSoft Technology, Inc. Page 93 of 154
June 28, 2017
Page 94
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
3 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.
4 If the TEST CONNECTION is successful, click CONNECT. The Diagnostics
window is now visible.
Page 94 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 95
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
Modbus Serial Enhanced Communication Module User Manual
6.4.1 Diagnostics Menu
In the Diagnostics window in ProSoft Configuration Builder, the Diagnostics
menu is available through the Ethernet configuration port. The menu is arranged
as a tree structure.
ProSoft Technology, Inc. Page 95 of 154
June 28, 2017
Page 96
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
6.4.2 Monitoring Network Configuration Information
In the Diagnostics window in Prosoft Configuration Builder, click NETWORK and
then click CONFIG to view the Ethernet network configuration information.
Page 96 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 97
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
Modbus Serial Enhanced Communication Module User Manual
6.4.3 Monitoring Backplane Information
In the Diagnostics window in ProSoft Configuration Builder, click BACKPLANE
to view the backplane information. This menu has two submenus:
CONFIGURATION
STATUS
ProSoft Technology, Inc. Page 97 of 154
June 28, 2017
Page 98
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
User Manual Modbus Serial Enhanced Communication Module
6.4.4 Port x Module Information
The MODBUS PORT 1 and MODBUS PORT 2 menus include the following
submenus:
Configuration
Status (General status for the port)
Master Commands (Used when port is configured as a Modbus master)
Slave Status List (Status of each slave on the network, used when port is
configured as a Modbus master)
Master Command Status (Status code for each master command, used when
port is configured as a Modbus master)
Page 98 of 154 ProSoft Technology, Inc.
June 28, 2017
Page 99
MVI69E-MBS ♦ CompactLogix Platform Diagnostics and Troubleshooting
Modbus Serial Enhanced Communication Module User Manual
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-MBS module’s
internal database. You can view data values in ASCII, Hexadecimal, and Float
format.
ProSoft Technology, Inc. Page 99 of 154
June 28, 2017
Page 100
Diagnostics and Troubleshooting MVI69E-MBS ♦ CompactLogix Platform
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
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
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
User Manual Modbus Serial Enhanced Communication Module
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
6.5.2 Module Communication Error Codes
6.5.3 Command List Entry Errors
Page 100 of 154 ProSoft Technology, Inc.
June 28, 2017
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.