ProSoft Technology | ProSoft 1560 | User manual | ProSoft Technology ProSoft 1560 User manual

ProSoft Technology ProSoft 1560 User manual
MVI56-HART
ControlLogix Platform
HART Multi-drop Master Communication
Module
October 13, 2011
USER MANUAL
Your Feedback Please
We always want you to feel that you made the right decision to use our products. If you have suggestions, comments,
compliments or complaints about our products, documentation, or support, please write or call us.
How to Contact Us
ProSoft Technology
5201 Truxtun Ave., 3rd Floor
Bakersfield, CA 93309
+1 (661) 716-5100
+1 (661) 716-5101 (Fax)
www.prosoft-technology.com
support@prosoft-technology.com
Copyright © 2011 ProSoft Technology, Inc., all rights reserved.
MVI56-HART User Manual
October 13, 2011
®
®
®
®
®
ProSoft Technology , ProLinx , inRAx , ProTalk , and RadioLinx are Registered Trademarks of ProSoft
Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products
and services of, their respective owners.
ProSoft Technology® Product Documentation
In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments.
User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided on the enclosed CD-ROM in
®
Adobe Acrobat Reader file format (.PDFs). These product documentation files may also be freely downloaded from
our web site: www.prosoft-technology.com
Important Installation Instructions
Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b)
of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian
Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following
warnings must be heeded:
WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR
SUITABILITY FOR CLASS I, DIV. 2;
WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF
POWER BEFORE REPLACING OR WIRING MODULES
WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER
HAS BEEN SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.
MVI (Multi Vendor Interface) Modules
WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
AVERTISSEMENT - RISQUE D'EXPLOSION - AVANT DE DÉCONNECTER L'ÉQUIPEMENT, COUPER LE
COURANT OU S'ASSURER QUE L'EMPLACEMENT EST DÉSIGNÉ NON DANGEREUX.
Warnings
North America Warnings
Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b)
of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian
Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following
warnings must be heeded:
A Warning - Explosion Hazard - Substitution of components may impair suitability for Class I, Division 2.
B Warning - Explosion Hazard - When in hazardous locations, turn off power before replacing or rewiring modules.
C Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is
known to be non-hazardous.
Avertissement - Risque d'explosion - Avant de déconnecter l'équipement, couper le courant ou
s'assurer que l'emplacement est désigné non dangereux.
D
Suitable for use in Class I, Division 2 Groups A, B, C and D Hazardous Locations or Non-Hazardous Locations.
ATEX Warnings and Conditions of Safe Usage
Power, Input, and Output (I/O) wiring must be in accordance with the authority having jurisdiction.
A Warning - Explosion Hazard - When in hazardous locations, turn off power before replacing or wiring modules.
B Warning - Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is
known to be non-hazardous.
C These products are intended to be mounted in an IP54 enclosure. The devices shall provide external means to
prevent the rated voltage being exceeded by transient disturbances of more than 40%. This device must be used
only with ATEX certified backplanes.
D DO NOT OPEN WHEN ENERGIZED.
Battery Life Advisory
The MVI46, MVI56, MVI56E, MVI69, and MVI71 modules use a rechargeable Lithium Vanadium Pentoxide battery to
backup the real-time clock and CMOS. The battery should last for the life of the module. The module must be
powered for approximately twenty hours before the battery becomes fully charged. After it is fully charged, the battery
provides backup power for the CMOS setup and the real-time clock for approximately 21 days. When the battery is
fully discharged, the module will revert to the default BIOS and clock settings.
Note: The battery is not user replaceable.
Markings
Electrical Ratings
Backplane Current Load: 800 mA @ 5.1 Vdc; 3 mA @ 24 Vdc
Operating Temperature: 0°C to 60°C (32°F to 140°F)
Storage Temperature: -40°C to 85°C (-40°F to 185°F)
Shock: 30 g, operational; 50 g, non-operational; Vibration: 5 g from 10 Hz to 150 Hz
Relative Humidity: 5% to 95% with no condensation
All phase conductor sizes must be at least 1.3 mm(squared) and all earth ground conductors must be at least
4mm(squared).
Label Markings
ATEX
II 3 G
EEx nA IIC T6
0°C <= Ta <= 60°C
cULus
E183151
Class I Div 2 Groups A,B,C,D
T6
-30°C <= Ta <= 60°C
Agency Approvals and Certifications
Agency
RoHS
CE
ATEX
cULus
CB Safety
GOST-R
CSA
Korea KCC
Applicable Standard
EMC-EN61326-1:2006; EN61000-6-4:2007
EN60079-15:2003
UL508; UL1604; CSA 22.2 No. 142 & 213
CA/10533/CSA
IEC 61010-1 Ed.2; CB 243333-2056722 (2090408)
EN 61010
EN 61010
KCC-REM-PFT-MVI56-AFC
243333
ME06
E183151
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Contents
User Manual
Contents
Your Feedback Please ........................................................................................................................ 2
How to Contact Us .............................................................................................................................. 2
®
ProSoft Technology Product Documentation .................................................................................... 2
Important Installation Instructions ....................................................................................................... 3
MVI (Multi Vendor Interface) Modules ................................................................................................ 3
Warnings ............................................................................................................................................. 3
Battery Life Advisory ........................................................................................................................... 4
Markings .............................................................................................................................................. 4
Guide to the MVI56-HART User Manual
11
1
13
Start Here
1.1
1.2
1.3
1.4
1.5
1.6
1.7
1.8
1.9
2
1.7.1
1.7.2
1.7.3
System Requirements ............................................................................................. 14
Package Contents ................................................................................................... 15
Installing ProSoft Configuration Builder Software ................................................... 16
Setting Jumpers ...................................................................................................... 17
Installing the Module in the Rack ............................................................................ 18
Connecting Your PC to the ControlLogix Processor ............................................... 20
Using the Sample Ladder Logic .............................................................................. 21
Determining the Firmware Version of Your Processor ............................................ 21
Selecting the Slot Number for the Module .............................................................. 23
Configuring the RSLinx Driver for the PC COM Port .............................................. 24
Downloading the Sample Program to the Processor .............................................. 26
Connecting Your PC to the Module ......................................................................... 27
Configuring the MVI56-HART Module
2.1
2.2
2.3
2.4
3
2.1.1
2.1.2
2.2.1
2.2.2
2.2.3
2.3.1
2.3.2
Using ProSoft Configuration Builder ....................................................................... 30
Setting Up the Project ............................................................................................. 30
Renaming PCB Objects .......................................................................................... 32
MVI56-HART Configuration File .............................................................................. 34
[MODULE] ............................................................................................................... 34
[HART PORT x] ....................................................................................................... 35
[HART PORT x COMMANDS] ................................................................................ 38
Hart Command Examples ....................................................................................... 45
Example of HART Command Function 3 ................................................................ 45
Example of HART Command Function 34 .............................................................. 47
Downloading the Project to the Module Using a Serial COM Port .......................... 49
Ladder Logic
3.1
3.2
3.1.1
3.1.2
3.1.3
3.1.4
ProSoft Technology, Inc.
October 13, 2011
29
51
Using the Sample Program ..................................................................................... 52
Controller Tags ........................................................................................................ 52
Module Status Data and Variables (HARTModuleDef) ........................................... 52
Data Object (HARTData)......................................................................................... 55
Auto-Poll Data (HARTAutoPoll) .............................................................................. 56
Adding the Module to an Existing Project ............................................................... 57
Page 7 of 171
Contents
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
4
Diagnostics and Troubleshooting
4.1
4.2
5
4.1.1
4.1.2
4.1.3
4.1.4
4.1.5
4.1.6
4.1.7
4.2.1
4.2.2
Reference
5.1
61
Reading Status Data from the Module ................................................................... 62
Using ProSoft Configuration Builder (PCB) for Diagnostics ................................... 62
Main Menu .............................................................................................................. 65
HART Master Menu ................................................................................................ 67
Data Analyzer ......................................................................................................... 70
Data Analyzer Tips ................................................................................................. 73
Master Command Error List Menu.......................................................................... 75
Master Command List Menu................................................................................... 75
LED Status Indicators ............................................................................................. 76
Clearing a Fault Condition ...................................................................................... 76
Troubleshooting ...................................................................................................... 77
79
Product Specifications ............................................................................................ 80
General Specifications ............................................................................................ 80
Hardware Specifications ......................................................................................... 81
Functional Specifications ........................................................................................ 82
5.2
Functional Overview ............................................................................................... 83
5.2.1
General Concepts ................................................................................................... 83
5.2.2
Backplane Data Transfer ........................................................................................ 84
5.2.3
Normal Data Transfer ............................................................................................. 85
5.2.4
Command Control Blocks ....................................................................................... 86
5.2.5
HART Channels ...................................................................................................... 89
5.2.6
Master Driver .......................................................................................................... 90
5.3
Disabling the RSLinx Driver for the Com Port on the PC ....................................... 98
5.4
RS-232 Configuration/Debug Port ........................................................................ 100
5.5
DB9 to RJ45 Adaptor (Cable 14) .......................................................................... 101
5.6
Application Port Connection ................................................................................. 102
5.7
Example Field Terminations ................................................................................. 103
5.7.1
Notes ..................................................................................................................... 104
5.8
MVI56-HART Status Data and Error Codes ......................................................... 111
5.8.1
Error/Status Data Block ........................................................................................ 111
5.8.2
Configuration Error Word ...................................................................................... 115
5.8.3
Protocol Error Codes ............................................................................................ 116
5.9
HART Universal Commands................................................................................. 118
COMMAND 00 - Read Unique Identifier ................................................................................... 118
COMMAND 01 - Read Primary Variable ................................................................................... 119
COMMAND 02 - Read Current And Percent Of Range ............................................................ 120
COMMAND 03 - Read Dynamic Variables ............................................................................... 121
COMMAND 06 - Write Polling Address ..................................................................................... 122
COMMAND 12 - Read Message ............................................................................................... 123
COMMAND 13 - Read Tag, Descriptor and Date ..................................................................... 124
COMMAND 14 - Read PV Sensor Info ..................................................................................... 125
COMMAND 15 - Read Output Information ................................................................................ 126
COMMAND 16 - Read Final Assembly Number ....................................................................... 127
COMMAND 17 - Write Message ............................................................................................... 128
COMMAND 18 - Write Tag, Descriptor and Date ..................................................................... 129
COMMAND 19 - Write Final Assembly Number ....................................................................... 130
5.10
HART Common Practice Commands ................................................................... 131
COMMAND 33 - Read Transmitter Variables ........................................................................... 131
COMMAND 34 - Write Damping Value ..................................................................................... 132
Page 8 of 171
5.1.1
5.1.2
5.1.3
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Contents
User Manual
COMMAND 35 - Write Range Values ........................................................................................ 133
COMMAND 36 - Set Upper Range Value.................................................................................. 134
COMMAND 37 - Set Lower Range Value.................................................................................. 135
COMMAND 38 - Reset Configuration Changed Flag ................................................................ 136
COMMAND 39 - EEPROM Control ........................................................................................... 137
COMMAND 40 - Enter Exit Fixed Current Mode ....................................................................... 138
COMMAND 41 - Perform Transmitter Self Test ........................................................................ 139
COMMAND 42 - Perform Master Reset .................................................................................... 140
COMMAND 43 - Set PV Zero .................................................................................................... 141
COMMAND 44 - Write PV Units ................................................................................................ 142
COMMAND 45 - Trim DAC Zero ............................................................................................... 143
COMMAND 46 - Trim DAC Gain ............................................................................................... 144
COMMAND 47 - Write Transfer Function .................................................................................. 145
COMMAND 48 - Read Additional Transmitter Status ................................................................ 146
COMMAND 49 - Write PV Sensor Serial Number ..................................................................... 147
COMMAND 50 - Read Dynamic Variable Assignments ............................................................ 148
COMMAND 51 - Write Dynamic Variable Assignments ............................................................ 149
COMMAND 52 - Set Transmitter Variable Zero ........................................................................ 150
COMMAND 53 - Write Transmitter Variable Units .................................................................... 151
COMMAND 54 - Read Transmitter Variable Information .......................................................... 152
COMMAND 55 - Write Transmitter Variable Damping Value .................................................... 153
COMMAND 56 - Write Transmitter Variable Sensor Serial Number ......................................... 154
COMMAND 57 - Read Unit Tag Descriptor Date ...................................................................... 155
COMMAND 58 - Write Unit Tag Descriptor Date ...................................................................... 156
COMMAND 59 - Write Number Of Response Preambles ......................................................... 157
COMMAND 108 - Write Burst Mode Command Number .......................................................... 158
COMMAND 109 - Burst Mode Control....................................................................................... 159
COMMAND 110 - Read All Dynamic Variables ......................................................................... 160
6
Support, Service & Warranty
161
Contacting Technical Support ......................................................................................................... 161
6.1
Return Material Authorization (RMA) Policies and Conditions.............................. 163
6.1.1
Returning Any Product .......................................................................................... 163
6.1.2
Returning Units Under Warranty ........................................................................... 164
6.1.3
Returning Units Out of Warranty ........................................................................... 164
6.2
LIMITED WARRANTY........................................................................................... 165
6.2.1
What Is Covered By This Warranty ....................................................................... 165
6.2.2
What Is Not Covered By This Warranty ................................................................ 166
6.2.3
Disclaimer Regarding High Risk Activities ............................................................ 166
6.2.4
Intellectual Property Indemnity .............................................................................. 167
6.2.5
Disclaimer of all Other Warranties ........................................................................ 167
6.2.6
Limitation of Remedies ** ...................................................................................... 168
6.2.7
Time Limit for Bringing Suit ................................................................................... 168
6.2.8
No Other Warranties ............................................................................................. 168
6.2.9
Allocation of Risks ................................................................................................. 168
6.2.10
Controlling Law and Severability ........................................................................... 168
Index
ProSoft Technology, Inc.
October 13, 2011
169
Page 9 of 171
Contents
User Manual
Page 10 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Guide to the MVI56-HART User Manual
User Manual
Guide to the MVI56-HART User Manual
Function
Section to Read
Introduction
(Must Do)
Start Here (page 12) This section introduces the customer to the
module. Included are: package contents,
system requirements, hardware installation, and
basic configuration.
Diagnostic and
Troubleshooting
Diagnostics and
Troubleshooting
(page 61)
Reference
Reference (page 79) These sections contain general references
associated with this product and its
Specifications..
Product
Specifications (page
80)
Product Specifications
Support, Service, and
Warranty
Support, Service
and Warranty (page
161)
Index
Details
This section describes Diagnostic and
Troubleshooting procedures.
This section contains Support, Service and
Warranty information.
Index of chapters.
Index
ProSoft Technology, Inc.
October 13, 2011
Page 11 of 171
Guide to the MVI56-HART User Manual
User Manual
Page 12 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
1
Start Here
User Manual
Start Here
In This Chapter
System Requirements ........................................................................... 14
Package Contents ................................................................................. 15
Installing ProSoft Configuration Builder Software .................................. 16
Setting Jumpers .................................................................................... 17
Installing the Module in the Rack........................................................... 18
Connecting Your PC to the ControlLogix Processor.............................. 20
Using the Sample Ladder Logic ............................................................ 21
Downloading the Sample Program to the Processor ............................. 26
Connecting Your PC to the Module ....................................................... 27
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 HART and
ControlLogix devices to a power source and to the MVI56-HART module’s application
port(s)
ProSoft Technology, Inc.
October 13, 2011
Page 13 of 171
Start Here
User Manual
1.1
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
System Requirements
The MVI56-HART module requires the following minimum hardware and software
components:
Rockwell Automation ControlLogix™ processor, with compatible power supply and
one free slot in the rack, for the MVI56-HART module. The module requires 800 mA
of available power.
Rockwell Automation RSLogix 5000 programming software version 2.51 or higher
Rockwell Automation RSLinx communication software
®
Pentium II 450 MHz minimum. Pentium III 733 MHz (or better) recommended
Supported operating systems:
o Microsoft Windows XP Professional with Service Pack 1 or 2
o Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3
o Microsoft Windows Server 2003
128 Mbytes of RAM minimum, 256 Mbytes of RAM recommended
100 Mbytes of free hard disk space (or more based on application requirements)
256-color VGA graphics adapter, 800 x 600 minimum resolution (True Color 1024
768 recommended)
CD-ROM drive
ProSoft Configuration Builder, HyperTerminal or other terminal emulator program.
Note: You can install the module in a local or remote rack. For remote rack
installation, the module requires EtherNet/IP or ControlNet communication with
the processor.
Page 14 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
1.2
Start Here
User Manual
Package Contents
The following components are included with your MVI56-HART module, and are all
required for installation and configuration.
Important: Before beginning the installation, please verify that all of the following
items are present.
Qty.
Part Name
Part Number
Part Description
1
MVI56-HART Module MVI56-HART
HART Multi-drop Master Communication
Module
1
Cable
Cable #15, RS232
Null Modem
For RS232 Connection to the CFG Port
1
Cable
Cable #14, RJ45 to
DB9 Male Adapter
cable
For DB9 Connection to Module’s Port
If any of these components are missing, please contact ProSoft Technology Support for
replacement parts.
ProSoft Technology, Inc.
October 13, 2011
Page 15 of 171
Start Here
User Manual
1.3
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Installing ProSoft Configuration Builder Software
You must install the ProSoft Configuration Builder (PCB) software to configure the
module. You can always get the newest version of ProSoft Configuration Builder from the
ProSoft Technology website.
To install ProSoft Configuration Builder from the ProSoft Technology website
1 Open your web browser and navigate to http://www.prosoft-technology.com/pcb
2 Click the link at the Current Release Version section to download the latest version of
ProSoft Configuration Builder.
3 Choose SAVE or SAVE FILE when prompted.
4 Save the file to your Windows Desktop, so that you can find it easily when you have
finished downloading.
5 When the download is complete, locate and open the file, and then follow the
instructions on your screen to install the program.
If you do not have access to the Internet, you can install ProSoft Configuration Builder
from the ProSoft Solutions Product CD-ROM, included in the package with your module.
To install ProSoft Configuration Builder from the Product CD-ROM
1 Insert the ProSoft Solutions Product CD-ROM into the CD-ROM drive of your PC.
Wait for the startup screen to appear.
2 On the startup screen, click PRODUCT DOCUMENTATION. This action opens a Windows
Explorer file tree window.
3 Click to open the UTILITIES folder. This folder contains all of the applications and files
you will need to set up and configure your module.
4 Double-click the SETUP CONFIGURATION TOOL folder, double-click the PCB_*.EXE file
and follow the instructions on your screen to install the software on your PC. The
information represented by the "*" character in the file name is the PCB version
number and, therefore, subject to change as new versions of PCB are released.
Note: Many of the configuration and maintenance procedures use files and other
utilities on the CD-ROM. You may wish to copy the files from the Utilities folder
on the CD-ROM to a convenient location on your hard drive.
Page 16 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
1.4
Start Here
User Manual
Setting Jumpers
The Setup Jumper acts as "write protection" for the module’s flash memory. In "write
protected" mode, the Setup pins are not connected, and the module’s firmware cannot be
overwritten. Do not jumper the Setup pins together unless you are directed to do so by
ProSoft Technical Support.
The following illustration shows the MVI56-HART jumper configuration.
Note: If you are installing the module in a remote rack, you may prefer to leave
the Setup pins jumpered. That way, you can update the module’s firmware
without requiring physical access to the module.
ProSoft Technology, Inc.
October 13, 2011
Page 17 of 171
Start Here
User Manual
1.5
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Installing the Module in the Rack
If you have not already installed and configured your ControlLogix processor and power
supply, please do so before installing the MVI56-HART module. Refer to your Rockwell
Automation product documentation for installation instructions.
Warning: You must follow all safety instructions when installing this or any other
electronic devices. Failure to follow safety procedures could result in damage to
hardware or data, or even serious injury or death to personnel. Refer to the
documentation for each device you plan to connect to verify that suitable safety
procedures are in place before installing or servicing the device.
After you have checked the placement of the jumpers, insert MVI56-HART into the
ControlLogix chassis. Use the same technique recommended by Rockwell Automation to
remove and install ControlLogix modules.
Warning: When you insert or remove the module while backplane power is on,
an electrical arc can occur. This could cause an explosion in hazardous location
installations. Verify that power is removed or the area is non-hazardous before
proceeding. Repeated electrical arcing causes excessive wear to contacts on
both the module and its mating connector. Worn contacts may create electrical
resistance that can affect module operation.
1
2
Turn power OFF.
Align the module with the top and bottom guides, and slide it into the rack until the
module is firmly against the backplane connector.
Page 18 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
3
4
5
6
Start Here
User Manual
With a firm but steady push, snap the module into place.
Check that the holding clips on the top and bottom of the module are securely in the
locking holes of the rack.
Make a note of the slot location. You must identify the slot in which the module is
installed in order for the sample program to work correctly. Slot numbers are
identified on the green circuit board (backplane) of the ControlLogix rack.
Turn power ON.
Note: If you insert the module improperly, the system may stop working, or may
behave unpredictably.
ProSoft Technology, Inc.
October 13, 2011
Page 19 of 171
Start Here
User Manual
1.6
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Connecting Your PC to the ControlLogix Processor
There are several ways to establish communication between your PC and the
ControlLogix processor. The following steps show how to establish communication
through the serial interface. It is not mandatory that you use the processor's serial
interface. You may access the processor through whatever network interface is available
on your system. Refer to your Rockwell Automation documentation for information on
other connection methods.
1 Connect the right-angle connector end of the cable to your controller at the
communications port.
2
Connect the straight connector end of the cable to the serial port on your computer.
Page 20 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
1.7
Start Here
User Manual
Using the Sample Ladder Logic
The sample program for your MVI56-HART module includes custom tags, data types,
and ladder logic for data I/O and status monitoring. For most applications, you can run
the sample ladder program without modification, or, for advanced applications, you can
incorporate the sample program into your existing application.
The inRAx Solutions CD provides one or more versions of the sample ladder logic. The
version number appended to the file name corresponds with the firmware version number
of your ControlLogix processor. The firmware version and sample program version must
match.
1.7.1 Determining the Firmware Version of Your Processor
Important: The RSLinx service must be installed and running on your computer
in order for RSLogix to communicate with the processor. Refer to your RSLinx
and RSLogix documentation for help configuring and troubleshooting these
applications.
1
2
3
4
Connect an RS-232 serial cable from the COM (serial) port on your PC to the
communication port on the front of the processor.
Start RSLogix 5000 and close any existing project that may be loaded.
Open the COMMUNICATIONS menu and choose GO ONLINE. RSLogix will establish
communication with the processor. This may take a few moments.
When RSLogix has established communication with the processor, the Connected To
Go Online dialog box will open.
ProSoft Technology, Inc.
October 13, 2011
Page 21 of 171
Start Here
User Manual
5
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
In the Connected To Go Online dialog box, click the GENERAL tab. This tab shows
information about the processor, including the Revision (firmware) version. In the
following illustration, the firmware version is 17.2.
Page 22 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Start Here
User Manual
1.7.2 Selecting the Slot Number for the Module
This sample application is for a module installed in Slot 1 in a ControlLogix rack. The
ladder logic uses the slot number to identify the module. If you are installing the module
in a different slot, you must update the ladder logic so that program tags and variables
are correct, and do not conflict with other modules in the rack.
To change the slot number
1 In the Controller Organization list, select the module and then click the right mouse
button to open a shortcut menu.
2 On the shortcut menu, choose PROPERTIES. This action opens the Module Properties
dialog box.
In the Slot field, use the spinners on the right side of the field to select the slot
number where the module will reside in the rack, and then click OK.
RSLogix will automatically apply the slot number change to all tags, variables and ladder
logic rungs that use the MVI56-HART slot number for computation.
3
ProSoft Technology, Inc.
October 13, 2011
Page 23 of 171
Start Here
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
1.7.3 Configuring the RSLinx Driver for the PC COM Port
If RSLogix is unable to establish communication with the processor, follow these steps.
1 Open RSLinx.
2 Open the COMMUNICATIONS menu, and choose CONFIGURE DRIVERS.
This action opens the Configure Drivers dialog box.
Note: If the list of configured drivers is blank, you must first choose and configure
a driver from the Available Driver Types list. The recommended driver type to
choose for serial communication with the processor is RS-232 DF1 Devices.
Page 24 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Start Here
User Manual
3
Click to select the driver, and then click CONFIGURE. This action opens the Configure
RS-232 DF1 Devices dialog box.
4
Click the AUTO-CONFIGURE button. RSLinx will attempt to configure your serial port to
work with the selected driver.
When you see the message Auto Configuration Successful, click the OK button to
dismiss the dialog box.
5
Note: If the auto-configuration procedure fails, verify that the cables are
connected correctly between the processor and the serial port on your computer,
and then try again. If you are still unable to auto-configure the port, refer to your
RSLinx documentation for further troubleshooting steps.
ProSoft Technology, Inc.
October 13, 2011
Page 25 of 171
Start Here
User Manual
1.8
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Downloading the Sample Program to the Processor
Note: The key switch on the front of the ControlLogix processor must be in the
REM or PROG position.
1
2
3
4
If you are not already online with the processor, open the Communications menu,
and then choose DOWNLOAD. RSLogix 5000 will establish communication with the
processor. You do not have to download through the processor's serial port, as
shown here. You may download through any available network connection.
When communication is established, RSLogix 5000 will open a confirmation dialog
box. Click the DOWNLOAD button to transfer the sample program to the processor.
RSLogix 5000 will compile the program and transfer it to the processor. This process
may take a few minutes.
When the download is complete, RSLogix 5000 will open another confirmation dialog
box. If the key switch is in the REM position, click OK to switch the processor from
PROGRAM mode to RUN mode.
Note: If you receive an error message during these steps, refer to your RSLogix
documentation to interpret and correct the error.
Page 26 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
1.9
Start Here
User Manual
Connecting Your PC to the Module
With the module securely mounted, connect your PC to the Configuration/Debug port
using the RJ45-DB-9 Serial Adapter Cable and the Null Modem Cable included in the
package with the MVI56-HART module.
1 Connect the RJ45-DB-9 Serial Adapter Cable to the Null Modem Cable.
2 Insert the RJ45 cable connector from the RJ45-DB-9 cable into the
Configuration/Debug port of the module.
3 Attach the other end to the serial port on your PC.
ProSoft Technology, Inc.
October 13, 2011
Page 27 of 171
Start Here
User Manual
Page 28 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
2
Configuring the MVI56-HART Module
User Manual
Configuring the MVI56-HART Module
In This Chapter
Using ProSoft Configuration Builder ...................................................... 30
MVI56-HART Configuration File ............................................................ 34
Hart Command Examples ..................................................................... 45
Downloading the Project to the Module Using a Serial COM Port ......... 49
ProSoft Technology, Inc.
October 13, 2011
Page 29 of 171
Configuring the MVI56-HART Module
User Manual
2.1
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Using ProSoft Configuration Builder
ProSoft Configuration Builder (PCB) provides a convenient way to manage module
configuration files customized to meet your application needs. PCB is not only a powerful
solution for new configuration files, but also allows you to import information from
previously installed (known working) configurations to new projects.
2.1.1 Setting Up the Project
To begin, start PROSOFT CONFIGURATION BUILDER (PCB).
If you have used other Windows configuration tools before, you will find the screen layout
familiar. PCB’s window consists of a tree view on the left, and an information pane and a
configuration pane on the right side of the window. When you first start PCB, the tree
view consists of folders for Default Project and Default Location, with a Default Module in
the Default Location folder. The following illustration shows the PCB window with a new
project.
Page 30 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
Adding the MVI56-HART module to the project
1
2
3
Use the mouse to select DEFAULT MODULE in the tree view, and then click the right
mouse button to open a shortcut menu.
On the shortcut menu, choose CHOOSE MODULE TYPE. This action opens the Choose
Module Type dialog box.
In the Product Line Filter area of the dialog box, select MVI56. In the Select Module
Type dropdown list, select MVI56-HART, and then click OK to save your settings and
return to the ProSoft Configuration Builder window.
ProSoft Technology, Inc.
October 13, 2011
Page 31 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
2.1.2 Renaming PCB Objects
Notice that the contents of the information pane and the configuration pane changed
when you added the module to the project.
At this time, you may wish to rename the Default Project and Default Location folders in
the tree view.
1 Select the object, and then click the right mouse button to open a shortcut menu.
From the shortcut menu, choose RENAME.
2 Type the name to assign to the object.
3 Click away from the object to save the new name.
Configuring Module Parameters
1
Click the [+] sign next to the module icon to expand module information.
2
Click the [+] sign next to any
options.
3
4
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.
Click OK to save your changes.
5
Page 32 of 171
icon to view module information and configuration
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
Creating Optional Comment Entries
1
2
Click the [+] to the left of the
icon to expand the module comments.
Double-click the
icon. The Edit - Module Comment dialog box appears.
3
Enter your comment and click OK to save your changes.
Printing a Configuration File
1
2
3
4
Select the module icon, and then click the right mouse button to open a shortcut
menu.
On the shortcut menu, choose VIEW CONFIGURATION. This action opens the View
Configuration window.
In the View Configuration window, open the FILE menu, and choose PRINT. This
action opens the Print dialog box.
In the Print dialog box, choose the printer to use from the drop-down list, select
printing options, and then click OK.
ProSoft Technology, Inc.
October 13, 2011
Page 33 of 171
Configuring the MVI56-HART Module
User Manual
2.2
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
MVI56-HART Configuration File
The configuration file for MVI56-HART consists of the following sections.
Section
Description
[MODULE]
General module level parameters
[HART PORT 0]
HART Port (Channel) 0 configuration parameters
[HART PORT 0 COMMANDS]
HART command list for Port (Channel) 0
[HART PORT 1]
HART Port (Channel) 1 configuration parameters
[HART PORT 1 COMMANDS]
HART command list for Port (Channel) 1
2.2.1 [MODULE]
The [Module] section contains the data that applies to the whole module and includes the
backplane data transfer parameters.
Module Name
0 to 80 characters
This parameter 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 3999
This parameter specifies the starting register address of a block of data registers to
transfer from the module to the processor. This will be used for data brought into the
processor from other nodes on the network.
Write Register Count
0 to 4000
This parameter specifies the number of registers to transfer from the processor to the
module.
Write Register Start
0 to 3999
This parameter specifies the starting register address of a module register block where
data transferred from the processor will be stored. This will be used for data to be sent
from the processor to other nodes on the network.
Write Register Count
Range 0 to 4000
This parameter specifies the number of registers to transfer from the processor to the
module. Valid entry for this parameter is 0 to 4000.
Page 34 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
Error/Status Offset
-1 or 0 to 3935
This parameter defines the database location where the module status data will be
stored. If set to -1, data not placed in database.
Failure Flag Count
0 through 65535
This parameter specifies the number of successive transfer errors that must occur before
halting communication on the application port(s). If the parameter is set to 0, the
application port(s) will continue to operate under all conditions. If the value is set larger
than 0 (1 to 65535), communications will cease if the specified number of failures occur.
Initializing Output Data
YES or NO
This parameter determines if the output data for the module should be initialized with
values from the processor. If the value is set to NO (0), the output data will be initialized to
0. If the value is set to YES (1), the data will be initialized with data from the processor.
Setting this option to YES requires associated ladder logic to pass the data from the
processor to the module.
2.2.2 [HART PORT x]
The [HART PORT x] sections of the configuration file set the HART channel
communication parameters, define the protocol specifics and set the command list
parameters. The parameters are the same for all ports. The command list for each HART
channel is entered in a different section of the file.
Enabled
Y or N
This parameter enables or disables the specific HART channel. If the parameter is set to
"Y", the channel will be utilized. If set to "N", the channel will not be used.
Preambles
5 to 20
This parameter sets the number of preambles to be transmitted before each message is
sent from the channel. The value of 5 is normally utilized for the parameter. It can be set
to a value from 5 to 20.
Primary Master
Y or N
This parameter determines if the specific HART channel will emulate a primary or
secondary master. You can have only one of each type on a HART network. If you plan
on using a handheld device (secondary master), you must set the parameter to 'Y'. If the
parameter is set to 'Y', the channel will act as the primary master. A value of 'N' will set
the channel to act as a secondary master.
ProSoft Technology, Inc.
October 13, 2011
Page 35 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Retry Count
0 to 10
This parameter sets the number of retries for a command if the command response is not
received from the slave device. This parameter is normally set to a value of 3. The
module will accept values of 0 to 10.
DB Address Status
-1, 0 to 3999
This parameter is utilized to set the database address in the module where the status
word for the channel will be placed. If the parameter is set to -1, the word value will not
be placed in the database. If a value from 0 to 3999 is set for the parameter, the status
word for the channel will be placed at the specified database offset. This word is bit
mapped with each bit representing a slave device. The bit will be set if slave device has a
communication error.
Slave List Status
The configuration parameter "DB Address Status" defines the register address in the
virtual database where the status data for each HART channel will be placed. This word
has one bit for each HART device and if this bit is in "1" it means that the corresponding
HART device is not answering to the poll.
Bit
15
14
13
12
11
10
9
8
7
6
5
4
3
2
1
0
HART
Device
15
14
13
12
11
10
9
8
7
6
5
4
3
2
1
0
The bit 0 of the "Slave List Status" is used for a slave connected in a point-to-point
configuration. In this mode, the slave’s 4 to 20 milliamp signal will also be active and can
be utilized by an analog input or out module depending on the signal type.
Command Count
0 to 99
This parameter sets the number of user commands to be utilized. The first command in
the list is always reserved for the auto-poll command so the user should configure this
value considering one command for the auto-poll. For example, if the user configures two
commands, the command count parameter should be set as 3. This parameter can be
set from 0 to 99. If the parameter is set to a value other than 0, commands should be
present in the [HART PORT x COMMANDS] section.
Auto-Poll Code
p2p, multidrop, or Not used
This parameter sets the auto-poll mode of the channel. If the parameter is set to "p2p",
the module will automatically poll device 0 in point-to-point mode. If the parameter is set
to "multidrop", the module will automatically poll multiple devices. If the parameter is set
to "Not used", the auto-polling option will be disabled and only commands in the
command list will be utilized for the channel. In the auto-poll mode, the module will
automatically execute HART commands 0, 3, 13, 14, and 15.
Page 36 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
Auto-Poll DB Address
0 to 3700
This parameter sets the starting address for the data obtained by the auto-poll feature.
Each device on a channel requires 50 words in the database. The data area selected
must not overlap any portion of the database used by other channels or the module.
Auto-Poll Swap Float
0 to 3
This parameter swaps the floating-point data values received by the auto-poll feature.
Swap Code
Description
0
None - No Change is made in the byte ordering (1234 = 1234)
1
Words - The words are swapped (1234=3412)
2
Words & Bytes - The words are swapped then the bytes in each word are
swapped (1234=4321)
3
Bytes - The bytes in each word are swapped (1234=2143)
Depending on the host processor using the data, the proper swap code must be utilized
to present the data in the correct format.
Max Device Count
1 to 15
This parameter sets the maximum number of slave devices to be utilized for the auto-poll
feature. In point-to-point mode, the parameter should be set to a value of 1. In multi-drop
mode, the parameter should be set from 1 to 15 to represent the number of slave devices
attached to the channel.
ProSoft Technology, Inc.
October 13, 2011
Page 37 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
2.2.3 [HART PORT x COMMANDS]
The [HART PORT x COMMANDS] sections of the configuration file contain the userdefined HART command lists for each channel. The commands in these lists are sent to
slave devices attached to the HART channels. The module supports up to 100
commands per channel.
Command List Overview
The MVI56-HART module uses a command list to interface with HART slave devices.
The commands in the list specify
the slave device to be addressed
the function to be performed (read or write)
the registers in the internal database to be associated with the device data.
There is a separate command list for each HART channel, with up to 100 commands
allowed per channel. The command list is processed from top (Command #0) to bottom
(Command #99), then the process is repeated.
A poll interval parameter is associated with each command to specify a minimum delay
time in seconds between the issuance of a command. For example, a poll interval of 10
executes the command no more frequently than every 10 seconds.
Write commands have a special feature, as they can be set to execute only if the data in
the write command changes. If the register data values in the command have not
changed since the command was last issued, the command will not be executed. If the
data in the command has changed since the command was last issued, the command
will be executed. Use of this feature can lighten the load on the HART network. In order
to implement this feature, set the enable code for the command to a value of 2.
The module supports all the Universal (page 118) and Common Practice (page 131)
commands, as well as device specific commands. A Device Specific command is
supported without any translation of the data.
Page 38 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
Commands Supported by the Module
The format of each command in the list is independent on the function being executed.
All parameters in the command table must be entered. Only one parameter is optional,
the Fixed Data field, which contains data to be sent to a HART device. The tables below
list the functions supported by the module:
HART Universal Commands Set
Command
Definition
00
Read Unique Identifier
01
Read Primary Variable
02
Read Current And Percent Of Range
03
Read Dynamic Variables
06
Write Polling Address
07
Read Loop Configuration
08
Read Dynamic Variable Classifications
09
Read Device Variables with Status
11
Read Unique Identifier Associated With Tag
12
Read Message
13
Read Tag Descriptor Date
14
Read PV Sensor Info
15
Read Output Information
16
Read Final Assembly Number
17
Write Message
18
Write Tag Descriptor Date
19
Write Final Assembly Number
20
Read Long Tag
21
Read Unique Identifier Associated With Long Tag
22
Write Long Tag
HART Common Practice Commands Set
Command
Definition
33
Read Transmitter Variables
34
Write Damping Value
35
Write Range Values
36
Set Upper Range Value
37
Set Lower Range Value
38
Reset Configuration Changed Flag
39
EEPROM Control
40
Enter Exit Fixed Current Mode
41
Perform Transmitter Self Test
42
Perform Master Reset
43
Set PV Zero
44
Write PV Units
ProSoft Technology, Inc.
October 13, 2011
Page 39 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Command
Definition
45
Trim DAC Zero
46
Trim DAC Gain
47
Write Transfer Function
48
Read Additional Transmitter Status
49
Write PV Sensor Serial Number
50
Read Dynamic Variable Assignments
51
Write Dynamic Variable Assignments
52
Set Transmitter Variable Zero
53
Write Transmitter Variable Units
54
Read Transmitter Variable Information
55
Write Transmitter Variable Damping Value
56
Write Transmitter Variable Sensor Serial Number
57
Read Unit Tag Descriptor Date
58
Write Unit Tag Descriptor Date
59
Write Number Of Response Preambles
60
Read Analog Channel and Percent of Range
61
Read Dynamic Variables and PV Analog Ch
62
Read Analog Channels
63
Read Analog Channel Information
64
Write Analog Channel Additional Damping Value
65
Write Analog Channel Range Values
66
Enter/Exit Fixed Analog Channel Mode
67
Trim Analog Channel Zero
68
Trim Analog Channel Gain
69
Write Analog Channel Transfer Function
70
Read Analog Channel Endpoint Values
71
Lock Device
72
Squawk
73
Find Device
74
Read I/O System Capabilities
75
Poll Sub-Device
76
Read Lock Device State
79
Write Device Variable
80
Read Device Variable Trim Points
81
Read Device Variable Trim Guidelines
82
Write Device Variable Trim Point
83
Reset Device Variable Trim
105
Read Burst Mode Configuration
106
Flush Delayed Responses
107
Write Burst Device Variables
108
Write Burst Mode Command Number
Page 40 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Command
Definition
109
Burst Mode Control
110
Read All Dynamic Variables
Configuring the MVI56-HART Module
User Manual
HART Command Entry Formats
Refer to the Reference (page 39, page 79, page 118) chapter for a complete discussion
of the HART commands supported by the module, and the structure and content of the
data returned for each command.
The following illustration shows a command list section of the configuration file:
Enable
0, 1, 2, 3, 4, 5
This field defines whether the command is to be executed and under what conditions.
Code
0
1
2
3
4
5
Description
The command is disabled and will not be executed in the normal polling
sequence. This can be used to process a command from a bursting slave
device.
Causes the command to be executed each scan of the command list if the Poll
Interval Time is set to zero. If the Poll Interval time is set, the command will be
executed, when the interval timer expires.
The command will execute only if the internal data associated with the command
changes. This value is valid only when there is a specified "Write DB Address"
(see below) with a non zero byte count for write commands.
The HART module will send the command if either the MVI56-HART module OR
the HART device is powered up. This is mainly used for configuration of HART
devices on startup.
Places the command in enabled mode. This option is valid only if there is a
specified "Enabled DB Address" (see below). If the Virtual Database word
specified in "Enabled DB Address" has "-1" the command will be executed
otherwise it will not.
Places the command in one shot enabled mode. This option is valid only if there
is a specified "Enabled DB Address" (see below). If the Virtual Database word
specified in "Enabled DB Address" has a value of "-1" the command will be
executed otherwise it will not. When the command has been successful the
Virtual Database word specified in "Enabled DB Address" will be written with "0",
so the command will be executed only once.
Refer to Command Enable Control Block (9902) (page 86) and Command Disable
Control Block (9903) (page 87) for more information on how to use the enable code.
ProSoft Technology, Inc.
October 13, 2011
Page 41 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Float DB Address
0 to 3998
This field specifies the internal database register where the floating point values returned
by the command will be placed.
Poll Interval
0 TO 65535
This parameter specifies the minimum interval between executions of a continuous
commands (Enable code of 1). The value is in seconds. Therefore, if a value of 10 is
entered, the command will execute no more frequently than once every 10 seconds.
FP Word Count
-1 to 125
This parameter specifies the number of words from the floating point data returned by a
HART command that will be placed on the Virtual Database. If this parameter is 0 no data
will be written to the Database. If this parameter is -1 then all the floating point data will
be written in the integer block of data.
Special care should be taken with this number, because is a word count and a floating
point value is 2 words long. For example if you execute a HART command 3 which takes
5 floating point values from the device, you should place a word count of 10 words.
Swap Code
0, 1, 2, 3
This parameter defines the byte order of each four-byte group of data received. This
parameter is helpful when dealing with floating-point or other multi-register values, as
there is no standard byte order for storing these data types. The following table describes
the values and their associated operations:
Swap Code
Description
0
None - No Change is made in the byte ordering (1234 = 1234)
1
Words - The words are swapped (1234=3412)
2
Words & Bytes - The words are swapped then the bytes in each word are
swapped (1234=4321)
3
Bytes - The bytes in each word are swapped (1234=2143)
Short Address
0 = Point-to-Point
1 to 15 = Multi-drop
This parameter specifies the HART slave node address on the network to which the
command will be sent. Values of 0, or 1 to 15 are permitted. If the device to be addressed
only accepts long address, then the parameter "Use Long" should be selected so the
module can ask for the long address with the short one and then execute the command.
Page 42 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
Function Code
0 to 255
This parameter specifies the HART function to be executed. Any HART function can be
executed, even device specific ones, but only supported commands will return formatted
data and classified in floating point data and integer data.
Int. DB Address
0 to 3999
This field specifies the internal database register where the integer or packed ASCII
string values returned by the command will be placed.
If the Floating Point Word Count parameter is "-1", then all the data returned by the
HART command will be placed in this address without any formatting.
Int Word Count
0 to 125
This parameter specifies the number of words from the integer or packed ASCII string
data returned by a HART command that will be placed on the Virtual Database. If this
parameter is "0", no data will be written to the Database.
Swap Code
0, 1, 2, 3
This parameter defines the byte order of each four-byte group of data received. This
parameter is helpful when dealing with floating-point or other multi-register values, as
there is no standard byte order for storing these data types. The following table describes
the values and their associated operations:
Swap Code
Description
0
None - No Change is made in the byte ordering (1234 = 1234)
1
Words - The words are swapped (1234=3412)
2
Words & Bytes - The words are swapped then the bytes in each word are
swapped (1234=4321)
3
Bytes - The bytes in each word are swapped (1234=2143)
Use Long
0 or 1
This parameter defines if the command will be executed with short or long address. If the
value is "0", then the configured command will be executed using the Short Address
specified. If the value is "1" then the specified Short Address will be used only to ask for
the long address and that will be used to execute the configured command.
Enable DB Address
0 to 3999
This field specifies the internal database register to be used to enable the execution of a
command. This parameter is only used if "Enable" is "4" or "5". If the value of this
database register is "-1", then the command will be executed, otherwise it will not. If the
"Enable" value is "5", then after the successful execution of the command this value will
become "0"
ProSoft Technology, Inc.
October 13, 2011
Page 43 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Done DB Address
-1 to 3999
This field specifies the internal database register to be used to signal the successful
execution of a command. When a command is successfully executed a "-1" is written to
this register. This "Done DB Address" can be shared with the "Enable DB Address" of
another command to do a chained command execution.
Write DB Address
-1 to 7999 Bytes
This field specifies the internal database register to use as a source of data for HART
commands that include data. It is possible to include data with every HART command,
but only if the command and the device will accept this data.
If this value is "-1", it indicates that there will not be data with the command or that it will
not come from the database.
Note: This value is specified in Bytes, not Words.
Swap Code
0, 1, 2, 3
This parameter defines the byte order of each four-byte group of data received. This
parameter is helpful when dealing with floating-point or other multi-register values, as
there is no standard byte order for storing these data types. The following table describes
the values and their associated operations:
Swap Code
Description
0
None - No Change is made in the byte ordering (1234 = 1234)
1
Words - The words are swapped (1234=3412)
2
Words & Bytes - The words are swapped then the bytes in each word are
swapped (1234=4321)
3
Bytes - The bytes in each word are swapped (1234=2143)
Byte Count
0 to 250
This parameter specifies the number of bytes to be sent to a HART device in the
command. If the command has no data then this value should be "0".
If the value of this field is different of "0" and "Write DB Address" is different of "-1" then
the data for the command will be taken from the Virtual Database. If the value of this field
is different of "0" and "Write DB Address" is "-1" then the data for the command will be
from the "Fixed Data" field for the command.
Fixed Data
Up to 250 HEX values separated by space
This parameter is a string of HEX values to be sent with the HART command. There
should be at least the number of bytes specified in the "Byte Count" parameter. The
bytes should be written in hexadecimal format and separated by a space. This data will
be sent if the Parameter "Write DB Address" is "-1" and "Byte Count" is greater than "0",
and it will be sent in the same order that they are written.
Page 44 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
2.3
Configuring the MVI56-HART Module
User Manual
Hart Command Examples
This section describes two examples that shows how to configure HART commands. The
first example shows a read command (function code 3 - READ DYNAMIC VARIABLES)
and the second example shows a write command (function 34 - WRITE DAMPING
VALUE).
2.3.1 Example of HART Command Function 3
The following example shows how to configure a command function 3 (READ DYNAMIC
VARIABLES) to read the process variables from the HART slave device. According to the
HART specification, this command will return four floating-point variables:
Word
High Byte
0
Current (mA)
Low Byte
1
2
Primary Variable
3
4
Second Variable
5
6
Third Variable
7
8
Fourth Variable
9
The command also returns the following integer data:
Word
High Byte
Low Byte
0
Status Word
1
Primary Variable Units Code
Second Variable Units Code
2
Third Variable Units Code
Fourth Variable Units Code
So, this command will return the following number of words:
Parameter
Data Type
Direction
Number of
Words
Database
Address
(this example)
Variable Results
Floating Point
Read from slave to MVI
10
240 (word address)
Status/Unit Codes
Integer
Read from slave to MVI
3
290 (word address)
The user can configure the command parameters as described in the following table in
order to correctly read the command 3 results to the module database:
Index
Parameter
1
Enable
1
The command is sent continuously
2
Float DB
Address
240
The floating point results will be copied to the internal
database starting at word-address 240 (from 240 to
249)
3
Poll Interval
0
The command is sent without any delay
4
Word Count
10
The command returns 10 words of floating point data
5
Swap Code
3
The bytes in each returned floating point word are
swapped
ProSoft Technology, Inc.
October 13, 2011
Value
Observation
Page 45 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Index
Parameter
Value
Observation
6
Short
Address
0
This command is sent to the Hart slave device
using short address 0
7
Function
Code
3
The command function 3 (READ DYNAMIC
VARIABLES) is used in this example
8
Int. DB
Address
290
The integer data will copied to the database starting at
word-address 290 (from 290 to 292)
9
Word Count
3
The command returns 3 words of integer data
10
Swap Code
3
The bytes in each returned integer data will be
swapped
11
Use Long
1
This command executes using Long Address
12
Enable
Address
-1
This command does not use this feature
13
DB Done
Address
-1
This command does not use this feature
14
DB Write
Address
-1
This parameter is ignored since no data is sent to the
HART device (this is a read command)
15
DB Swap
Code
3
This parameter is ignored since no data is sent to the
HART device (this is a read command)
16
Byte Count
0
This parameter is ignored since no data is sent to the
HART device (this is a read command)
17
Fixed Data
This command does not use this feature
So these values could be entered in the configuration file as described below:
In this example, the user should verify that the command result is located inside the Read
Data area, in order to have the data copied to the PLC processor (through the
backplane). The following backplane configuration could be used for this example:
Read Register Start : 0 #Starting DB address where read by processor
Read Register Count : 300 #Number of regs for processor to read
Write Register Start: 300 #Starting DB address where write data placed
Write Register Count: 300 #Number of regs to write to module from processor
Page 46 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuring the MVI56-HART Module
User Manual
2.3.2 Example of HART Command Function 34
The following example shows how to configure a command function 34 (WRITE
DAMPING VALUE) to write a damping values (seconds) to the HART slave device.
According to the HART specification, this command will write one floating point variables:
Word
High Byte
0
Floating Point Damping Value (Sec)
Low Byte
1
The HART device should also return the floating point value after it processes the
request:
Word
High Byte
Low Byte
0
Floating Point Damping Value (Sec)
1
The HART device also returns an integer status data:
Word
High Byte
1
STATUS WORD
Low Byte
This command will return the following number of words:
Parameter
Data Type
Direction
Number of
Words
Database Address
(this example)
Damping Value
Floating Point
Written from MVI to slave
2 (4 bytes)
400 (word address)
or 800 (byte
address)
Damping Value
Floating Point
Read from slave to MVI
2
240 (word address)
Status Word
Integer
Read from slave to MVI
1
290 (word address)
The user can configure the command parameters as described in the following table.
Index
Parameter
Value
Observation
1
Enable
1
The command is sent continuously
2
Float DB
Address
300
The damping value response will be copied to the
internal database starting at word-address 300
(occupies addresses 300 to 301)
3
Poll Interval
0
The command is sent without any delay
4
Word Count
2
The command returns 10 words of floating point
data
5
Swap Code
3
The bytes in each returned floating point word are
swapped
6
Short Address
0
This command is sent to the Hart slave device using
short address 0
7
Function Code
34
The command function 4 (WRITE DAMPING
VALUE) is used in this example
8
Int. DB Address 320
The integer data will copied to the database wordaddress 320
9
Word Count
1
The command returns 1 word of integer data
10
Swap Code
3
The bytes in each returned integer data will be
swapped
11
Use Long
1
This command executes using Long Address
ProSoft Technology, Inc.
October 13, 2011
Page 47 of 171
Configuring the MVI56-HART Module
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Index
Parameter
Value
Observation
12
Enable
Address
-1
This command does not use this feature
13
DB Done
Address
-1
This command does not use this feature
14
DB Write
Address
800
The floating point value located at byte-address 800
(word-address 400) will be used as the damping
value to be written to the HART device
15
DB Swap Code 3
The bytes in each returned integer data will be
swapped
16
Byte Count
The command will write 4 bytes (2 words) to the
HART device, since the damping value uses floating
point format (2 words)
17
Fixed Data
4
This command does not use this feature
The user would have to verify that addresses 300 and 320 are located inside the Read
Data area (read from the MVI database to the PLC processor). Address 400 would have
to be located inside the Write Data area (written from the PLC processor to the MVI
database).
Page 48 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
2.4
Configuring the MVI56-HART Module
User Manual
Downloading the Project to the Module Using a Serial COM Port
For the module to use the settings you configured, you must download (copy) the
updated Project file from your PC to the module.
To download the project file
1 In the tree view in ProSoft Configuration Builder, click once to select the module.
2 Right-click the module icon to open a shortcut menu. From the shortcut menu,
choose DOWNLOAD FROM PC TO DEVICE. The program will scan your PC for a valid
com port (this may take a few seconds). When PCB has found a valid COM port, the
Download dialog box will open.
3
Choose the COM port to use from the dropdown list, and then click the DOWNLOAD
button.
The module will perform a platform check to read and load its new settings. When the
platform check is complete, the status bar in the Download dialog box will display the
message Module Running.
ProSoft Technology, Inc.
October 13, 2011
Page 49 of 171
Configuring the MVI56-HART Module
User Manual
Page 50 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
3
Ladder Logic
User Manual
Ladder Logic
In This Chapter
Using the Sample Program ................................................................... 52
Adding the Module to an Existing Project .............................................. 57
Ladder logic is required for the MVI56-HART module to work. Tasks that must be
handled by the ladder logic are module data transfer, special block handling, and status
data receipt. Additionally, a power-up handler may be needed to handle the initialization
of the module’s data and to clear any processor fault conditions.
The sample ladder logic, on the inRAx CD-ROM, is extensively commented, to provide
information on the purpose and function of each rung. For most applications, the sample
ladder will work without modification.
ProSoft Technology, Inc.
October 13, 2011
Page 51 of 171
Ladder Logic
User Manual
3.1
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Using the Sample Program
The sample program consists of user defined data types, controller tags and ladder rungs
that allow communication between the ControlLogix processor, the MVI56-HART module,
and the HART network. You can use the sample program as-is, or you can incorporate
the data types, controller tags and ladder rungs into an existing program.
3.1.1 Controller Tags
The MVI56-HART module is defined in the example as HARTData1 to hold all data
related to the database (type HARTData) and HART1 to hold all status data related to the
module (type HARTModuleDef). The tag name can be set to any valid tag name desired.
3.1.2 Module Status Data and Variables (HARTModuleDef)
All status and variable data related to the MVI56-HART is stored in a user-defined data
type. An instance of the data type is required before the module can be used. This is
accomplished by declaring a variable of the data type in the Controller Tags Edit Tags
dialog box. The following table describes the structure of this object.
Name
Data Type
Description
GenStat
HARTStat
General status information
BP
HARTBackplane
Data to handle backplane logic
Auto_Poll
HARTAutoPoll[10]
Auto-PollData
ByteData
SINT[60]
This object contains objects that define variables for the module and status data related
to the module. Each of these object types is discussed in the following topics of the
document.
Page 52 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Ladder Logic
User Manual
Status Object (HARTStat)
This object stores the status data of the module. The HARTStat object (shown in the
following example) is updated each time a read block is received by the processor. Use
this data to monitor the state of the module at a "real-time" rate.
Name
Data Type
Description
Scan_Cnt
INT
Program Scan Counter
Product_Name
SINT[4]
Product Code
Rev_Level
SINT[4]
Revision
Op_Sys
SINT[4]
Operating system revision
Run_Number
SINT[4]
Run number
Blk_Rd_Count
INT
Number of block read transfers
Blk_Wr_Count
INT
Number of block write transfers
Blk_Parse_Cnt
INT
Number of blocks parsed by module
Blk_Resv
INT
Reserved
Blk_Cmd
INT
Number of command enable/disable blocks
Blk_Err
INT
Number of block errors
ChStat
HARTCHStat[4]
Channel Status Data
Within the HARTStat objects are objects containing the status information for each
application port (HARTCHStat). Refer to Status Data Area and Error Codes for a
complete listing of the data stored in this object.
Channel Status Object (HARTCHStat)
The HARTCHStat object holds the status data related to a single HART master port. The
following table describes the structure of the object.
Name
Data Type
Description
State
INT
State machine value
Comm_State
INT
Comm port state machine value
Dev_stat
INT
Device bits (OK/Err)
Dev_in_poll
INT
Device bits for poll list
Dev_long
INT
Device bits for long address
Cur_cmd
INT
Current command list index
Cmd_req
INT
Number of command requests issued
Cmd_resp
INT
Number of command responses received
Cfg_Err
INT
Configuration Error Word for channel
CurErr
INT
Current error code for channel
LastErr
INT
Last error for channel
This information is passed to the controller from the module with each normal read block
image.
ProSoft Technology, Inc.
October 13, 2011
Page 53 of 171
Ladder Logic
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Configuration/Error Status Flags (Cfg_Err)
The Cfg_Err word member of the HARTCHStat reports configuration errors for the
respective port. If the module is not functioning as expected, inspect the value presented
in this object. If a configuration error exists, the associated bit is set. A value of zero for
the bit indicates the configuration value is valid. This does not guarantee that the module
is configured correctly for your application. The bits used by this member are shown in
the following table.
Bit
Code
Description
0
0x0001
Enabled not set to Y or N
1
0x0002
Enable Handheld not set to Y or N
2
0x0004
Primary Master not set to Y or N
3
0x0008
Invalid Preambles (1 to 50)
4
0x0010
Invalid Short Address Retries (0 to 50)
5
0x0020
Invalid Long Address Retries (0 to 50)
6
0x0040
Invalid Retries After Error (0 to 50)
7
0x0080
Invalid Poll Time After Error (0 to 10000)
8
0x0100
Invalid DB Address Status
9
0x0200
Invalid Command Count
10
0x0400
Memory Error in allocating commands
11
0x0800
Memory Error in allocating command fixed data
12
0x1000
Memory Error in allocating TX/RX buffers
13
0x2000
HART Board not found
14
0x4000
Cannot initialize HART channel
15
0x8000
Backplane Object (HARTBackplane)
The HARTBackplane object stores all the variables required for the data transfer
operation between the module and the controller. The LastRead data member is used as
the handshaking byte to indicate the arrival of new data from the module. The following
table describes the structure of the object.
Name
Data Type
Description
LastRead
INT
Index of last read block
LastWrite
INT
Index of last write block
BlockIndex
INT
Computed block offset for data table
The other members of the object are be used in the ladder logic to assist in the data
transfer operation.
Page 54 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Ladder Logic
User Manual
3.1.3 Data Object (HARTData)
The HARTData object is defined in the example ladder logic to demonstrate how the data
from a module can be stored in the processor. This object can be used to temporarily
store a received data set. In this example, four data areas are set up; two for input data
(data received from the module) and two for output data (data to transfer to the module).
Within each of these two areas, an area for floating-point data and integer data is
defined. The following table describes the structure of the object.
Name
Data Type
Description
HART_IN_Float_vals
REAL[100]
Data area to floating-point data
HART_IN_Int_vals
INT[100]
Data area to hold integer data
HART_OUT_Float_vals
REAL[100]
Data area for output floating-point data
HART_OUT_Int_vals
INT[100]
Data area for output integer data
ProSoft Technology, Inc.
October 13, 2011
Page 55 of 171
Ladder Logic
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
3.1.4 Auto-Poll Data (HARTAutoPoll)
Auto-Poll Data (HARTAutoPoll)
This data object contains the auto-poll data ready to be used by the user (multi-drop or
point-to-point). First define where the auto-poll data will copied to in the MVI56-HART
database using the DB AutoPoll Address parameter in the configuration file. Then copy
the data from the MVI56-HART database into the CLX memory (HARTAutoPoll object)
using the ladder logic.
Name
Data Type
Description
Auto_Poll_CMD_Status
SINT
Auto-Polling command status bits
Last_Status_Byte
SINT
Last first status byte received from device
Last_Second_Status_Byte
SINT
Last second status byte received from device
Manufacture_ID_Code
SINT
Device's manufacture ID Code
Device_Type_Code
SINT
Device Type Code
Min_Preambles
SINT
Minimum Number of Preambles
Universal_CMD_Major
SINT
Universal Command Major Rev#
Device_Rev_Level
SINT
Device Revision Level
Software_Rev_Level
SINT
Software Revision Level
Hardware_Rev_Level
SINT
Hardware Revision Level
Device_Flags
SINT
Device Flags
Device_ID
SINT[3]
Device ID
Min_Preambles_Resp
SINT
Minimum Preambles Count to Response
Max_Number_Devices
SINT
Maximum Number of HART Devices in the network
Config_Change_Count
INT
Counter for configuration change
Ext_Dev_Status
SINT
Extended Field Device Status
Primary_Var_Units
SINT
Primary Units Code
Secondary_Var_Units
SINT
Secondary Units Code
Tertiary_Var_Units
SINT
Tertiary Units Code
Quaternary_Var_Units
SINT
Quaternary Units Code
Tag_Name
SINT[8]
HART device Tag Name
Descriptor
SINT[16]
HART device Descriptor
Tag_Descriptor_Data
SINT[3]
HART device descriptor data
Transd_Serial_Num
SINT[3]
Transducer Serial Number
Transd_limits
SINT
Transducer limits
PV_Alarms
SINT
PV Alarm counter
PV_Transfer
SINT
PV Transfer counter
PV_URLLRV_Units
SINT
PV upper and lower range value limits
Page 56 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
3.2
Ladder Logic
User Manual
Adding the Module to an Existing Project
1
Select the I/O Configuration folder in the Controller Organization window of RSLogix
5000, and then click the right mouse button to open a shortcut menu. On the shortcut
menu, choose NEW MODULE.
This action opens the Select Module dialog box:
2
3
Select the 1756-MODULE (GENERIC 1756 MODULE) from the list and click OK. This
action opens the New Module dialog box.
Enter the Name, Description and Slot options for your application. You must select
the Comm Format as DATA - INT in the dialog box, otherwise the module will not
communicate. Click OK to continue.
Parameter
Value
Name
Enter a module identification string. Example: HART_2
ProSoft Technology, Inc.
October 13, 2011
Page 57 of 171
Ladder Logic
User Manual
4
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Parameter
Value
Description
Enter a description for the module. Example: HART
MULTI-DROP MASTER COMMUNICATION MODULE
Comm Format
Select DATA-INT.
Slot
Enter the slot number in the rack where the MVI56-HART
module is located.
Input Assembly Instance
1
Input Size
250
Output Assembly Instance
2
Output Size
248
Configuration Assembly Instance
4
Configuration Size
0
Select the Requested Packet Interval value for scanning the I/O on the module. This
value represents the minimum frequency that the module will handle scheduled
events. This value should not be set to less than 1 millisecond. The default value is 5
milliseconds. Values between 1 and 10 milliseconds should work with most
applications.
Page 58 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Ladder Logic
User Manual
5
Save the module. Click OK to dismiss the dialog box. The Controller Organization
window now displays the module's presence.
6
Copy the User-Defined Data Types from the sample program into your existing
RSLogix 5000 project.
Copy the Controller Tags from the sample program into your project.
Copy the Ladder Rungs from the sample program into your project.
7
8
ProSoft Technology, Inc.
October 13, 2011
Page 59 of 171
Ladder Logic
User Manual
Page 60 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
4
Diagnostics and Troubleshooting
User Manual
Diagnostics and Troubleshooting
In This Chapter
Reading Status Data from the Module .................................................. 62
LED Status Indicators ............................................................................ 76
The module provides information on diagnostics and troubleshooting in the following
forms:
Status data values are transferred from the module to the processor.
Data contained in the module can be viewed through the Configuration/Debug port
attached to a terminal emulator.
LED status indicators on the front of the module provide information on the module's
status.
ProSoft Technology, Inc.
October 13, 2011
Page 61 of 171
Diagnostics and Troubleshooting
User Manual
4.1
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reading Status Data from the Module
The MVI56-HART module returns a status data set to the ControlLogix processor in read
blocks with identification codes of 0 and -1. This data is transferred to the ControlLogix
processor continuously.
The Configuration/Debug port provides the following functionality:
Full view of the module’s configuration data
View of the module’s status data
Version Information
Control over the module (warm boot and cold boot)
Facility to upload and download the module’s configuration file
4.1.1 Using ProSoft Configuration Builder (PCB) for Diagnostics
The Configuration and Debug menu for this module is arranged as a tree structure, with
the Main menu at the top of the tree, and one or more sub-menus for each menu
command. The first menu you see when you connect to the module is the Main menu.
Because this is a text-based menu system, you enter commands by typing the [command
letter] from your computer keyboard in the Diagnostic window in ProSoft Configuration
Builder (PCB). The module does not respond to mouse movements or clicks. The
command executes as soon as you press the [COMMAND LETTER] — you do not need to
press [ENTER]. When you type a [COMMAND LETTER], a new screen will be displayed in
your terminal application.
Using the Diagnostic Window in ProSoft Configuration Builder
Tip: You can have a ProSoft Configuration Builder Diagnostics window open for
more than one module at a time.
To connect to the module’s Configuration/Debug serial port
1 Start PCB, and then select the module to test. Click the right mouse button to open a
shortcut menu.
Page 62 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
2
On the shortcut menu, choose DIAGNOSTICS.
3
This action opens the Diagnostics dialog box.
Press [?] to open the Main menu.
Diagnostics and Troubleshooting
User Manual
If there is no response from the module, follow these steps:
ProSoft Technology, Inc.
October 13, 2011
Page 63 of 171
Diagnostics and Troubleshooting
User Manual
1
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Click to configure the connection. On the Connection Setup dialog box, select a valid
com port or other connection type supported by the module.
Verify that the null modem cable is connected properly between your computer’s
serial port and the module. A regular serial cable will not work.
3 On computers with more than one serial port, verify that your communication
program is connected to the same port that is connected to the module.
If you are still not able to establish a connection, contact ProSoft Technology for
assistance.
2
Navigation
All of the submenus for this module contain commands to redisplay the menu or return to
the previous menu. You can always return from a submenu to the next higher menu by
pressing [M] on your keyboard.
The organization of the menu structure is represented in simplified form in the following
illustration:
The remainder of this section shows the menus available for this module, and briefly
discusses the commands available to you.
Page 64 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
Keystrokes
The keyboard commands on these menus are usually not case sensitive. You can enter
most commands in lowercase or uppercase letters.
The menus use a few special characters (?, -, +, @) that must be entered exactly as
shown. Some of these characters will require you to use the SHIFT, CTRL, or ALT keys
to enter them correctly. For example, on US English keyboards, enter the ? command as
SHIFT and /.
Also, take care to distinguish the different uses for uppercase letter "eye" (I), lowercase
letter "el" (L), and the number one (1). Likewise, uppercase letter "oh" (O) and the number
zero (0) are not interchangeable. Although these characters look alike on the screen, they
perform different actions on the module and may not be used interchangeably.
4.1.2 Main Menu
When you first connect to the module from your computer, your terminal screen will be
blank. To activate the main menu, press the [?] key on your computer’s keyboard. If the
module is connected properly, the following menu will appear.
Caution: Some of the commands available to you from this menu are designed
for advanced debugging and system testing only, and can cause the module to
stop communicating with the processor or with other devices, resulting in
potential data loss or other communication failures. Use these commands only if
you fully understand their potential effects, or if you are specifically directed to do
so by ProSoft Technology Technical Support Engineers.
There may be some special command keys that are not listed on the menu but
that may activate additional diagnostic or debugging features. If you need these
functions, you will be advised how to use them by Technical Support. Please be
careful when pressing keys so that you do not accidentally execute an unwanted
command.
ProSoft Technology, Inc.
October 13, 2011
Page 65 of 171
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Viewing Block Transfer Statistics
Press [B] from the Main menu to view the Block Transfer Statistics screen.
Use this command to display the configuration and statistics of the backplane data
transfer operations between the module and the processor. The information on this
screen can help determine if there are communication problems between the processor
and the module.
Tip: To determine the number of blocks transferred each second, mark the
numbers displayed at a specific time. Then some seconds later activate the
command again. Subtract the previous numbers from the current numbers and
divide by the quantity of seconds passed between the two readings.
Viewing Module Configuration
Press [C] to view the Module Configuration screen.
Use this command to display the current configuration and statistics for the module.
Opening the Database View Menu
Press [D] to open the Database View menu.
Use this menu command to view the current contents of the module’s database. For
more information about this submenu, see Database View Menu.
Opening the HART Master Menu
Press [H] to open the HART Master Menu. This menu allows you to view information
about the protocol driver.
Transferring the Configuration File from the PC to the Module
On the Diagnostics Menu this is referred to as Receive Module Configuration.
Press [R] to receive (download) the configuration file from your PC to the module and
store the file on the module’s Compact Flash Card (Personality Module) or Flash RAM.
Press [Y] to confirm the file transfer, and then follow the instructions on the terminal
screen to complete the file transfer process.
After the file has been successfully downloaded, the module will restart the program and
load the new configuration information. Review the new configuration using menu
commands [6] and [0] to verify that the module is configured correctly.
Page 66 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
Transferring the Configuration File from The Module to the PC
On the Diagnostics Menu this is referred to as Send Module Configuration.
Press [S] to send (upload) the configuration file from the module to your PC.
Press [Y] to confirm the file transfer, and then follow the instructions on the terminal
screen to complete the file transfer process.
After the file has been successfully uploaded, you can open and edit the file to change
the module’s configuration.
Viewing Version Information
Press [V] to view version information for the module.
Use this command to view the current version of the software for the module, as well as
other important values. You may be asked to provide this information when calling for
technical support on the product.
Values at the bottom of the display are important in determining module operation. The
Program Scan Counter value is incremented each time a module’s program cycle is
complete.
Tip: Repeat this command at one-second intervals to determine the frequency of
program execution.
Warm Booting the Module
Press [W] from the Main menu to warm boot (restart) the module.
This command will cause the program to exit and reload, refreshing configuration
parameters that must be set on program initialization. Only use this command if you must
force the module to reboot.
Exiting the Program
Press [ESC] to restart the module and force all drivers to be loaded. The module will use
the configuration stored in the module's flash memory to configure the module.
4.1.3 HART Master Menu
Redisplaying the Menu
Press [?] to display the current menu. Use this command when you are looking at a
screen of data, and want to view the menu choices available to you.
ProSoft Technology, Inc.
October 13, 2011
Page 67 of 171
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Opening the Data Analyzer Menu
Press [A] to open the Data Analyzer Menu. Use this command to view all bytes of data
transferred on each port. Both the transmitted and received data bytes are displayed.
Refer to Data Analyzer (page 70) for more information about this menu.
Important: When in analyzer mode, program execution will slow down. Only use
this tool during a troubleshooting session. Before disconnecting from the
Config/Debug port, please press [S] to stop the data analyzer, and then press
[M] to return to the main menu. This action will allow the module to resume its
normal high speed operating mode.
Viewing the Slave Status List
Press [V] to view the slave status values associated with the ports. The slave status
values are defined as follows:
ERR = Device in Error
OK = Device OK
[Blank] = Device Not Polled.
Opening the Command Error List Menu
Press [E], [F], [G] or [H] to open the Command Error List for clients 1 through 4
respectively. This list consists of multiple pages of command list error/status data. Press
[?] to view a list of commands available on this menu.
Opening the Command List Menu
Press [N], [O], [P] or [Q] to open the Command List menu for clients 1 through 4
respectively. Use this command to view the configured command list for the module.
Viewing the Master Command List Help
Press [H] to view a help screen with explanations of each item that appears on the
command list.
Page 68 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
Viewing Port Status and Configuration
Press [1], [2], [3], or [4] to view status and configuration for ports 0 through 3
respectively.
HART Error Descriptions
Error Type
Description
Gap Errors
Increments when a delay of more than 20 milliseconds occurs between
characters in a HART message
Overflow
Increments when a received HART message is longer than the internal
buffer can hold
SOM Errors
Start of Message error - Increments whenever the module does not see
at least 3 preambles (FF characters or all bits set ON) at the beginning of
a HART message
Retry Count
Increments every time a HART command fails and is retried
Check Byte
Increments when a Checksum error is detected in the received HART
packet.
Overrun/Parity/Frame
Increments every time one of three errors occur:
Overrun - The HART driver wasn't able to read the current data byte
before a new one arrived, causing the current character to be lost.
Parity - HART communications uses EVEN parity. A byte is received with
parity error.
Frame - There is a zero bit where the stop bit should be. The message is
not formatted correctly.
These errors are typically caused by electrical wiring problems or
electrical interference on the network loop.
Response Timeout
Increments when the response to a HART Command is not received
within the configured timeout period.
Returning to the Main Menu
Press [M] to return to the Main menu.
ProSoft Technology, Inc.
October 13, 2011
Page 69 of 171
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
4.1.4 Data Analyzer
The data analyzer mode allows you to view all bytes of data transferred on each port.
Both the transmitted and received data bytes are displayed. Use of this feature is limited
without a thorough understanding of the protocol.
Important: When in analyzer mode, program execution will slow down. Only use
this tool during a trouble-shooting session. Before disconnecting from the
Config/Debug port, please be sure to press [M] to return to the main menu and
disable the data analyzer. This action will allow the module to resume its normal
operating mode.
Analyzing Data for Port 1
Press [1] to display I/O data for Port 1 in the Data Analyzer. The following illustration
shows an example of the Data Analyzer output.
Page 70 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
Displaying Timing Marks in the Data Analyzer
You can display timing marks for a variety of intervals in the data analyzer screen. These
timing marks can help you determine communication-timing characteristics.
Key
Interval
[5]
1 milliseconds ticks
[6]
5 milliseconds ticks
[7]
10 milliseconds ticks
[8]
50 milliseconds ticks
[9]
100 milliseconds ticks
[0]
Turn off timing marks
Removing Timing Marks in the Data Analyzer
Press [0] to turn off timing marks in the Data Analyzer screen.
Viewing Data in Hexadecimal Format
Press [H] from the Database View menu to display the data on the current page in
hexadecimal format.
Viewing Data in ASCII (Text) Format
Press [A] from the Database View menu to display the data on the current page in ASCII
format. This is useful for regions of the database that contain ASCII data.
ProSoft Technology, Inc.
October 13, 2011
Page 71 of 171
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Starting the Data Analyzer
Press [B] to start the data analyzer. After the key is pressed, all data transmitted and
received on the currently selected port will be displayed. The following illustration shows
an example.
The Data Analyzer displays the following special characters:
Character
Definition
[]
Data enclosed in these characters represent data received on the port.
<>
Data enclosed in these characters represent data transmitted on the port.
<R+>
These characters are inserted when the RTS line is driven high on the port.
<R->
These characters are inserted when the RTS line is dropped low on the port.
<CS>
These characters are displayed when the CTS line is recognized high.
_TT_
These characters are displayed when the timing mark interval has been reached.
This parameter is user defined.
Stopping the Data Analyzer
Press [S] to stop the data analyzer. Use this option to freeze the display so the data can
be analyzed. To restart the analyzer, press [B].
Important: When in analyzer mode, program execution will slow down. Only use
this tool during a troubleshooting session. Before disconnecting from the
Config/Debug port, please press [S] to stop the data analyzer, and then press
[M] to return to the main menu. This action will allow the module to resume its
normal high speed operating mode.
Returning to the Main Menu
Press [M] to return to the Main menu.
Page 72 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
4.1.5 Data Analyzer Tips
From the main menu, press [A] for the "Data Analyzer". You should see the following text
appear on the screen:
After the "Data Analyzer" mode has been selected, press [?] to view the Data Analyzer
menu. You will see the following menu:
From this menu, you can select the "Port", the "format", and the "ticks" that you can
display the data in.
For most applications, HEX is the best format to view the data, and this does include
ASCII based messages (because some characters will not display on HyperTerminal and
by capturing the data in HEX, we can figure out what the corresponding ASCII characters
are supposed to be).
The Tick value is a timing mark. The module will print a _TT for every xx milliseconds of
no data on the line. Usually 10milliseconds is the best value to start with.
After you have selected the Port, Format, and Tick, we are now ready to start a capture
of this data. The easiest way to do so is to go up to the top of you HyperTerminal window,
and do a TRANSFER / CAPTURE TEXT as shown below:
After selecting the above option, the following window will appear:
ProSoft Technology, Inc.
October 13, 2011
Page 73 of 171
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Next name the file, and select a directory to store the file in. In this example, we are
creating a file ProSoft.txt and storing this file on our root C: drive. After you have done
this, press the
button.
Now you have everything that shows up on the HyperTerminal screen being logged to a
file called ProSoft.txt. This is the file that you will then be able to email to ProSoft
Technical Support to assist with issues on the communications network.
To begin the display of the communications data, you will then want to press [B] to tell
the module to start printing the communications traffic out on the debug port of the
module. After you have pressed [B], you should see something like the following:
The <R+> means that the module is transitioning the communications line to a transmit
state.
All characters shown in <> brackets are characters being sent out by the module.
The <R-> shows when the module is done transmitting data, and is now ready to receive
information back.
And finally, all characters shown in the [ ] brackets is information being received from
another device by the module.
After taking a minute or two of traffic capture, you will now want to stop the "Data
Analyzer". To do so, press the [S] key, and you will then see the scrolling of the data
stop.
When you have captured the data you want to save, open the Transfer menu and choose
Capture Text. On the secondary menu, choose Stop.
You have now captured, and saved the file to your PC. This file can now be used in
analyzing the communications traffic on the line, and assist in determining
communication errors.
Page 74 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
4.1.6 Master Command Error List Menu
Use this menu to view the command error list for the module. Press [?] to view a list of
commands available on this menu.
Redisplaying the Current Page
Press [S] to display the current page of data.
Moving Back Through 5 Pages of Commands
Press [-] to display data for last 5 page commands.
Viewing the Previous Page of Commands
Press [P] to display the previous page of commands.
Moving Forward (Skipping) Through 5 Pages of Commands
Press [+] to display data for the next page of commands.
Viewing the Next Page of Commands
Press [N] to display the next page of commands.
Returning to the Main Menu
Press [M] to return to the Main menu.
4.1.7 Master Command List Menu
Use this menu to view the command list for the module. Press [?] to view a list of
commands available on this menu.
Redisplaying the Current Page
Press [S] to display the current page of data.
Viewing the Previous 50 Commands
Press [-] to view the previous 50 commands.
Viewing the Previous Page of Commands
Press [P] to display the previous page of commands.
Viewing the Next 50 Commands
Press [+] to view the next 50 commands from the Master command list.
Viewing the Next Page of Commands
Press [N] to display the next page of commands.
Returning to the Main Menu
Press [M] to return to the Main menu.
ProSoft Technology, Inc.
October 13, 2011
Page 75 of 171
Diagnostics and Troubleshooting
User Manual
4.2
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
LED Status Indicators
The LEDs indicate the module’s operating status as follows:
LED
Color
Status
Indication
CFG
Green
On
NA
Off
NA
On
NA
Off
NA
On
Data is being transferred between the module and a remote
terminal using the Configuration/Debug port.
Off
No data is being transferred on the Configuration/Debug port.
Off
The MVI56-HART is working normally.
On
The MVI56-HART module program has recognized a
communication error.
On
The LED is on when the module is performing a write
operation on the backplane.
Off
The LED is off when the module is performing a read
operation on the backplane. Under normal operation, the LED
should blink rapidly on and off.
Off
The card is not receiving any power and is not securely
plugged into the rack.
Green
The module is operating normally.
Red
The program has detected an error or is being configured. If
the LED remains red for over 10 seconds, the program has
probably halted. Remove the card from the rack and re-insert
the card to restart the module’s program.
Off
The battery voltage is OK and functioning.
On
The battery voltage is low or battery is not present. Allow
battery to charge by keeping module plugged into rack for 24
hours. If BAT LED still does not go off, contact ProSoft
Technology, as this is not a user serviceable item.
P1
P2
Green
Green
APP
Status
Amber
BP ACT
Amber
OK
BAT
Red/
Green
Red
4.2.1 Clearing a Fault Condition
Typically, if the OK LED on the front of the module turns RED for more than ten seconds,
a hardware problem has been detected in the module or the program has exited.
To clear the condition, follow these steps:
1 Turn off power to the rack.
2 Remove the card from the rack.
3 Verify that all jumpers are set correctly.
4 If the module requires a Compact Flash card, verify that the card is installed correctly.
5 Re-insert the card in the rack and turn the power back on.
6 Verify correct configuration data is being transferred to the module from the
ControlLogix controller.
If the module's OK LED does not turn GREEN, verify that the module is inserted
completely into the rack. If this does not cure the problem, contact ProSoft Technology
Technical Support.
Page 76 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
4.2.2 Troubleshooting
Use the following troubleshooting steps if you encounter problems when the module is
powered up. If these steps do not resolve your problem, please contact ProSoft
Technology Technical Support.
Processor Errors
Problem description
Steps to take
Processor fault
Verify that the module is plugged into the slot that has been configured
for the module in the I/O Configuration of RSLogix.
Verify that the slot location in the rack has been configured correctly in
the ladder logic.
Processor I/O LED
flashes
This indicates a problem with backplane communications. A problem
could exist between the processor and any installed I/O module, not just
the MVI56-HART. Verify that all modules in the rack are correctly
configured in the ladder logic.
Module Errors
Problem description
Steps to take
BP ACT LED (not
present on MVI56E
modules) remains OFF
or blinks slowly
MVI56E modules with
scrolling LED display:
<Backplane Status>
condition reads ERR
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 port to see if the module is running. If the program
has halted, turn off power to the rack, remove the card from the rack and
re-insert it, and then restore power to the rack.
ProSoft Technology, Inc.
October 13, 2011
Page 77 of 171
Diagnostics and Troubleshooting
User Manual
Page 78 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5
Reference
User Manual
Reference
In This Chapter
Product Specifications ........................................................................... 80
Functional Overview .............................................................................. 83
Disabling the RSLinx Driver for the Com Port on the PC....................... 98
RS-232 Configuration/Debug Port ....................................................... 100
DB9 to RJ45 Adaptor (Cable 14) ......................................................... 101
Application Port Connection ................................................................ 102
Example Field Terminations ................................................................ 103
MVI56-HART Status Data and Error Codes ........................................ 111
HART Universal Commands ............................................................... 118
HART Common Practice Commands .................................................. 131
ProSoft Technology, Inc.
October 13, 2011
Page 79 of 171
Reference
User Manual
5.1
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Product Specifications
The MVI56 HART Multi-drop Master Communication Module is designed to allow
ControlLogix processors to interface easily with HART compatible devices. Devices
commonly supporting the protocol include pressure, temperature, flow transmitters, as
well as other similar instruments commonly found in the process (and other) industry.
The MVI56-HART Master Communication Module allows Rockwell Automation
ControlLogix compatible processors to easily communicate with HART slave devices.
The MVI56-HART module interfaces up to 15 devices on each HART channel with the
processor. HART channels on the module support Master protocol commands to
interface with slave devices on their own networks. Each port is individually configurable.
Data is exchanged between the HART network and the ControlLogix processor
backplane using the internal database contained in the module and direct control by the
processor’s ladder logic and pre-defined data objects (5000 registers maximum).
The MVI56-HART module is the perfect solution for industrial applications in chemical
and refining operations, gas and liquid distribution systems, and remote offshore
monitoring stations, addressing virtually all aspects of control, data acquisition, and
maintenance.
®
HART is a registered trademark of the HART Communication Foundation.
5.1.1 General Specifications
Single Slot - 1756 backplane compatible
The module is recognized as an Input/Output module and has access to processor
memory for data transfer between processor and module.
Ladder Logic is used for data transfer between module and processor. Sample
ladder file included.
Configuration data obtained from configuration text file downloaded to module.
Sample configuration file included
Local or remote rack
Page 80 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
5.1.2 Hardware Specifications
Specification
Description
Backplane Current Load
800 mA @ 5 V DC
3mA @ 24V DC
Operating Temperature
0 to 60°C (32 to 140°F)
Storage Temperature
-40 to 85°C (-40 to 185°F)
Shock
30g Operational
50g non-operational
Vibration: 5 g from 10 to 150 Hz
Relative Humidity
5% to 95% (non-condensing)
LED Indicators
Module Status
Backplane Transfer Status
Application Status
Serial Activity
Debug/Configuration port (CFG)
CFG Port (CFG)
RJ45 (DB-9M with supplied cable)
RS-232 only
No hardware handshaking
Configuration Connector
RJ45 RS-232 Connector (RJ45 to DB-9 cable
shipped with unit)
Application Ports
AppPort
ProSoft Technology, Inc.
October 13, 2011
HART terminal connector
Page 81 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.1.3 Functional Specifications
The MVI56-HART module supports the HART Multi-drop implementation of the protocol.
Following are some general specifications for the module:
Built in accordance to the HART Bell 202 Frequency Shift Keying (FSK) standard to
superimpose digital signals at a low level on top of the 4 to 20mA
o Four independent HART master ports that are completely user-configurable
o Supports up to 15 devices per port
o Point-to-point (slave address 0) or Multi-drop (slave address 1 to 15) modes
supported
Supports 99 universal and common practice commands per port to control and
monitor devices with integer, IEEE754 floating-point and packed ASCII character
string data blocks
Burst mode can be used for faster update of data from a single slave
Supports an auto polling feature that will automatically collect data from each HART
instrument on the channel and store the data in the module database
Communication ports can be configured as a secondary master (that is, handheld
configuration device)
Protocol Supported: HART protocol uses the Bell 202 standard frequency shift-keying
(FSK) digital signal to communicate at 1200 baud, superimposed at a low level on the 4
to 20mA analog measurement signal. The MVI56-HART module supports version 5 of the
HART protocol.
Supported Function Codes: HART Universal Commands Set supported are 00 to 03,
06 to 09, and 11 to 22. HART Common Practice Commands Set supported are 33 to 83
and 105 to 110.
HART Network Communications: Supports four master channels. Each channel on the
module is configured independently to emulate a HART master. Burst mode can be used
for faster update of data from a slave device.
Command polling is also user-configurable, including disabled, continuous, on change of
data (write only), and dynamically user or automatic enabled.
Status: Error codes returned by the HART protocol available on an individual command
basis. In addition, a slave status list is maintained per active channel.
Page 82 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.2
Reference
User Manual
Functional Overview
5.2.1 General Concepts
The following discussion explains several concepts that are important for understanding
the operation of the MVI56-HART module.
Module Power Up
On power up the module begins performing the following logical functions:
Initialize hardware components
o Initialize ControlLogix backplane driver
o Test and Clear all RAM
o Initialize the serial communication ports
Read module configuration from the Compact Flash
Initialize Module Register space
Set up the communication interface for the debug/configuration port
When this initialization procedure is complete, the module will begin communicating with
other nodes on the network, depending on the configuration.
Main Logic Loop
Upon completing the power up configuration process, the module enters an infinite loop
that performs the functions shown in the following diagram.
From Power Up Logic
ProSoft Technology, Inc.
October 13, 2011
Call I/O Handler
Call I/O Handler
Transfers data between the module and processor
(user, status, etc.)
Call CFG/DEBUG Port
Driver
Call Serial Port Driver
Rx and Tx buffer routines are interrupt driven. Call to
serial port routines check to see if there is any data
in the buffer, and depending on the value, will either
service the buffer or wait for more characters.
Call Network Server
Drivers
Call Network Server Drivers
Respond to messages received.
Page 83 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.2.2 Backplane Data Transfer
The MVI56-HART module communicates directly over the ControlLogix backplane. Data
travels between the module and the ControlLogix processor across the backplane using
the module's input and output images. The update frequency of the data is determined by
the scan rate defined by the user for the module and the communication load on the
module. Typical updates are in the range of 1 to 10 milliseconds.
Data received by the master drivers is placed in the module's input image. This data is
processed by the ladder logic in the ControlLogix processor. The input image for the
module is set to 500 bytes. This large data area permits fast throughput of data between
the module and the processor.
The processor inserts data in the module's output image to transfer to the module. The
module's program extracts the data and transmits the data out to the master driver to the
serial network. Additionally, the ControlLogix processor can send special control blocks to
the module to instruct it to perform a special task. The output image for the module is set
to 496 bytes. This large data area permits fast throughput of data from the processor to
the module.
The following illustration shows the data transfer method used to move data between the
ControlLogix processor, the MVI56-HART module, and the HART networks.
All data transferred between the module and the processor over the backplane is through
the input and output images. Ladder logic must be written in the ControlLogix processor
to interface the input and output image data defined in the controller tags. The user is
responsible for handling and interpreting all data received on the application ports and
transferred to the input image.
As blocks are transferred between the module and the processor, each block contains
block identification codes that define the content or function of the block of data
transferred.
Page 84 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Block Range
Descriptions
-1
Null block (Status Data Only)
0
Null block (Status Data Only)
1 to 20
Read or write data
9902
Command Enable Control Block
9903
Command Disable Control Block
9950
Command List Error data
9998
Warm Boot Request from PLC (Block contains no data)
9999
Cold Boot Request from PLC (Block contains no data)
Reference
User Manual
Blocks -1 and 0 transfer status data from the module to the processor and they contain
no data when transferred from the processor to the module. Blocks 1 to 20 are utilized to
transfer data stored or to be stored in the module's database. These data blocks send
data from module to the processor (monitored data received from the devices on the
HART network) and to send data from the processor to the module (control data to send
to the end devices). Block identification codes 9900 to 9999 are used for special control
blocks to control the module.
5.2.3 Normal Data Transfer
Normal data transfer includes the transferring of data received by, or to be transmitted to,
the master drivers and the status data. These data are transferred through read (input
image) and write (output image) blocks. Refer to Module Configuration for a description
of the data objects used with the blocks and the ladder logic required. The following
topics discuss the structure and function of each block.
Read Block
These blocks of data transfer information from the module to the ControlLogix processor.
The structure of the input image used to transfer data received from the HART devices is
shown in the following table.
Offset
Description
Length
0
Reserved
1
1
Write Block ID
1
2 to 201
Read Data
200
202 to 248
Spare
47
249
Read Block ID
1
The Block Identification Code (word 249) signals the ControlLogix processor that a new
block is ready for processing and informs the processor of the contents of the block. If the
value of the code is set to 1, the block contains the first 200 words of data contained in
the database of the module.
If the Read Block ID is set to 0 or -1, the block contains the status data that should be
copied to the status data area in the module. This information can be used to determine
the "health" and activity of the module. Refer to Status Data Area and Error Codes for a
detailed listing of the area and its contents.
The normal read data block also contains the block identification code the module
expects to receive from the processor (word 1 in the block). Under normal data transfer
conditions, the ladder logic should use the code to build the appropriate block for the
module in the output image.
ProSoft Technology, Inc.
October 13, 2011
Page 85 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Write Block
These blocks of data transfer information from the ControlLogix processor to the module.
The following table describes the structure of the output image.
Offset
Description
Length
0
Write Block ID
1
1 to 200
Write Data
200
201 to 247
Spare
47
The Block Identification code defines the content of the data contained in the block. If the
code is set to -1 or 0, the data area contains no valid data. If the word contains a value
from 1 to 20, the data contained in the block should be placed in the appropriate position
of the module’s database. Under normal conditions, the value used for the write block
identification code should be that received in the read block from the module.
5.2.4 Command Control Blocks
Block identification codes greater than 9900 are utilized to perform special functions in
the module. Each control block recognized and used by the module is defined in the
following topics.
Block 9902: Command Control
The block 9902 identification code is used by the processor to enable a set of commands
that have their enable code set to 4 or 5 (one shot). The value referenced by the address
associated with the command, Enable DB Address, will be set to -1 to enable the
command for a one-shot (enable code 5) or continuous (enable code 4) execution. After
the command is executed, the module resets the register to 0 to disable the command for
the one-shot mode. The format for this command block is shown in the following table.
Word Offset in Block
Data Field(s)
Description
0
Block ID
This field contains the value of 9902 identifying the
enable command to the module.
1
Port Number
This is the HART port number (0 to 3) for the
command. Each port has its own command list.
2
Command
count
This field contains the number of commands To enable
in the command list. Valid values for this field are 1 to
60.
3 to 62
Command
Numbers to
enable
These 60 words of data contain the command numbers
in the command list to enable. The value referenced by
the Enable DB address associated with each command
will be set to -1.
63 to 247
Spare
Not Used
There is no response to this block by the module.
Page 86 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
Block 9903: Command Disable Control Block
The block 9903 identification code is used by the processor to disable a set of commands
that have an enable code set to 4 or 5 (one shot). The value referenced by the address
associated with the command, Enable DB Address, will be set to 0 to disable the
command. The format for this command block is shown in the following table.
Word Offset in Block
Data Field(s)
Description
0
Block ID
This field contains the value of 9903 identifying the
enable command to the module.
1
Port Number
This is the HART port number (0 to 3) for the
command. Each port has its own command list.
2
Command
count
This field contains the number of commands to disable
in the command list. Valid values for this field are 1 to
60.
3 to 62
Command
Numbers to
enable
These 60 words of data contain the command numbers
in the command list to disable. The value referenced by
the Enable DB address associated with each command
will be set to 0.
63 to 247
Spare
Not Used
There is no response to this block by the module.
Block 9950: Read Command Error List
Block 9950 identification code requests the Command List Error Table for a single port
from the module for the 100 user configurable commands. The following table describes
the format of this block.
Word Offset in Block
Data Field(s)
Description
0
Block ID
This field contains the value of 9950 identifying the block
type to the module.
1
Port Number
This field contains the port number to report in the
response block. Valid values are 0 to 3 for ports 0 to 3 on
the module.
2
Number of
This field contains the number of commands to report in
Commands to the response message. The value has a range of 1 to
report
100.
3
Start Index of
First
Command
This parameter sets the index in the command list where
to start. The first command in the list has a value of 0.
The last index in the list has a value of MaxCommands 1.
4 to 247
Spare
Not Used
The module responds to a valid request with a block containing the requested error
information. The following table describes the format of this block.
Word Offset in Block
Data Field(s)
Description
0
Reserved
Reserved (0)
1
Block ID
This is the next block requested by the module.
2
Port Number
This field contains the port number (0 to 3) corresponding
to the data contained in the block.
3
Number of
Commands
reported
This field contains the number of commands contained in
the block that must be processed by the PLC. This field
will have a value of 1 to 100.
ProSoft Technology, Inc.
October 13, 2011
Page 87 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Word Offset in Block
Data Field(s)
Description
4
Start Index of
First
Command
This field contains the index in the command list for the
first value in the file. This field will have a value of 0 to
MaxCommands-1.
5 to 104
Command
List Errors
Each word of this area contains the last error value
recorded for the command. The command index of the
first value (offset 4) is specified in word 3 of the request
block. The number of valid command errors in the block is
set in word 3 of the block. Refer to the command error list
to interpret the error codes reported.
105 to 248
Spare
Not Used
249
Block ID
This field contains the value of 9950 identifying the block
type to the PLC.
For further information concerning the status blocks (0 and -1) please refer to Status
Data.
Block 9998: Warm Boot
Block 9998 performs a warm-boot operation on the module. The following table describes
the format of the block constructed by the processor.
Offset
Description
Length
0
9998
1
1 to 247
Spare
247
Block 9999: Cold Boot
Block 9999 performs a cold-boot operation on the module. The following table describes
the format of the block constructed by the processor.
Offset
Description
Length
0
9999
1
1 to 247
Spare
247
Page 88 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
5.2.5 HART Channels
The MVI56-HART module supports the HART protocol as a Master on up to
four channels. Each channel is individually configurable.
The HART protocol uses the Bell 202 standard frequency shift-keying (FSK) signal to
communicate at 1200 baud, superimposed at a low level on the 4 to 20 mA analog
measurement signal. Having an average value of zero, and FSK signal causes no
interference with the analog value. The HART devices are powered from this 4 to 20 mA
analog loop.
Both HART protocol channels in the module generate the Bell 202 FSK signal to
communicate in multi-drop mode with up to 15 HART devices and provide up to 250 mA
supply for analog loop.
Auto-Poll Modes
Each HART channel can be set to operate in three different modes:
Point-to-Point
Multi-drop
User Mode
Using the configuration file, choose the auto-poll mode through the Auto-Poll Code
parameter (P, M, or N). In the first two modes, the module will automatically collect data
from each HART instrument on the channel (auto-poll) and store the data in the module's
database.
In User Mode, the module will only execute the commands in the user command list and
will not automatically acquire data. Refer to the Auto-Polling section for more information.
Mode
Use Auto-Poll
Use Command List
N (None)
N
Y
M (Multi-drop)
Y
Y
P (Point-to-Point)
Y
Y
When configured for Point-to-Point communication, the channel will automatically poll
data from the connected slave address 0.
When configured for Multi-drop, the channel will automatically poll data from the
connected slaves in the network (address 1 to 15). Refer to the Auto-Polling section for
more information about auto-poll mode.
User-configured commands can be issued on each channel to the HART devices. Up to
99 commands can be defined for each port. Data read from the devices is placed in the
virtual database of the module, which is passed between the module and the processor.
Any write requests or device-specific commands for the HART slave devices are sourced
with data from the virtual database, or from a configured constant data block. Within the
commands, it can be specified whether or not to use the HART device's short or long
address. If the long address is selected, the device is polled first with short address to
ask for the long one. Then, the device is polled with the long address. The module does
this processing automatically.
In a HART network, it is possible to have two masters. The module fully supports the
existence of a second master, but it can reduce the throughput on the HART network.
This facility is enabled or disabled in the module's configuration. If the ability to have a
second master on the network is disabled, then the maximum communication throughput
is achieved.
ProSoft Technology, Inc.
October 13, 2011
Page 89 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.2.6 Master Driver
The master driver supported on each application port of the module emulates a HART
master device. Configuration of each port is independent and should be connected to
different HART networks. Up to 15 devices can be connected to each channel. Control of
the slave devices by the master port is using a user-constructed command list autopolling, if enabled. Data for these commands is sourced from the module’s database.
Data read from the slave devices is placed in the module’s database. The following
diagram shows the operation of the master driver:
1
2
3
4
5
6
The master driver is configured as specified by the HART.CFG file
The master will construct control commands using the data in the database
The master will send these commands and read requests out on the network
Response messages generated by controlled devices on the network are received by
the master driver
Read data received by the master is passed to the module’s database and passed to
the processor
Additionally, status data for the module is passed to the processor
HART Command List
The HART Command List specifies the commands to be executed to the HART devices
connected to a channel. A HART command can be seen as an outgoing message to the
HART devices that provides Write Data for a specific command or a response message
that carries process data (Read Data) back to the module. The MVI56 module supports
three kinds of data blocks in the Universal and Common Practice commands. These data
blocks are:
Integers
IEEE 754 Floating Point Numbers (32 bits)
Packed ASCII character strings
The Packed ASCII character strings are unpacked and placed with the integers data
block.
For all commands, it is possible to select where the Write Data comes from; it can be in
the module’s internal database or it can be configured as a fixed data block in the
command.
Page 90 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
For response messages from HART devices, it is possible to configure where the
Floating Point Data and Integer Data will be placed in the module’s internal database, but
this is only possible for the Universal and Common Practice commands. In the case of
Device Specific commands, all the Read Data is placed in the Integer data section. See
HART Command Support for a listing of supported HART commands.
Burst Mode
If a slave on a network will be placed in burst mode, its data can be placed in the
module's database. For the command to be burst by slave device, enter a command in
the user command list with the appropriate HART command number. Set the type field to
0 to disable the command. The parameters in the command will be used to store the data
received from the bursting slave. There can only be one slave bursting on the network at
any one time. This mode can be used for faster update of data from a slave.
Auto-Polling
This feature is enabled by setting the AUTO-POLL CODE (in the configuration file) to a
value of P (point-to-point). If the value N is entered for the parameter, the auto-poll
feature is disabled. When the feature is disabled, the channel will only execute the
commands enabled in the user command list. When the auto-polling mode is enabled,
the module will automatically acquire data from the HART instruments attached to a
channel without the use of user commands. If user commands are present and enabled
when the feature is enabled, they will also be executed independent of auto-polling.
With the auto-poll feature enabled, the module automatically generates the following
HART commands and stores the data in the module's database at the user-specified
location:
CMD
Description
0
Read Unique Identifier
3
Read Current and Four Dynamic Variables
13
Read Tag, Descriptor and Date
14
Read PV Sensor Information
15
Read Output Information
If the unit is set for point-to-point mode, the module will automatically gather the
information for the device with the polling address (short address) of zero and place the
data into the database. Each device requires a 50-word database area with the format
shown in the following table.
ProSoft Technology, Inc.
October 13, 2011
Page 91 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
DB Byte
Offset
Type
Description
Byte
Cnt
Data
Source
Use of Data
0
byte
Auto-polling command status bits
1
App
Status
1
byte
Last first status byte received from
device
1
Resp
Status
2
byte
Last second status byte received
from device
1
Resp
Status
3
byte
Manufacture ID Code
1
CMD 0
LongAddress
4
byte
Device Type Code
1
CMD 0
LongAddress
5
byte
Minimum number of preambles
1
CMD 0
Msgconstruction
6
byte
Universal Command Major Rev #
1
CMD 0
Msgchoice
7
byte
Device Revision Level
1
CMD 0
Info
8
byte
Software Revision Level
1
CMD 0
Info
9
byte
Hardware Revision Level/Physical
Signaling Code
1
CMD 0
Info
10
byte
Device Flags
1
CMD 0
Info
11 to 13
byte
Device ID
3
CMD 0
Long Address
14
byte
Minimum number of preambles to
be sent with the response message
from the slave to the master.
1
CMD 0
15
byte
Maximum number of device
variables
1
CMD 0
Info
16 to 17
word
Configuration Change Counter
2
CMD 0
Info
18
byte
Extended Field Device Status
1
CMD 0
Info
19
byte
Primary variable units code
1
CMD 3
Cfg
20
byte
Secondary variable units code
1
CMD 3
Cfg
21
byte
Tertiary variable units code
1
CMD 3
Cfg
22
byte
Quaternary variable units code
1
CMD 3
Cfg
23 to 30
byte
Tag name
8
CMD 13
Info
31 to 46
byte
Descriptor
16
CMD 13
Info
47 to 49
byte
Tag/Descriptor data
3
CMD 13
Info
50 to 52
byte
Transducer serial number
3
CMD 14
Info
53
byte
Transducer limits and min span
units code
1
CMD 14
Info
54
byte
PV alarm selection code
1
CMD 15
Info
55
byte
PV transfer function code
1
CMD 15
Info
56
byte
PV upper and lower range value
units code
1
CMD 15
Info
57
byte
Write protection code
1
CMD 15
Status
58
byte
Private label distributor code
1
CMD 15
Info
59
byte
PV analogchannel flag
1
CMD 15
Info
TOTAL BYTE COUNT
60
TOTAL WORD COUNT
30
Page 92 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
DB Byte
Offset
Type
Description
Byte
Cnt
Data
Source
Use of Data
60 to 63
float
Primary variable value
4
CMD 3
Status
64 to 67
float
Secondary variable value
4
CMD 3
Status
68 to 71
float
Tertiary variable value
4
CMD 3
Status
72 to 75
float
Quaternary variable value
4
CMD 3
Status
76 to 79
float
Upper transducer limit
4
CMD 14
Cfg
80 to 83
float
Lower transducer limit
4
CMD 14
Cfg
84 to 87
float
Minimum span
4
CMD 14
Cfg
88 to 91
float
PV upper range value
4
CMD 15
Cfg
92 to 95
float
PV lower range value
4
CMD 15
Cfg
96 to 99
float
PV damping value (in seconds)
4
CMD 15
Cfg
TOTAL FLOAT BYTE COUNT
40
TOTAL FLOAT WORD COUNT
20
DB Regs/Device
50
Max DB Regs/channel for 15 Devices
750
Max DB Regs for HART Card
3000
The following table defines the auto-polling command status bits:
Bit #
Description
0
Long Address Set (command 0 successful)
1
Command 13 successful (configuration)
2
Command 14 successful (configuration)
3
Command 15 successful (configuration)
4
Command 3 successful (data polling)
5
Reserved
6
Reserved
7
Reserved
The following topics describe the modes of module operation.
Auto-Poll Disabled Mode
If the auto-polling feature is disabled (Auto-Poll Code = N), the module functions as
shown in the following diagram:
Only the user commands are executed and all data is placed in and sourced from the
module's internal database. The user is responsible for constructing all commands to
control and monitor the instruments attached to the channel.
ProSoft Technology, Inc.
October 13, 2011
Page 93 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Point-to-Point Mode
Important: If the HART device address is 0 you must configure the channel for
Point-to-Point mode.
In point-to-point mode, the module only polls for a single instrument with a polling
address of zero. When the instrument is found by the channel, it continuously polls for the
data using command 3. Occasionally, it will poll for the configuration information for the
device. This is accomplished with HART commands 13, 14 and 15. Less frequently, the
channel will perform a HART command 0 request to see if any of the data for the
instrument has changed. If communications is lost with the device, the module will try to
establish communications with the device using command 0. If user commands are
present and enabled, they will be executed after each data poll.
When the point-to-point mode of auto-polling is enabled (Auto-Poll Code = P), the
following diagram applies to the channel operation:
Page 94 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
Multi-drop Mode
Important: If the HART device address is between 1 and 15, you must configure
the channel for multi-drop mode.
If the unit is set for multi-drop mode, the module will poll each unit attached to the
channel starting with polling address 1. The parameter MAX DEVICE COUNT in the
configuration determines the maximum slave address number to be polled in multi-drop
mode. For example, if the MAX DEVICE COUNT parameter is set to 3, the channel will
poll for polling addresses 1, 2, and 3. It is important when assigning the device polling
addresses for instruments on a channel to start with 1 and successfully increase the
value by one until the last instrument is assigned an address. If you set the MAX DEVICE
COUNT parameter to 2, and assign the two instruments addresses 1 and 15, the polling
address 15 will never be used (only addresses 1 and 2). Therefore, the second
instrument will never be polled and will be in communication failure. Up to 15 instruments
can be assigned to a single channel (polling address 1 to 15).
ProSoft Technology, Inc.
October 13, 2011
Page 95 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
If the module is configured for multi-drop auto-polling (Auto-Poll Code = M), the following
diagram applies:
In multi-drop mode, the channel will poll for instruments 1 to the value set in the MAX
DEVICE COUNT parameter. For each device found, it will continuously poll for data using
command 3. After a certain number of iterations, the HART Driver will ready the
configuration data for the next device (if there is one). Each time configuration information
is acquired, it will be for a different slave device if more than 1 slave is recognized by the
channel. Less frequently, the channel will poll for devices not found in the original search
of the network using HART command 0. If communications is lost with all devices, the
module will try to establish communications with the devices using command 0. If user
commands are present and enabled, they will be executed after the data polling of the
devices.
Multi-drop Mode Example:
The intent is to show when using Multi-drop mode how the Auto-Poll DB Address and
Max Device Count parameters should be used.
If the configuration file sets the following parameters:
Parameter
Value
DB Address Status
3660
Auto-Poll DB Address
400
Max Device Count
15
Page 96 of 171
Config File Section
[HART PORT 0]
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
Parameter
Value
DB Address Status
3661
Auto-Poll DB Address
1200
Max Device Count
15
DB Address Status
3662
Auto-Poll DB Address
2000
Max Device Count
15
DB Address Status
3663
Auto-Poll DB Address
2800
Max Device Count
15
Config File Section
[HART PORT 1]
[HART PORT 2]
[HART PORT 3]
The HART database has the following structure.
The configuration file for this example shows that when the MAX Device Address
parameter is configured as 15, the module will reserve 750 words for each channel (15
devices x 50 words each) even though not all devices may be present on the network.
ProSoft Technology, Inc.
October 13, 2011
Page 97 of 171
Reference
User Manual
5.3
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Disabling the RSLinx Driver for the Com Port on the PC
The communication port driver in RSLinx can occasionally prevent other applications
from using the PC’s COM port. If you are not able to connect to the module’s
configuration/debug port using ProSoft Configuration Builder (PCB), HyperTerminal or
another terminal emulator, follow these steps to disable the RSLinx driver.
1 Open RSLinx and go to COMMUNICATIONS > RSWHO.
2 Make sure that you are not actively browsing using the driver that you wish to stop.
The following shows an actively browsed network.
3
Notice how the DF1 driver is opened, and the driver is looking for a processor on
node 1. If the network is being browsed, then you will not be able to stop this driver.
To stop the driver your RSWho screen should look like this:
Branches are displayed or hidden by clicking on the
4
or the
icons.
When you have verified that the driver is not being browsed, go to COMMUNICATIONS
> CONFIGURE DRIVERS.
You may see something like this:
Page 98 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
If you see the status as running, you will not be able to use this com port for anything
other than communication to the processor. To stop the driver press the STOP button
on the side of the window:
5
After you have stopped the driver you will see the following.
6
You may now use the com port to connect to the debug port of the module.
Note: You may need to shut down and restart your PC before it will allow you to
stop the driver (usually only on Windows NT machines). If you have followed all
of the above steps, and it will not stop the driver, then make sure you do not have
RSLogix open. If RSLogix is not open, and you still cannot stop the driver, then
reboot your PC.
ProSoft Technology, Inc.
October 13, 2011
Page 99 of 171
Reference
User Manual
5.4
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
RS-232 Configuration/Debug Port
This port is physically an RJ45 connection. An RJ45 to DB-9 adapter cable is included
with the module. This port permits a PC-based terminal emulation program to view
configuration and status data in the module and to control the module. The cable pinout
for communications on this port is shown in the following diagram.
Page 100 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.5
Reference
User Manual
DB9 to RJ45 Adaptor (Cable 14)
ProSoft Technology, Inc.
October 13, 2011
Page 101 of 171
Reference
User Manual
5.6
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Application Port Connection
The MVI56-HART module has a single terminal connector to attach the module to the
HART networks. The following diagrams display the configuration of the terminal
connector:
Page 102 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.7
Reference
User Manual
Example Field Terminations
Up to 15
instruments per
channel
One instrument per channel
Multi-drop Mode
(address 1 to 15)
Point to Point
Mode
(address 0 to 15)
Point to Point
Mode with
Analog
(address 0 only)
Power Mode A
Master Powered
24VDC connected instruments on all
4 channels
to HART power
terminals 1 and 2
on terminal block
OK
Install 250
OK
Install 1K resistor
OK
Power Mode B
HART power
terminals 1 and 2
on terminal block
left open
Loop Powered
instruments on 1
or more channels
OK
OK
OK
- differential or
single ended
analog signal
Self Powered
instruments on 1
or more channels
Not possible
OK
OK
-differential or
single ended
analog signal
ProSoft Technology, Inc.
October 13, 2011
1K
Page 103 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.7.1 Notes
1
2
3
4
All four channels on the unit must be either Master Powered (Power Mode A) or must
be Loop or Self powered (Power Mode B). You cannot mix Power Mode A and Power
Mode B on the same unit. You can mix Loop powered and Self powered instruments
on the same unit. However, you cannot mix Loop powered and Self powered
instruments on the same channel.
For Master Powered, Multi-drop Mode and Point to Point Mode, a 1K, 1W resistor
must be connected across the + and - input terminals of each HART channel.
Resistors are supplied with each product.
When configuring loop powered instruments in a Power Mode B type multi-drop
network, use only one power supply per HART channel if you wish to maintain
channel to channel isolation. If channel to channel isolation is not required, the same
power supply may be used for all four channels. However, a separate series resistor
is required for each channel. An appropriately sized resistor must be connected in
series with the power supply for each channel. The value and power rating of the
resistor is dependant upon the number of instruments in the loop and the length and
gauge of the pair of wires connecting the instruments to the unit. 250 Ohm, 3 Watt is
a good, first choice value.
If field instrument wiring is shielded, terminate shields at the ground terminals of the
HART connector. Do not terminate the shields at the instrument.
Page 104 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5
Reference
User Manual
For multi-drop applications, the 1K resistor should be normally used when one
transmitter is connected to the port. If you increase the number of devices connected
to a single port, you may need to reduce the size of the resistor.
ProSoft Technology, Inc.
October 13, 2011
Page 105 of 171
Reference
User Manual
Page 106 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
Reference
User Manual
Page 107 of 171
Reference
User Manual
Page 108 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
Reference
User Manual
Page 109 of 171
Reference
User Manual
Page 110 of 171
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.8
Reference
User Manual
MVI56-HART Status Data and Error Codes
5.8.1 Error/Status Data Block
This block is generated with a Read Block ID 0 or -1.
Offset
Content
Description
0
Reserved
Not used
1
Write Block ID
Block identification code for block requested by the
module.
2
Program Scan Count
This value is incremented each time a complete
program cycle occurs in the module.
3 to 4
Product Code
These two registers contain the product code of
"HRT5 "
5 to 6
Product Version
These two registers contain the product version for
the currently running software.
7 to 8
Operating System
These two registers contain the month and year
values for the program operating system.
9 to 10
Run Number
These two registers contain the run number value for
the currently running software.
11
Read Block Count
This field contains the total number of read blocks
transferred from the module to the processor.
12
Write Block Count
This field contains the total number of write blocks
transferred from the processor to the module.
13
Parse Block Count
This field contains the total number of blocks
successfully parsed that were received from the
processor.
14
Reserved
Not used
15
Command Block Count
This field contains the total number of command
blocks received from the processor for enable and
disable requests.
16
Error Block Count
This field contains the total number of block errors
recognized by the module.
17
Channel 1 State
Channel 1 state machine value (used for debugging)
0 Polling
1 Config
2 Data Poll
3 User Poll
4 Wait Unique ID
18
Comm State
Channel 1 communication state machine value (used
for debugging)
0 Startup
1 Idle
2 Transmit Pending
3 Transmit
4 Receive
5 Post Transmit
6 Idle, Waiting
ProSoft Technology, Inc.
October 13, 2011
Page 111 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Offset
Content
Description
19
Device Status (bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in error. If
the bit is clear (0), the slave is not in error.
20
Device Poll List (bit mapped) Each bit in this word corresponds to a slave
address on the network starting at bit 1 for slave
address 1. Bit 0 is not used. If the bit is set, the
slave is in the poll list. If the bit is clear (0), the
slave is not in the poll list.
21
Device With Long Address
(bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave uses the long
address. If the bit is clear (0), the slave does not use
the long address.
22
Current Command
This field contains the index of the current command
to execute.
23
Command Request Count
This field contains the total number of request
messages issued on the channel.
24
Command Response Count
This field contains the total number of response
messages received from devices on the network.
25
Configuration Error Word
Configuration error word (see table)
26
Current Error Code
Current error code for channel
27
Last Error Code
Last error code reported for channel
28
Channel 2 State
Channel 2 state machine value (used for debugging)
0 Polling
1 Config
2 Data Poll
3 User Poll
4 Wait Unique ID
29
Comm State
Channel 2 communication state machine value (used
for debugging)
0 Startup
1 Idle
2 Transmit Pending
3 Transmit
4 Receive
5 Post Transmit
6 Idle, Waiting
30
Device Status (bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in error. If
the bit is clear (0), the slave is not in error.
31
Device Poll List (bit mapped) Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in the poll
list. If the bit is clear (0), the slave is not in the poll list.
Page 112 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
Offset
Content
Description
32
Device With Long Address
(bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave uses the long
address. If the bit is clear (0), the slave does not use
the long address.
33
Current Command
This field contains the index of the current command
to execute.
34
Command Request Count
This field contains the total number of request
messages issued on the channel.
35
Command Response Count
This field contains the total number of response
messages received from devices on the network.
36
Configuration Error Word
Configuration error word (see table).
37
Current Error Code
Current error code for channel.
38
Last Error Code
Last error code reported for channel.
39
Channel 3 State
Channel 3 state machine value (used for debugging).
0 Polling
1 Config
2 Data Poll
3 User Poll
4 Wait Unique ID
40
Comm State
Channel 3 communication state machine value (used
for debugging).
0 Startup
1 Idle
2 Transmit Pending
3 Transmit
4 Receive
5 Post Transmit
6 Idle, Waiting
41
Device Status (bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in error. If
the bit is clear (0), the slave is not in error.
42
Device Poll List (bit mapped) Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in the poll
list. If the bit is clear (0), the slave is not in the poll list.
43
Device With Long Address
(bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave uses the long
address. If the bit is clear (0), the slave does not use
the long address.
44
Current Command
This field contains the index of the current command
to execute.
45
Command Request Count
This field contains the total number of request
messages issued on the channel.
46
Command Response Count
This field contains the total number of response
messages received from devices on the network.
47
Configuration Error Word
Configuration error word (see table).
ProSoft Technology, Inc.
October 13, 2011
Page 113 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Offset
Content
Description
48
Current Error Code
Current error code for channel.
49
Last Error Code
Last error code reported for channel.
50
Channel 4 State
Channel 4 state machine value (used for debugging).
0 Polling
1 Config
2 Data Poll
3 User Poll
4 Wait Unique ID
51
Comm State
Channel 4 communication state machine value (used
for debugging).
0 Startup
1 Idle
2 Transmit Pending
3 Transmit
4 Receive
5 Post Transmit
6 Idle, Waiting
52
Device Status (bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in error. If
the bit is clear (0), the slave is not in error.
53
Device Poll List (bit mapped) Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave is in the poll
list. If the bit is clear (0), the slave is not in the poll list.
54
Device With Long Address
(bit mapped)
Each bit in this word corresponds to a slave address
on the network starting at bit 1 for slave address 1. Bit
0 is not used. If the bit is set, the slave uses the long
address. If the bit is clear (0), the slave does not use
the long address.
55
Current Command
This field contains the index of the current command
to execute.
56
Command Request Count
This field contains the total number of request
messages issued on the channel.
57
Command Response Count
This field contains the total number of response
messages received from devices on the network.
58
Configuration Error Word
Configuration error word (see table).
59
Current Error Code
Current error code for channel.
60
Last Error Code
Last error code reported for channel.
61 to 248
Reserved
Not used.
249
Read Block ID
Block identification code of 0 or -1 to indicate a status
data block.
Page 114 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
5.8.2 Configuration Error Word
The following table defines the contents of the configuration error word. Each bit in the
word corresponds to an error condition recognized when the module is configured. There
is a separate word for each HART channel. This data is reported in the status data area
previously defined.
Bit
Code
Description
0
0x0001
Enabled not set to Y or N
1
0x0002
Enable Handheld not set to Y or N
2
0x0004
Primary Master not set to Y or N
3
0x0008
Invalid Preambles (1 to 50)
4
0x0010
Invalid Short Address Retries (0 to 50)
5
0x0020
Invalid Long Address Retries (0 to 50)
6
0x0040
Invalid Retries After Error (0 to 50)
7
0x0080
Invalid Poll Time After Error (0 to 10000)
8
0x0100
Invalid DB Address Status
9
0x0200
Invalid Command Count
10
0x0400
Memory Error in allocating commands
11
0x0800
Memory Error in allocating command fixed data
12
0x1000
Memory Error in allocating TX/RX buffers
13
0x2000
HART Board not found
14
0x4000
Cannot initialize HART channel
15
0x8000
Each command in the command list for each HART channel has a word value for a
status/error code. This error data list can be read using the Configuration/Debug Port and
can be placed in the module's internal database using the Error/Status Offset parameter
for each port. Accessing the Debug capabilities of the module is accomplished by
connecting a PC to the Debug port, then running a terminal emulation program. This
status/error code is the first word of the Integer Data Block returned from every HART
command executed. This word has information about the execution of the command by
the HART device.
Refer to the following section for a listing of the Error Codes to interpret the status/error
codes present in the integer data area. The following illustration shows the location of
each error word in the data block:
Word Offset
Description
0
…
…
99
Command 0 Error Value
...
...
Command 99 Error Value
The module error codes are listed in this section. Error codes returned from the HART
device are placed at the first word of the integer data block in the Virtual Database. The
error codes are formatted in the word as follows:
If the most-significant bit of the word contains "1", then the most significant byte has a
communication error code. The least-significant byte of the word will contain "0".
ProSoft Technology, Inc.
October 13, 2011
Page 115 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
If the most-significant bit of the word contains "0", the most significant byte contains a
command error code. In this case, the least-significant byte contains device malfunction
information.
If this word value is "-1" (or 0xFFFF), it means that the command timed out.
Use the error codes returned for each command in the list to determine the success or
failure of the command. If the command fails, use the error code to determine the cause
of failure.
5.8.3 Protocol Error Codes
These are error codes that are part of the HART protocol. The standard HART error
codes are shown in the tables below:
Error Code Word
First Byte
Second Byte
7
6
5
4
3
2
1
0
7
6
5
4
3
2
1
0
BIT 7 OF FIRST BYTE = 1
COMMUNICATION ERROR
FIRST BYTE
BIT 6
Parity Error
BIT 5
Overrun Error
BIT 4
Framing Error
BIT 3
Checksum Error
BIT 2
Reserved
BIT 1
RX Buffer Overflow
BIT 0
Undefined
SECOND BYTE
BIT 0 to BIT 7
All 0
BIT 7 OF FIRST BYTE = 0
COMMAND ERROR
FIRST BYTE
Bits 6 to 0 (not bit-mapped):
0
No Error
1
Undefined
2
Invalid Selection
3
Passed Parameter Too Large
4
Passed Parameter Too Small
5
Too Few Data Bytes Received
6
Transmitter-Specific Command Error
7
In Write-Protect Mode
8 to 15
Command Specific Errors (see Below)
16
Access Restricted
32
Device is Busy
Page 116 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
BIT 7 OF FIRST BYTE = 0
COMMAND ERROR
64
Command not Implemented
SECOND BYTE
BIT 7
Device Malfunction
BIT 6
Configuration Changed
BIT 5
Cold Start
BIT 4
Unused
BIT 3
Output Current Fixed
BIT 2
Analog Output Saturated
BIT 1
Variable (Not Primary) Out of Limits
BIT 0
Primary Variable Out of Limits
COMMAND SPECIFIC ERRORS
8
Update Failed
Update In Progress
Set to Nearest Possible Value
9
Applied Process Too High
Lower Range Value Too High
Not in Fixed Current Mode
10
Applied Process Too Low
Lower Range Value Too Low
Multi-drop Not Supported
11
In Multi-drop Mode
Invalid Transmitter Variable Code
Upper Range Value Too High
12
Invalid Unit Code
Upper Range Value Too Low
13
Both Range Values Out of Limits
14
Pushed Upper Range Value Over Limit
Span Too Small
ProSoft Technology, Inc.
October 13, 2011
Page 117 of 171
Reference
User Manual
5.9
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
HART Universal Commands
COMMAND 00 - Read Unique Identifier
Description
This command gets the long address of the HART device plus other manufacturer
information like Manufacturer ID, Device Type Code, Software Revision, Hardware
Revision, and so on.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Constant "254"
Manufacturer Identification Code
2
Manufacturer Device Type Code
Number of Preambles
3
Universal Command Revision
Transmitter Specific Command Revision
4
Software Revision
Hardware Revision
5
Device Function Flags
Device ID Number 1
6
Device ID Number 2
Device ID Number 3
Page 118 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 01 - Read Primary Variable
Description
This command gets the device Primary Variable and the Primary Variable Units
Write Parameters
NONE
Floating Point Data Returned
Word
High Byte
0
Primary Variable Value
Low Byte
1
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Primary Variable Units Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
0
Page 119 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 02 - Read Current And Percent Of Range
Description
This command gets the current of the loop that is forced by the HART device and the
Percent of Range of the Current.
Write Parameters
NONE
Floating Point Data Returned
Word
High Byte
0
Current (mA)
Low Byte
1
2
Percent of Range
3
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 120 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 03 - Read Dynamic Variables
Description
This command gets the current and four (predefined) dynamic Variables.
Write Parameters
NONE
Floating Point Data Returned
Word
High Byte
0
Current (mA)
Low Byte
1
2
Primary Variable
3
4
Second Variable
5
6
Third Variable
7
8
Fourth Variable
9
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Primary Variable Units Code
Second Variable Units Code
2
Third Variable Units Code
Fourth Variable Units Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 121 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 06 - Write Polling Address
Description
This command sets the polling address of a HART device. Extreme care should be taken
when you use this command because you can loose the communication with the device.
Write Parameters
Word
High Byte
Low Byte
0
Polling Address
Polling Address
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Polling Address
Page 122 of 171
Low Byte
0
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 12 - Read Message
Description
This command reads an ASCII message contained in the HART Device and written by
the Write Message command 17.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Message ASCII Character 0
Message ASCII Character 1
2
Message ASCII Character 2
Message ASCII Character 3
.
.
.
.
.
.
14
Message ASCII Character 28
Message ASCII Character 29
15
Message ASCII Character 30
Message ASCII Character 31
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 123 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 13 - Read Tag, Descriptor and Date
Description
This command reads an ASCII Tag which identifies the device, an ASCII descriptor of the
device and the last Date it has been configured.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
TAG ASCII Character 0
TAG ASCII Character 1
2
TAG ASCII Character 2
TAG ASCII Character 3
3
TAG ASCII Character 4
TAG ASCII Character 5
4
TAG ASCII Character 6
TAG ASCII Character 7
5
Descriptor ASCII Character 0
Message ASCII Character 1
.
.
.
.
.
.
12
Descriptor ASCII Character 14
Message ASCII Character 15
13
Date
Date
14
Date
0
Page 124 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 14 - Read PV Sensor Info
Description
This command gets information about the Primary Variable sensor, like limits and span.
Write Parameters
NONE
Floating Point Data Returned
Word
High Byte
0
Upper Sensor Limit
Low Byte
1
2
Lower Sensor Limit
3
4
Minimum Span
5
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Sensor Serial Number 0
Sensor Serial Number 1
2
Sensor Serial Number 2
Unit Codes for Sensor Limits and Span
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 125 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 15 - Read Output Information
Description
This command gets information about the Primary Variable Output Information.
Write Parameters
NONE
Floating Point Data Returned
Word
High Byte
0
Upper Range Value
Low Byte
1
2
Lower Range Value
3
4
Damping Value (Sec)
5
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Alarm Select Code
Transfer Function Code
2
Primary Variable Range Units Code
Write-Protect Code
2
Private-Label Distributor Code
0
Page 126 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 16 - Read Final Assembly Number
Description
This command reads the final assembly number of the HART device.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Final Assembly Number 0
Final Assembly Number 1
2
Final Assembly Number 2
0
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 127 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 17 - Write Message
Description
This command writes an ASCII message contained in the HART Device and that can be
read with command 12.
Write Parameters
Word
High Byte
Low Byte
0
Packed ASCII Message Byte 0
Packed ASCII Message Byte 1
1
Packed ASCII Message Byte 2
Packed ASCII Message Byte 3
.
.
.
.
.
.
11
Packed ASCII Message Byte 22
Packed ASCII Message Byte 23
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 128 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 18 - Write Tag, Descriptor and Date
Description
This command writes an ASCII Tag which identifies the device, an ASCII descriptor of
the device and the last Date it has been configured.
Write Parameters
Word
High Byte
Low Byte
0
Packed ASCII TAG Byte 0
Packed ASCII TAG Byte 1
1
Packed ASCII TAG Byte 2
Packed ASCII TAG Byte 3
2
Packed ASCII TAG Byte 4
Packed ASCII TAG Byte 5
3
Packed ASCII Descriptor Byte 0
Packed ASCII Descriptor Byte 1
.
.
.
.
.
.
8
Packed ASCII Descriptor Byte 10
Packed ASCII Descriptor Byte 11
9
Date
Date
10
Date
0
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
TAG ASCII Character 0
TAG ASCII Character 1
2
TAG ASCII Character 2
TAG ASCII Character 3
3
TAG ASCII Character 4
TAG ASCII Character 5
4
TAG ASCII Character 6
TAG ASCII Character 7
5
Descriptor ASCII Character 0
Message ASCII Character 1
.
.
.
.
.
.
12
Descriptor ASCII Character 14
Message ASCII Character 15
13
Date
Date
14
Date
0
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 129 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 19 - Write Final Assembly Number
Description
This command writes the final assembly number of the HART device.
Write Parameters
Word
High Byte
Low Byte
0
Final Assembly Number 0
Final Assembly Number 1
1
Final Assembly Number 2
Final Assembly Number 2
Floating Point Data Returned:
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Final Assembly Number 0
Final Assembly Number 1
2
Final Assembly Number 2
0
Page 130 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
5.10
Reference
User Manual
HART Common Practice Commands
COMMAND 33 - Read Transmitter Variables
Description
This command gets four user selected dynamic Variables.
Write Parameters
Word
High Byte
Low Byte
0
Transmitter Variable Code For Slot 0
Transmitter Variable Code For Slot 1
1
Transmitter Variable Code For Slot 2
Transmitter Variable Code For Slot 3
Floating Point Data Returned
Word
High Byte
0
Variable for Slot 0
Low Byte
1
2
Variable for Slot 0
3
4
Variable for Slot 2
5
6
Variable for Slot 3
7
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transmitter Variable Code For Slot 0
Units Code for Slot 0 Variable
2
Transmitter Variable Code For Slot 1
Units Code for Slot 1 Variable
3
Transmitter Variable Code For Slot 2
Units Code for Slot 2 Variable
4
Transmitter Variable Code For Slot 3
Units Code for Slot 3 Variable
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 131 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 34 - Write Damping Value
Description
This command writes the damping value of a HART device.
Write Parameters
Word
High Byte
0
Floating Point Damping Value (Sec)
Low Byte
1
Floating Point Data Returned
Word
High Byte
0
Floating Point Damping Value (Sec)
Low Byte
1
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 132 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 35 - Write Range Values
Description
This command writes the Upper and Lower range of the Primary Variable
Write Parameters
Word
High Byte
Low Byte
0
Range Units Code
Floating Point Upper Range Value (Byte 0)
1
Floating Point Upper Range Value (Byte 1)
Floating Point Upper Range Value (Byte 2)
2
Floating Point Upper Range Value (Byte 3)
Floating Point Lower Range Value (Byte 0)
3
Floating Point Lower Range Value (Byte 1)
Floating Point Lower Range Value (Byte 2)
4
Floating Point Lower Range Value (Byte 3)
Floating Point Lower Range Value (Byte 3)
Floating Point Data Returned
Word
High Byte
0
Upper Range Value
Low Byte
1
2
Lower Range Value
3
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Range Units Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
0
Page 133 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 36 - Set Upper Range Value
Description
This command is similar in effect to push the SPAN button of the HART device but doing
it remotely through the HART network.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 134 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 37 - Set Lower Range Value
Description
This command is similar in effect to push the ZERO button of the HART device but doing
it remotely through the HART network.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 135 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 38 - Reset Configuration Changed Flag
Description
This command resets the status bit that indicates that configuration has been changed.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 136 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 39 - EEPROM Control
Description
This command operates over the EEPROM changing its settings.
Write Parameters
Word
High Byte
Low Byte
0
EEPROM Control Code
EEPROM Control Code
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
EEPROM Control Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
0
Page 137 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 40 - Enter Exit Fixed Current Mode
Description
This command writes the damping value of a HART device.
Write Parameters
Word
High Byte
0
Floating Point Current (mA)
Low Byte
1
Floating Point Data Returned
Word
High Byte
0
Floating Point Current (mA)
Low Byte
1
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 138 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 41 - Perform Transmitter Self Test
Description
This command starts the HART device Self Test to find if there is any problem with the
device hardware.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 139 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 42 - Perform Master Reset
Description
This command performs a master reset in the HART device.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 140 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 43 - Set PV Zero
Description
This command forces the Primary Value to Zero.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 141 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 44 - Write PV Units
Description
This command changes the setting of the Primary Variable units.
Write Parameters
Word
High Byte
Low Byte
0
Primary Variable Units Code
Primary Variable Units Code
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Primary Variable Units Code
Page 142 of 171
Low Byte
0
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 45 - Trim DAC Zero
Description
This command calibrates the device Digital to analog converter zero. This is done by
writing the same current value that is measured in the loop.
Write Parameters
Word
High Byte
0
Floating Point measured current (mA)
Low Byte
1
Floating Point Data Returned
Word
High Byte
0
Floating Point Current (mA)
Low Byte
1
Integer Data Returned
Word
High Byte
0
STATUS WORD
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 143 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 46 - Trim DAC Gain
Description
This command calibrates the device Digital to analog converter gain. This is done by
writing the same current value that is measured in the loop.
Write Parameters
Word
High Byte
0
Floating Point Measured Current (mA)
Low Byte
1
Floating Point Data Returned
Word
High Byte
0
Floating Point Current (mA)
Low Byte
1
Integer Data Returned
Word
High Byte
0
STATUS WORD
Page 144 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 47 - Write Transfer Function
Description
This command changes the setting of the Transfer Function of the HART device.
Write Parameters
Word
High Byte
Low Byte
0
Transfer Function Code
Transfer Function Code
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transfer Function Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
0
Page 145 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 48 - Read Additional Transmitter Status
Description
This command gets extended information about the status of the Transmitter. This
information is specific for each transmitter.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Additional Status (Byte 0)
Additional Status (Byte 1)
2
Additional Status (Byte 2)
Additional Status (Byte 3)
.
.
.
.
.
.
13
Additional Status (Byte 24)
Page 146 of 171
Low Byte
0
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 49 - Write PV Sensor Serial Number
Description
This command changes the sensor serial number of the Primary Variable.
Write Parameters
Word
High Byte
Low Byte
0
Sensor Serial Number (Byte 0)
Sensor Serial Number (Byte 1)
1
Sensor Serial Number (Byte 2)
Sensor Serial Number (Byte 2)
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Sensor Serial Number (Byte 0)
Sensor Serial Number (Byte 1)
2
Sensor Serial Number (Byte 2)
0
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 147 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 50 - Read Dynamic Variable Assignments
Description
This command gets the actual assignment of the Dynamic Variables returned with
command 3.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transmitter Variable Code For Primary
Variable
Transmitter Variable Code For Second
Variable
2
Transmitter Variable Code For Third
Variable
Transmitter Variable Code For Fourth
Variable
Page 148 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 51 - Write Dynamic Variable Assignments
Description
This command sets the assignment of the Dynamic Variables returned with command 3.
Write Parameters
Word
High Byte
Low Byte
0
Transmitter Variable Code For Primary
Variable
Transmitter Variable Code For Second
Variable
1
Transmitter Variable Code For Third
Variable
Transmitter Variable Code For Fourth
Variable
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transmitter Variable Code For Primary
Variable
Transmitter Variable Code For Second
Variable
2
Transmitter Variable Code For Third
Variable
Transmitter Variable Code For Fourth
Variable
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 149 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 52 - Set Transmitter Variable Zero
Description
This command forces a selected transmitter variable to zero.
Write Parameters
Word
High Byte
Low Byte
0
Transmitter Variable Code
Transmitter Variable Code
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Primary Variable Units Code
Page 150 of 171
Low Byte
0
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 53 - Write Transmitter Variable Units
Description
This command changes a selected transmitter variable unit.
Write Parameters:
Word
High Byte
Low Byte
0
Transmitter Variable Code
Transmitter Variable Units Code
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Primary Variable Units Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Transmitter Variable Units Code
Page 151 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 54 - Read Transmitter Variable Information
Description
This command gets information about any selected transmitter variable sensor.
Write Parameters
Word
High Byte
Low Byte
0
Transmitter Variable Code
Transmitter Variable Code
Floating Point Data Returned
Word
High Byte
0
Transmitter Variable Upper Limit
Low Byte
1
2
Transmitter Variable Lower Limit
3
4
Transmitter Variable Damping Value (Sec)
5
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transmitter Variable Code
1
Sensor Serial Number 1
Sensor Serial Number 2
2
Unit Code for Limits
0
Page 152 of 171
Low Byte
Sensor Serial Number 0
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 55 - Write Transmitter Variable Damping Value
Description
This command writes the Damping Value of a user selected transmitter variable.
Write Parameters
Word
High Byte
Low Byte
0
Transmitter Variable Code
Transmitter Variable Damping Value (Byte
0)
1
Transmitter Variable Damping Value (Byte
1)
Transmitter Variable Damping Value (Byte
2)
2
Transmitter Variable Damping Value (Byte
3)
Transmitter Variable Damping Value (Byte
3)
Floating Point Data Returned
Word
High Byte
0
Transmitter Variable Damping Value
Low Byte
1
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transmitter Variable Code
ProSoft Technology, Inc.
October 13, 2011
Low Byte
0
Page 153 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 56 - Write Transmitter Variable Sensor Serial Number
Description
This command writes the Serial Number of a user selected transmitter variable.
Write Parameters
Word
High Byte
Low Byte
0
Transmitter Variable Code
Transmitter Variable Sensor Serial Number
(Byte 0)
1
Transmitter Variable Sensor Serial Number
(Byte 1)
Transmitter Variable Sensor Serial Number
(Byte 2)
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Transmitter Variable Code
Transmitter Variable Sensor Serial Number
(Byte 0)
2
Transmitter Variable Sensor Serial Number
(Byte 1)
Transmitter Variable Sensor Serial Number
(Byte 2)
Page 154 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 57 - Read Unit Tag Descriptor Date
Description
This command reads an ASCII Tag which identifies the device, an ASCII descriptor of the
device and the last Date it has been configured.
Write Parameters
NONE
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
TAG ASCII Character 0
TAG ASCII Character 1
2
TAG ASCII Character 2
TAG ASCII Character 3
3
TAG ASCII Character 4
TAG ASCII Character 5
4
TAG ASCII Character 6
TAG ASCII Character 7
5
Descriptor ASCII Character 0
Message ASCII Character 1
.
.
.
.
.
.
12
Descriptor ASCII Character 14
Message ASCII Character 15
13
Date
Date
14
Date
0
ProSoft Technology, Inc.
October 13, 2011
Low Byte
Page 155 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 58 - Write Unit Tag Descriptor Date
Description
This command writes an ASCII Tag which identifies the device, an ASCII descriptor of
the device and the last Date it has been configured.
Write Parameters:
Word
High Byte
Low Byte
0
Packed ASCII TAG Byte 0
Packed ASCII TAG Byte 1
1
Packed ASCII TAG Byte 2
Packed ASCII TAG Byte 3
2
Packed ASCII TAG Byte 4
Packed ASCII TAG Byte 5
3
Packed ASCII Descriptor Byte 0
Packed ASCII Descriptor Byte 1
.
.
.
.
.
.
8
Packed ASCII Descriptor Byte 10
Packed ASCII Descriptor Byte 11
9
Date
Date
10
Date
0
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
TAG ASCII Character 0
TAG ASCII Character 1
2
TAG ASCII Character 2
TAG ASCII Character 3
3
TAG ASCII Character 4
TAG ASCII Character 5
4
TAG ASCII Character 6
TAG ASCII Character 7
5
Descriptor ASCII Character 0
Message ASCII Character 1
.
.
.
.
.
.
12
Descriptor ASCII Character 14
Message ASCII Character 15
13
Date
Date
14
Date
0
Page 156 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 59 - Write Number Of Response Preambles
Description
This command sets the number of preambles that the HART slave will use in every
command response.
Write Parameters
Word
High Byte
Low Byte
0
Number of Response Preambles
Number of Response Preambles
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Number of Response Preambles
ProSoft Technology, Inc.
October 13, 2011
Low Byte
0
Page 157 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 108 - Write Burst Mode Command Number
Description
This command sets the command number that the HART device will use in Burst Mode.
Write Parameters
Word
High Byte
Low Byte
0
Burst Mode Command Number
Burst Mode Command Number
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Burst Mode Command Number
Page 158 of 171
Low Byte
0
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Reference
User Manual
COMMAND 109 - Burst Mode Control
Description
This command sets the HART device Burst Mode.
Write Parameters
Word
High Byte
Low Byte
0
Burst Mode Control Code
Burst Mode Control Code
Floating Point Data Returned
NONE
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Burst Mode Control Code
Low Byte
0
1 = ON
0 = Off
ProSoft Technology, Inc.
October 13, 2011
Page 159 of 171
Reference
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 110 - Read All Dynamic Variables
Description
This command gets all dynamic Variables.
Write Parameters
NONE
Floating Point Data Returned
Word
High Byte
0
Primary Variable
Low Byte
1
2
Second Variable
3
4
Third Variable
5
6
Fourth Variable
7
Integer Data Returned
Word
High Byte
0
STATUS WORD
1
Primary Variable Units Code
Second Variable Units Code
2
Third Variable Units Code
Fourth Variable Units Code
Page 160 of 171
Low Byte
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
6
Support, Service & Warranty
User Manual
Support, Service & Warranty
In This Chapter
Contacting Technical Support ............................................................. 161
Return Material Authorization (RMA) Policies and Conditions............. 163
LIMITED WARRANTY ......................................................................... 165
Contacting Technical Support
ProSoft Technology, Inc. (ProSoft) is committed to providing the most efficient and
effective support possible. Before calling, please gather the following information to assist
in expediting this process:
1 Product Version Number
2 System architecture
3 Network details
If the issue is hardware related, we will also need information regarding:
1 Module configuration and associated ladder files, if any
2 Module operation and any unusual behavior
3 Configuration/Debug status information
4 LED patterns
5 Details about the serial, Ethernet or fieldbus devices interfaced to the module, if any.
Note: For technical support calls within the United States, an after-hours
answering system allows 24-hour/7-days-a-week pager access to one of our
qualified Technical and/or Application Support Engineers. Detailed contact
information for all our worldwide locations is available on the following page.
ProSoft Technology, Inc.
October 13, 2011
Page 161 of 171
Support, Service & Warranty
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Internet
Web Site: www.prosoft-technology.com/support
E-mail address: support@prosoft-technology.com
Asia Pacific
(location in Malaysia)
Tel: +603.7724.2080, E-mail: asiapc@prosoft-technology.com
Languages spoken include: Chinese, English
Asia Pacific
(location in China)
Tel: +86.21.5187.7337 x888, E-mail: asiapc@prosoft-technology.com
Languages spoken include: Chinese, English
Europe
(location in Toulouse,
France)
Tel: +33 (0) 5.34.36.87.20,
E-mail: support.EMEA@prosoft-technology.com
Languages spoken include: French, English
Europe
(location in Dubai, UAE)
Tel: +971-4-214-6911,
E-mail: mea@prosoft-technology.com
Languages spoken include: English, Hindi
North America
(location in California)
Tel: +1.661.716.5100,
E-mail: support@prosoft-technology.com
Languages spoken include: English, Spanish
Latin America
(Oficina Regional)
Tel: +1-281-2989109,
E-Mail: latinam@prosoft-technology.com
Languages spoken include: Spanish, English
Latin America
Tel: +52-222-3-99-6565,
(location in Puebla, Mexico) E-mail: soporte@prosoft-technology.com
Languages spoken include: Spanish
Brasil
(location in Sao Paulo)
Page 162 of 171
Tel: +55-11-5083-3776,
E-mail: brasil@prosoft-technology.com
Languages spoken include: Portuguese, English
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
6.1
Support, Service & Warranty
User Manual
Return Material Authorization (RMA) Policies and Conditions
The following Return Material Authorization (RMA) Policies and Conditions (collectively,
"RMA Policies") apply to any returned product. These RMA Policies are subject to
change by ProSoft Technology, Inc., without notice. For warranty information, see Limited
Warranty (page 165). In the event of any inconsistency between the RMA Policies and
the Warranty, the Warranty shall govern.
6.1.1 Returning Any Product
a) In order to return a Product for repair, exchange, or otherwise, the Customer must
obtain a Return Material Authorization (RMA) number from ProSoft Technology
and comply with ProSoft Technology shipping instructions.
b) In the event that the Customer experiences a problem with the Product for any
reason, Customer should contact ProSoft Technical Support at one of the
telephone numbers listed above (page 161). A Technical Support Engineer will
request that you perform several tests in an attempt to isolate the problem. If after
completing these tests, the Product is found to be the source of the problem, we
will issue an RMA.
c) All returned Products must be shipped freight prepaid, in the original shipping
container or equivalent, to the location specified by ProSoft Technology, and be
accompanied by proof of purchase and receipt date. The RMA number is to be
prominently marked on the outside of the shipping box. Customer agrees to
insure the Product or assume the risk of loss or damage in transit. Products
shipped to ProSoft Technology using a shipment method other than that specified
by ProSoft Technology, or shipped without an RMA number will be returned to the
Customer, freight collect. Contact ProSoft Technical Support for further
information.
d) A 10% restocking fee applies to all warranty credit returns, whereby a Customer
has an application change, ordered too many, does not need, etc. Returns for
credit require that all accessory parts included in the original box (i.e.; antennas,
cables) be returned. Failure to return these items will result in a deduction from
the total credit due for each missing item.
ProSoft Technology, Inc.
October 13, 2011
Page 163 of 171
Support, Service & Warranty
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
6.1.2 Returning Units Under Warranty
A Technical Support Engineer must approve the return of Product under ProSoft
Technology’s Warranty:
a) A replacement module will be shipped and invoiced. A purchase order will be
required.
b) Credit for a product under warranty will be issued upon receipt of authorized
product by ProSoft Technology at designated location referenced on the Return
Material Authorization
i. If a defect is found and is determined to be customer generated, or if the
defect is otherwise not covered by ProSoft Technology s warranty, there will
be no credit given. Customer will be contacted and can request module be
returned at their expense;
ii. If defect is customer generated and is repairable, customer can authorize
ProSoft Technology to repair the unit by providing a purchase order for 30%
of the current list price plus freight charges, duties and taxes as applicable.
6.1.3 Returning Units Out of Warranty
a) Customer sends unit in for evaluation to location specified by ProSoft
Technology, freight prepaid.
b) If no defect is found, Customer will be charged the equivalent of $100 USD, plus
freight charges, duties and taxes as applicable. A new purchase order will be
required.
c) If unit is repaired, charge to Customer will be 30% of current list price (USD) plus
freight charges, duties and taxes as applicable. A new purchase order will be
required or authorization to use the purchase order submitted for evaluation fee.
The following is a list of non-repairable units:
ScanPort Adapters
o 1500 - All
o 1550 - Can be repaired only if defect is the power supply
o 1560 - Can be repaired only if defect is the power supply
inRAx Modules
o 3150 - All
o 3170 - All
o 3250
o 3300
o 3350
o 3600 - All
o 3700
o 3750
o 3800-MNET
ProLinx Standalone Gateways
o 4xxx - All (No hardware available to do repairs)
Page 164 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
6.2
Support, Service & Warranty
User Manual
LIMITED WARRANTY
This Limited Warranty ("Warranty") governs all sales of hardware, software, and other
products (collectively, "Product") manufactured and/or offered for sale by ProSoft
Technology, Incorporated (ProSoft), and all related services provided by ProSoft,
including maintenance, repair, warranty exchange, and service programs (collectively,
"Services"). By purchasing or using the Product or Services, the individual or entity
purchasing or using the Product or Services ("Customer") agrees to all of the terms and
provisions (collectively, the "Terms") of this Limited Warranty. All sales of software or
other intellectual property are, in addition, subject to any license agreement
accompanying such software or other intellectual property.
6.2.1 What Is Covered By This Warranty
a) Warranty On New Products: ProSoft warrants, to the original purchaser, that the
Product that is the subject of the sale will (1) conform to and perform in
accordance with published specifications prepared, approved and issued by
ProSoft, and (2) will be free from defects in material or workmanship; provided
these warranties only cover Product that is sold as new. This Warranty expires
three (3) years from the date of shipment for Product purchased on or after
January 1st, 2008, or one (1) year from the date of shipment for Product
purchased before January 1st, 2008 (the "Warranty Period"). If the Customer
discovers within the Warranty Period a failure of the Product to conform to
specifications, or a defect in material or workmanship of the Product, the
Customer must promptly notify ProSoft by fax, email or telephone. In no event
may that notification be received by ProSoft later than 39 months from date of
original shipment. Within a reasonable time after notification, ProSoft will correct
any failure of the Product to conform to specifications or any defect in material or
workmanship of the Product, with either new or remanufactured replacement
parts. ProSoft reserves the right, and at its sole discretion, may replace
unrepairable units with new or remanufactured equipment. All replacement units
will be covered under warranty for the 3 year period commencing from the date of
original equipment purchase, not the date of shipment of the replacement unit.
Such repair, including both parts and labor, will be performed at ProSoft’s
expense. All warranty service will be performed at service centers designated by
ProSoft.
b) Warranty On Services: Materials and labor performed by ProSoft to repair a
verified malfunction or defect are warranteed in the terms specified above for new
Product, provided said warranty will be for the period remaining on the original
new equipment warranty or, if the original warranty is no longer in effect, for a
period of 90 days from the date of repair.
ProSoft Technology, Inc.
October 13, 2011
Page 165 of 171
Support, Service & Warranty
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
6.2.2 What Is Not Covered By This Warranty
a) ProSoft makes no representation or warranty, expressed or implied, that the
operation of software purchased from ProSoft will be uninterrupted or error free or
that the functions contained in the software will meet or satisfy the purchaser’s
intended use or requirements; the Customer assumes complete responsibility for
decisions made or actions taken based on information obtained using ProSoft
software.
b) This Warranty does not cover the failure of the Product to perform specified
functions, or any other non-conformance, defects, losses or damages caused by
or attributable to any of the following: (i) shipping; (ii) improper installation or other
failure of Customer to adhere to ProSoft’s specifications or instructions; (iii)
unauthorized repair or maintenance; (iv) attachments, equipment, options, parts,
software, or user-created programming (including, but not limited to, programs
developed with any IEC 61131-3, "C" or any variant of "C" programming
languages) not furnished by ProSoft; (v) use of the Product for purposes other
than those for which it was designed; (vi) any other abuse, misapplication, neglect
or misuse by the Customer; (vii) accident, improper testing or causes external to
the Product such as, but not limited to, exposure to extremes of temperature or
humidity, power failure or power surges; or (viii) disasters such as fire, flood,
earthquake, wind and lightning.
c) The information in this Agreement is subject to change without notice. ProSoft
shall not be liable for technical or editorial errors or omissions made herein; nor
for incidental or consequential damages resulting from the furnishing,
performance or use of this material. The user guide included with your original
product purchase from ProSoft contains information protected by copyright. No
part of the guide may be duplicated or reproduced in any form without prior
written consent from ProSoft.
6.2.3 Disclaimer Regarding High Risk Activities
Product manufactured or supplied by ProSoft is not fault tolerant and is not designed,
manufactured or intended for use in hazardous environments requiring fail-safe
performance including and without limitation: the operation of nuclear facilities, aircraft
navigation of communication systems, air traffic control, direct life support machines or
weapons systems in which the failure of the product could lead directly or indirectly to
death, personal injury or severe physical or environmental damage (collectively, "high risk
activities"). ProSoft specifically disclaims any express or implied warranty of fitness for
high risk activities.
Page 166 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Support, Service & Warranty
User Manual
6.2.4 Intellectual Property Indemnity
Buyer shall indemnify and hold harmless ProSoft and its employees from and against all
liabilities, losses, claims, costs and expenses (including attorney’s fees and expenses)
related to any claim, investigation, litigation or proceeding (whether or not ProSoft is a
party) which arises or is alleged to arise from Buyer’s acts or omissions under these
Terms or in any way with respect to the Products. Without limiting the foregoing, Buyer
(at its own expense) shall indemnify and hold harmless ProSoft and defend or settle any
action brought against such Companies to the extent based on a claim that any Product
made to Buyer specifications infringed intellectual property rights of another
party. ProSoft makes no warranty that the product is or will be delivered free of any
person’s claiming of patent, trademark, or similar infringement. The Buyer assumes all
risks (including the risk of suit) that the product or any use of the product will infringe
existing or subsequently issued patents, trademarks, or copyrights.
a) Any documentation included with Product purchased from ProSoft is protected by
copyright and may not be duplicated or reproduced in any form without prior
written consent from ProSoft.
b) ProSoft’s technical specifications and documentation that are included with the
Product are subject to editing and modification without notice.
c) Transfer of title shall not operate to convey to Customer any right to make, or
have made, any Product supplied by ProSoft.
d) Customer is granted no right or license to use any software or other intellectual
property in any manner or for any purpose not expressly permitted by any license
agreement accompanying such software or other intellectual property.
e) Customer agrees that it shall not, and shall not authorize others to, copy software
provided by ProSoft (except as expressly permitted in any license agreement
accompanying such software); transfer software to a third party separately from
the Product; modify, alter, translate, decode, decompile, disassemble, reverseengineer or otherwise attempt to derive the source code of the software or create
derivative works based on the software; export the software or underlying
technology in contravention of applicable US and international export laws and
regulations; or use the software other than as authorized in connection with use
of Product.
f) Additional Restrictions Relating To Software And Other Intellectual
Property
In addition to compliance with the Terms of this Warranty, Customers purchasing
software or other intellectual property shall comply with any license agreement
accompanying such software or other intellectual property. Failure to do so may
void this Warranty with respect to such software and/or other intellectual property.
6.2.5 Disclaimer of all Other Warranties
The Warranty set forth in What Is Covered By This Warranty (page 165) are in lieu of all
other warranties, express or implied, including but not limited to the implied warranties of
merchantability and fitness for a particular purpose.
ProSoft Technology, Inc.
October 13, 2011
Page 167 of 171
Support, Service & Warranty
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
6.2.6 Limitation of Remedies **
In no event will ProSoft or its Dealer be liable for any special, incidental or consequential
damages based on breach of warranty, breach of contract, negligence, strict tort or any
other legal theory. Damages that ProSoft or its Dealer will not be responsible for include,
but are not limited to: Loss of profits; loss of savings or revenue; loss of use of the
product or any associated equipment; loss of data; cost of capital; cost of any substitute
equipment, facilities, or services; downtime; the claims of third parties including,
customers of the Purchaser; and, injury to property.
** Some areas do not allow time limitations on an implied warranty, or allow the
exclusion or limitation of incidental or consequential damages. In such areas, the
above limitations may not apply. This Warranty gives you specific legal rights,
and you may also have other rights which vary from place to place.
6.2.7 Time Limit for Bringing Suit
Any action for breach of warranty must be commenced within 39 months following
shipment of the Product.
6.2.8 No Other Warranties
Unless modified in writing and signed by both parties, this Warranty is understood to be
the complete and exclusive agreement between the parties, suspending all oral or written
prior agreements and all other communications between the parties relating to the
subject matter of this Warranty, including statements made by salesperson. No employee
of ProSoft or any other party is authorized to make any warranty in addition to those
made in this Warranty. The Customer is warned, therefore, to check this Warranty
carefully to see that it correctly reflects those terms that are important to the Customer.
6.2.9 Allocation of Risks
This Warranty allocates the risk of product failure between ProSoft and the Customer.
This allocation is recognized by both parties and is reflected in the price of the goods.
The Customer acknowledges that it has read this Warranty, understands it, and is bound
by its Terms.
6.2.10 Controlling Law and Severability
This Warranty shall be governed by and construed in accordance with the laws of the
United States and the domestic laws of the State of California, without reference to its
conflicts of law provisions. If for any reason a court of competent jurisdiction finds any
provisions of this Warranty, or a portion thereof, to be unenforceable, that provision shall
be enforced to the maximum extent permissible and the remainder of this Warranty shall
remain in full force and effect. Any cause of action with respect to the Product or Services
must be instituted in a court of competent jurisdiction in the State of California.
Page 168 of 171
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Index
[
[HART PORT x COMMANDS] • 38
[HART PORT x] • 35
[MODULE] • 34
A
Adding the Module to an Existing Project •
57
Allocation of Risks • 168
Analyzing Data for Port 1 • 70
Application Port Connection • 102
Auto-Poll Code • 36
Auto-Poll Data (HARTAutoPoll) • 56
Auto-Poll DB Address • 37
Auto-Poll Disabled Mode • 93
Auto-Poll Modes • 89
Auto-Poll Swap Float • 37
Auto-Polling • 91
B
Backplane Data Transfer • 84
Backplane Object (HARTBackplane) • 54
Battery Life Advisory • 4
Block 9902
Command Control • 41, 86
Block 9903
Command Disable Control Block • 41, 87
Block 9950
Read Command Error List • 87
Block 9998
Warm Boot • 88
Block 9999
Cold Boot • 88
Burst Mode • 91
Byte Count • 44
C
Channel Status Object (HARTCHStat) • 53
Clearing a Fault Condition • 76
COMMAND 00 - Read Unique Identifier •
118
COMMAND 01 - Read Primary Variable •
119
COMMAND 02 - Read Current And Percent
Of Range • 120
COMMAND 03 - Read Dynamic Variables •
121
COMMAND 06 - Write Polling Address • 122
COMMAND 108 - Write Burst Mode
Command Number • 158
COMMAND 109 - Burst Mode Control • 159
ProSoft Technology, Inc.
October 13, 2011
Index
User Manual
COMMAND 110 - Read All Dynamic
Variables • 160
COMMAND 12 - Read Message • 123
COMMAND 13 - Read Tag, Descriptor and
Date • 124
COMMAND 14 - Read PV Sensor Info • 125
COMMAND 15 - Read Output Information •
126
COMMAND 16 - Read Final Assembly
Number • 127
COMMAND 17 - Write Message • 128
COMMAND 18 - Write Tag, Descriptor and
Date • 129
COMMAND 19 - Write Final Assembly
Number • 130
COMMAND 33 - Read Transmitter Variables
• 131
COMMAND 34 - Write Damping Value • 132
COMMAND 35 - Write Range Values • 133
COMMAND 36 - Set Upper Range Value •
134
COMMAND 37 - Set Lower Range Value •
135
COMMAND 38 - Reset Configuration
Changed Flag • 136
COMMAND 39 - EEPROM Control • 137
COMMAND 40 - Enter Exit Fixed Current
Mode • 138
COMMAND 41 - Perform Transmitter Self
Test • 139
COMMAND 42 - Perform Master Reset • 140
COMMAND 43 - Set PV Zero • 141
COMMAND 44 - Write PV Units • 142
COMMAND 45 - Trim DAC Zero • 143
COMMAND 46 - Trim DAC Gain • 144
COMMAND 47 - Write Transfer Function •
145
COMMAND 48 - Read Additional Transmitter
Status • 146
COMMAND 49 - Write PV Sensor Serial
Number • 147
COMMAND 50 - Read Dynamic Variable
Assignments • 148
COMMAND 51 - Write Dynamic Variable
Assignments • 149
COMMAND 52 - Set Transmitter Variable
Zero • 150
COMMAND 53 - Write Transmitter Variable
Units • 151
COMMAND 54 - Read Transmitter Variable
Information • 152
COMMAND 55 - Write Transmitter Variable
Damping Value • 153
COMMAND 56 - Write Transmitter Variable
Sensor Serial Number • 154
COMMAND 57 - Read Unit Tag Descriptor
Date • 155
COMMAND 58 - Write Unit Tag Descriptor
Date • 156
Page 169 of 171
Index
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
COMMAND 59 - Write Number Of Response
Preambles • 157
Command Control Blocks • 86
Command Count • 36
Command List Overview • 38
Commands Supported by the Module • 39,
41
Configuration Error Word • 115
Configuration/Error Status Flags (Cfg_Err) •
54
Configuring Module Parameters • 32
Configuring the MVI56-HART Module • 29
Configuring the RSLinx Driver for the PC
COM Port • 24
Connecting Your PC to the ControlLogix
Processor • 20
Connecting Your PC to the Module • 27
Contacting Technical Support • 161, 163
Controller Tags • 52
Controlling Law and Severability • 168
Creating Optional Comment Entries • 33
D
Data Analyzer • 68, 70
Data Analyzer Tips • 73
Data Object (HARTData) • 55
DB Address Status • 36
DB9 to RJ45 Adaptor (Cable 14) • 101
Determining the Firmware Version of Your
Processor • 21
Diagnostics and Troubleshooting • 11, 61
Disabling the RSLinx Driver for the Com Port
on the PC • 98
Disclaimer of all Other Warranties • 167
Disclaimer Regarding High Risk Activities •
166
Displaying Timing Marks in the Data
Analyzer • 71
Done DB Address • 44
Downloading the Project to the Module
Using a Serial COM Port • 49
Downloading the Sample Program to the
Processor • 26
E
Enable • 41
Enable DB Address • 43
Enabled • 35
Error/Status Data Block • 111
Error/Status Offset • 35
Example Field Terminations • 103
Example of HART Command Function 3 • 45
Example of HART Command Function 34 •
47
Exiting the Program • 67
F
Failure Flag Count • 35
Fixed Data • 44
Page 170 of 171
Float DB Address • 42
FP Word Count • 42
Function Code • 43
Functional Overview • 83
Functional Specifications • 82
G
General Concepts • 83
General Specifications • 80
Guide to the MVI56-HART User Manual • 11
H
Hardware Specifications • 81
HART Channels • 89
HART Command Entry Formats • 41
Hart Command Examples • 45
HART Command List • 90
HART Common Practice Commands • 38,
131
HART Common Practice Commands Set •
39
HART Master Menu • 67
HART Universal Commands • 38, 41, 118
HART Universal Commands Set • 39
How to Contact Us • 2
I
Important Installation Instructions • 3
Initializing Output Data • 35
Installing ProSoft Configuration Builder
Software • 16
Installing the Module in the Rack • 18
Int Word Count • 43
Int. DB Address • 43
Intellectual Property Indemnity • 167
K
Keystrokes • 65
L
Ladder Logic • 51
LED Status Indicators • 76
Limitation of Remedies ** • 168
LIMITED WARRANTY • 163, 165
M
Main Logic Loop • 83
Main Menu • 65
Markings • 4
Master Command Error List Menu • 75
Master Command List Menu • 75
Master Driver • 90
Max Device Count • 37
Module Name • 34
Module Power Up • 83
Module Status Data and Variables
(HARTModuleDef) • 52
ProSoft Technology, Inc.
October 13, 2011
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Moving Back Through 5 Pages of
Commands • 75
Moving Forward (Skipping) Through 5 Pages
of Commands • 75
Multi-drop Mode • 95
MVI (Multi Vendor Interface) Modules • 3
MVI56-HART Configuration File • 34
MVI56-HART Status Data and Error Codes •
111
N
Navigation • 64
No Other Warranties • 168
Normal Data Transfer • 85
Notes • 104
O
Opening the Command Error List Menu • 68
Opening the Command List Menu • 68
Opening the Data Analyzer Menu • 68
Opening the Database View Menu • 66
Opening the HART Master Menu • 66
P
Package Contents • 15
Pinouts • 3, 101, 104
Point-to-Point Mode • 94
Poll Interval • 42
Preambles • 35
Primary Master • 35
Printing a Configuration File • 33
Product Specifications • 11, 80
ProSoft Technology® Product
Documentation • 2
Protocol Error Codes • 116
R
Read Block • 85
Read Register Start • 34
Reading Status Data from the Module • 62
Redisplaying the Current Page • 75
Redisplaying the Menu • 67
Reference • 11, 41, 79
Removing Timing Marks in the Data
Analyzer • 71
Renaming PCB Objects • 32
Retry Count • 36
Return Material Authorization (RMA) Policies
and Conditions • 163
Returning Any Product • 163
Returning to the Main Menu • 69, 72, 75
Returning Units Out of Warranty • 164
Returning Units Under Warranty • 164
RS-232 Configuration/Debug Port • 100
S
Selecting the Slot Number for the Module •
23
Setting Jumpers • 17
ProSoft Technology, Inc.
October 13, 2011
Index
User Manual
Setting Up the Project • 30
Short Address • 42
Slave List Status • 36
Start Here • 11, 13
Starting the Data Analyzer • 72
Status Object (HARTStat) • 53
Stopping the Data Analyzer • 72
Support, Service & Warranty • 11, 161
Swap Code • 42, 43, 44
System Requirements • 14
T
Time Limit for Bringing Suit • 168
Transferring the Configuration File from The
Module to the PC • 67
Transferring the Configuration File from the
PC to the Module • 66
Troubleshooting • 77
U
Use Long • 43
Using ProSoft Configuration Builder • 30
Using ProSoft Configuration Builder (PCB)
for Diagnostics • 62
Using the Diagnostic Window in ProSoft
Configuration Builder • 62
Using the Sample Ladder Logic • 21
Using the Sample Program • 52
V
Viewing Block Transfer Statistics • 66
Viewing Data in ASCII (Text) Format • 71
Viewing Data in Hexadecimal Format • 71
Viewing Module Configuration • 66
Viewing Port Status and Configuration • 69
Viewing the Master Command List Help • 68
Viewing the Next 50 Commands • 75
Viewing the Next Page of Commands • 75
Viewing the Previous 50 Commands • 75
Viewing the Previous Page of Commands •
75
Viewing the Slave Status List • 68
Viewing Version Information • 67
W
Warm Booting the Module • 67
Warnings • 3
What Is Covered By This Warranty • 165,
167
What Is Not Covered By This Warranty • 166
Write Block • 86
Write DB Address • 44
Write Register Count • 34
Write Register Start • 34
Y
Your Feedback Please • 2
Page 171 of 171
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising