Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
In This Chapter
Reading Status Data from the Module .................................................. 51
LED Status Indicators............................................................................66
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.
4.1 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
Control over the module (warm boot and cold boot)
Facility to upload and download the module’s configuration file
You can connect directly from your computer’s serial port to the serial port on the module to view configuration information, perform maintenance, and send
(upload) or receive (download) configuration files.
ProSoft Technology recommends the following minimum hardware to connect your computer to the module:
80486 based processor (Pentium preferred)
1 megabyte of memory
At least one UART hardware-based serial communications port available.
USB-based virtual UART systems (USB to serial port adapters) often do not function reliably, especially during binary file transfers, such as when uploading/downloading configuration files or module firmware upgrades.
A null modem serial cable.
ProSoft Technology, Inc.
June 5, 2009
Page 51 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
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 [E
NTER
].
When you type a command letter, a new screen will be displayed in your terminal application.
Using the Diagnostic Window in ProSoft Configuration Builder
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.
2 On the shortcut menu, choose D
IAGNOSTICS
.
Page 52 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
3 This action opens the D
IAGNOSTICS
dialog box. Press [?] to open the Main
Menu.
Important: The illustrations of configuration/debug menus in this section are intended as a general guide, and may not exactly match the configuration/debug menus in your own module.
If there is no response from the module, follow these steps:
1 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.
2 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.
Navigation
All of the sub-menus for this module contain commands to redisplay the menu or return to the previous menu. You can always return from a sub-menu to the next higher menu by pressing [M] on your keyboard.
ProSoft Technology, Inc.
June 5, 2009
Page 53 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
The organization of the menu structure is represented in simplified form in the following illustration:
User Manual
The remainder of this section shows you the menus available for this module, and briefly discusses the commands available to you.
Keystrokes
The keyboard commands on these menus are almost always non-case sensitive.
You can enter most commands in lower case or capital 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 [S
HIFT
],
[C
TRL
] or [A
LT
]
keys to enter them correctly. For example, on US English keyboards, enter the [?] command as [S
HIFT
][/].
Also, take care to distinguish capital letter [I] from lower case letter [
L
]
(L) and number [1]; likewise for capital letter [O] and number [0]. Although these characters look nearly the same on the screen, they perform different actions on the module.
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 on your terminal screen:
Page 54 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
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 failures. Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff.
Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command.
Viewing Block Transfer Statistics
Press [B] from the Main Menu to view the Block Transfer Statistics screen.
Use this command to display the configuration and statistics of the backplane data transfer operations between the module and the processor. The information on this screen can help determine if there are communication problems between the processor and the module.
Tip: To determine the number of blocks transferred each second, mark the numbers displayed at a specific time. Then some seconds later activate the command again. Subtract the previous numbers from the current numbers and divide by the quantity of seconds passed between the two readings.
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 Menu
Press [D] to open the Database View menu. Use this menu command to view the current contents of the module’s database.
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 PC to MVI56 module
Press [S] to send (download) the configuration file from your PC to the module and store the file on the module’s Compact Flash Disk.
ProSoft Technology, Inc.
June 5, 2009
Page 55 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
Press [Y] to confirm the file transfer, and then follow the instructions on the terminal screen to complete the file transfer process.
User Manual
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.
Transferring the Configuration File from MVI56 module to PC
Press [R] to receive (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 downloaded, 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
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 failures. Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff.
Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command.
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 re-boot.
Page 56 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
Exiting the Program
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
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 failures. Only use these commands if you are specifically directed to do so by ProSoft Technology Technical Support staff.
Some of these command keys are not listed on the menu, but are active nevertheless. Please be careful when pressing keys so that you do not accidentally execute an unwanted command.
Press [E
SC
]
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.4 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.
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 59) 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.
ProSoft Technology, Inc.
June 5, 2009
Page 57 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Opening the Command Error List Menu
Diagnostics and Troubleshooting
User Manual
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.
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
Gap Errors
Overflow
SOM Errors
Retry Count
Check Byte
Description
Increments when a delay of more than 20 milliseconds occurs between characters in a HART message
Increments when a received HART message is longer than the internal buffer can hold
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
Increments every time a HART command fails and is retried
Increments when a Checksum error is detected in the received HART packet.
Page 58 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
Error Type Description
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Response Timeout
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.
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.
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.
ProSoft Technology, Inc.
June 5, 2009
Page 59 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Analyzing Data for Port 1
Diagnostics and Troubleshooting
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.
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.
[6]
[7]
[8]
[9]
Key Interval
[5] 1 milliseconds ticks
[0]
5 milliseconds ticks
10 milliseconds ticks
50 milliseconds ticks
100 milliseconds ticks
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] to display the data on the current page in hexadecimal format.
Viewing Data in ASCII (Text) Format
Press [A] to display the data on the current page in ASCII format. This is useful for regions of the database that contain ASCII data.
Page 60 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
Starting the Data Analyzer
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
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+>
<R->
<CS>
_TT_
These characters are inserted when the RTS line is driven high on the port.
These characters are inserted when the RTS line is dropped low on the port.
These characters are displayed when the CTS line is recognized high.
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.
ProSoft Technology, Inc.
June 5, 2009
Page 61 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
From the main menu, press [A] for the "Data Analyzer". You should see the following text appear on the screen:
User Manual
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 T
RANSFER
/ C
APTURE
T
EXT
as shown below:
Page 62 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
After selecting the above option, the following window will appear:
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.
ProSoft Technology, Inc.
June 5, 2009
Page 63 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
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.
4.1.7 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.
M = Main Menu
Protocol Menu
Command List Menu
? = Display Menu
S = Show Again
P = Previous Page
N = Next Page
M = Main Menu
Redisplays (refreshes) this menu
Redisplays last selected page of data
Goes back one page of data
Goes forward one page of data
Goes up one level to main menu
Redisplaying the Current Page
Press [S] to display the current page of data.
Viewing the Previous 20 Commands
Press [-] to display data for the previous 20 commands.
Viewing the Previous Page of Commands
Press [P] to display the previous page of commands.
Viewing the Next 20 Commands
Press [+] to display data for the next 20 commands.
Page 64 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
Viewing the Next Page of Commands
Press [N] to display the next page of commands.
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Returning to the Main Menu
Press [M] to return to the Main Menu.
4.1.8 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.
M = Main Menu
Protocol Menu
Command List Menu
? = Display Menu
S = Show Again
P = Previous Page
N = Next Page
M = Main Menu
Redisplays (refreshes) this menu
Redisplays last selected page of data
Goes back one page of data
Goes forward one page of data
Goes up one level to main 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.
June 5, 2009
Page 65 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
4.2 LED Status Indicators
The LEDs indicate the module’s operating status as follows:
Diagnostics and Troubleshooting
User Manual
Off NA
APP
Status
BP ACT
Amber
Amber
Green
Off NA
Data is being transferred between the module and a remote terminal using the Configuration/Debug port.
Off
Off
No data is being transferred on the Configuration/Debug port.
The MVI56-HART is working normally.
On
On
Off
The MVI56-HART module program has recognized a communication error.
The LED is on when the module is performing a write operation on the backplane.
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.
Green
Red
The card is not receiving any power and is not securely plugged into the rack.
The module is operating normally.
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.
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.
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 the configuration data being transferred to the module from the
ControlLogix processor.
Page 66 of 159 ProSoft Technology, Inc.
June 5, 2009
Diagnostics and Troubleshooting
User Manual
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
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 Support.
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.
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. Verify that all modules in the rack are configured in the ladder logic.
Module Errors
Problem Description Steps to take
BP ACT LED remains off or blinks slowly
This indicates that backplane transfer operations are failing. Connect to the module’s Configuration/Debug port to check this.
MVI56E modules with scrolling LED display:
<Backplane Status> condition reads ERR
OK LED remains red
To establish backplane communications, verify the following items:
The processor is in Run mode.
The backplane driver is loaded in the module.
The module is configured for read and write block data transfer.
The ladder logic handles all read and write block situations.
The module is configured in the processor.
The program has halted or a critical error has occurred. Connect to the
Configuration/Debug port to see if the module is running. If the program has halted, turn off power to the rack, remove the card from the rack and re-insert the card in the rack, and then restore power to the rack.
ProSoft Technology, Inc.
June 5, 2009
Page 67 of 159
MVI56-HART ♦ ControlLogix Platform
HART Multi-drop Master Communication Module
Diagnostics and Troubleshooting
User Manual
Page 68 of 159 ProSoft Technology, Inc.
June 5, 2009
