Page 1
MVI69-101M
CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication
Module
User Manual
February 04, 2008
Page 2
Please Read This Notice
Successful application of this module requires a reasonable working knowledge of the Rockwell
Automation CompactLogix or MicroLogix hardware, the MVI69-101M Module and the application in
which the combination is to be used. For this reason, it is important that those responsible for
implementation satisfy themselves that the combination will meet the needs of the application
without exposing personnel or equipment to unsafe or inappropriate working conditions.
This manual is provided to assist the user. Every attempt has been made to ensure that the
information provided is accurate and a true reflection of the product's installation requirements. In
order to ensure a complete understanding of the operation of the product, the user should read all
applicable Rockwell Automation documentation on the operation of the Rockwell Automation
hardware.
Under no conditions will ProSoft Technology be responsible or liable for indirect or consequential
damages resulting from the use or application of the product.
Reproduction of the contents of this manual, in whole or in part, without written permission from
ProSoft Technology is prohibited.
Information in this manual is subject to change without notice and does not represent a
commitment on the part of ProSoft Technology Improvements and/or changes in this manual or the
product may be made at any time. These changes will be made periodically to correct technical
inaccuracies or typographical errors.
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 the product, documentation or support,
please write or call us.
ProSoft Technology
1675 Chester Avenue, Fourth Floor
Bakersfield, CA 93301
+1 (661) 716-5100
+1 (661) 716-5101 (Fax)
http://www.prosoft-technology.com
Copyright © ProSoft Technology, Inc. 2000 - 2008. All Rights Reserved.
MVI69-101M User Manual
February 04, 2008
PSFT.101M.MVI69.UM.08.02.04
ProSoft Technology ®, ProLinx ®, inRAx ®, ProTalk® and RadioLinx ® are Registered Trademarks
of ProSoft Technology, Inc.
Page 3
Contents MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Contents
PLEASE READ THIS NOTICE................................................................................................................2
Your Feedback Please ...................................................................................................................... 2
GUIDE TO THE MVI69-101M USER MANUAL......................................................................................5
1 START HERE....................................................................................................................................7
1.1 System Requirements................................................................................................................. 7
1.2 Package Contents.......................................................................................................................8
1.3 Setting Jumpers ..........................................................................................................................9
1.4 Installing the Module ................................................................................................................. 10
1.5 Connect your PC to the Processor ........................................................................................... 13
1.6 Download the Sample Program to the Processor.....................................................................14
1.6.1 Configuring RSLinx.................................................................................................................... 15
1.7 Connect your PC to the Module................................................................................................ 17
2 MODULE CONFIGURATION WITH RSLOGIX..............................................................................19
2.1 Installing and Configuring the Module with a CompactLogix Processor................................... 19
2.2 Installing and Configuring the Module with a MicroLogix Processor ........................................24
2.3 Module Data..............................................................................................................................26
2.3.1 Module Status Data and Variables (MVI69101M_ModuleDef) ..................................................26
2.3.2 Data Object (MV69101M_DATA) ..............................................................................................29
2.4 Configuration File ......................................................................................................................29
2.4.1 [Backplane Configuration] ......................................................................................................... 31
2.4.2 [IEC-870-5-101 Master] ............................................................................................................. 32
2.4.3 [IEC-870-5-101 Master Port x]...................................................................................................32
2.4.4 [IEC-101 Master Session x]....................................................................................................... 34
2.4.5 [IEC-101 Master Session x Sector y]......................................................................................... 37
2.4.6 [IEC-101 Master Commands] .................................................................................................... 38
2.4.7 Qualifier Parameter ...................................................................................................................40
2.5 Uploading and Downloading the Configuration File.................................................................. 49
2.5.1 Required Hardware ...................................................................................................................49
2.5.2 Required Software..................................................................................................................... 49
2.5.3 Transferring the Configuration File to Your PC.......................................................................... 50
2.5.4 Transferring the Configuration File to the Module...................................................................... 52
3 LADDER LOGIC .............................................................................................................................57
4 DIAGNOSTICS AND TROUBLESHOOTING.................................................................................59
4.1 Reading Status Data From the Module..................................................................................... 59
4.1.1 The Configuration/Debug Menu................................................................................................. 59
4.1.2 Required Hardware ...................................................................................................................60
4.1.3 Required Software..................................................................................................................... 61
4.1.4 Using the Configuration/Debug Port .......................................................................................... 61
4.1.5 Main Menu................................................................................................................................. 62
4.1.6 Database View Menu ................................................................................................................64
4.1.7 IEC-101M Master Menu ............................................................................................................66
4.1.8 Data Analyzer............................................................................................................................ 67
4.1.9 Data Analyzer Tips .................................................................................................................... 69
4.1.10 Master Command List Menu...................................................................................................... 72
4.1.11 Session Configuration Menu ..................................................................................................... 73
4.1.12 Sector Configuration Menu........................................................................................................ 74
4.1.13 Sector Database Menu.............................................................................................................. 75
4.2 LED Status Indicators ...............................................................................................................76
4.2.1 Clearing a Fault Condition ......................................................................................................... 76
4.2.2 Troubleshooting......................................................................................................................... 77
ProSoft Technology, Inc. Page 3 of 133
February 4, 2008
Page 4
MVI69-101M ♦ CompactLogix or MicroLogix Platform Contents
IEC 60870-5-101 Master Communication Module
5 REFERENCE.................................................................................................................................. 79
5.1 Product Specifications .............................................................................................................. 79
5.1.1 Features and Benefits ............................................................................................................... 79
5.1.2 General Specifications .............................................................................................................. 79
5.1.3 Hardware Specifications............................................................................................................ 80
5.1.4 Functional Specifications........................................................................................................... 80
5.2 Functional Overview ................................................................................................................. 81
5.2.1 General Concepts ..................................................................................................................... 81
5.2.2 Data Type Mapping and Addressing ......................................................................................... 86
5.3 Master Driver ............................................................................................................................ 96
5.4 Cable Connections ................................................................................................................... 97
5.4.1 RS-232 Configuration/Debug Port............................................................................................. 98
5.4.2 RS-232 .................................................................................................................................... 100
5.4.3 RS-422 .................................................................................................................................... 102
5.4.4 RS-485 .................................................................................................................................... 102
5.4.5 DB9 to RJ45 Adaptor (Cable 14)............................................................................................. 103
5.5 MVI69-101M Status Data Area............................................................................................... 103
5.5.1 MVI69-IEC 60870-5-101 Master Communication Module Error/Status Data Format .............. 103
5.5.2 MVI69-IEC 60870-5-101 Master Communication Module Error Codes................................... 106
5.6 MVI69-101M Configuration Data Definition............................................................................ 107
5.6.1 MVI69 IEC 60870-5-101 Master Communication Module Configuration ................................. 107
5.7 Database Form ....................................................................................................................... 112
5.7.1 Form to Define Sector Database............................................................................................. 112
5.8 Command List Form ............................................................................................................... 113
5.8.1 Form to Define Command List................................................................................................. 113
5.9 Interoperability ........................................................................................................................ 114
6 SUPPORT, SERVICE & WARRANTY......................................................................................... 121
6.1 How to Contact Us: Sales and Support.................................................................................. 122
6.2 Return Material Authorization (RMA) Policies and Conditions............................................... 123
6.2.1 All Product Returns ................................................................................................................. 123
6.3 Procedures for Return of Units Under Warranty .................................................................... 123
6.4 Procedures for Return of Units Out of Warranty .................................................................... 124
6.4.1 Un-repairable Units ................................................................................................................. 124
6.4.2 Purchasing Warranty Extension .............................................................................................. 125
6.5 LIMITED WARRANTY............................................................................................................ 125
6.5.1 What Is Covered By This Warranty ......................................................................................... 125
6.5.2 What Is Not Covered By This Warranty................................................................................... 126
6.5.3 DISCLAIMER REGARDING HIGH RISK ACTIVITIES ............................................................ 127
6.5.4 DISCLAIMER OF ALL OTHER WARRANTIES....................................................................... 127
6.5.5 LIMITATION OF REMEDIES**................................................................................................ 127
6.5.6 Time Limit for Bringing Suit ..................................................................................................... 127
6.5.7 No Other Warranties ............................................................................................................... 128
6.5.8 Intellectual Property................................................................................................................. 128
6.5.9 Additional Restrictions Relating To Software And Other Intellectual Property......................... 128
6.5.10 Allocation of risks .................................................................................................................... 128
6.5.11 Controlling Law and Severability ............................................................................................. 129
INDEX.................................................................................................................................................. 131
Page 4 of 133
February 4, 2008
Page 5
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Guide to the MVI69-101M User Manual
Function Section to Read Details
Introduction
(Must Do)
Verify Communication,
Diagnostic and
Troubleshooting
Reference
Product Specifications
Functional Overview
Glossary
Support, Service, and
Warranty
Index
→
→
→
→
Start Here (page 7)
Verifying
Communication
(page 59)
Diagnostics and
Troubleshooting
(page 59)
Reference
79)
Functional
Overview (page 81)
Product
Specifications
(page 79)
Support, Service
and Warranty
(page 121)
(page
This Section introduces the customer to the
module. Included are: package contents,
system requirements, hardware installation,
and basic configuration.
This section describes how to verify
communications with the network. Diagnostic
and Troubleshooting procedures.
These sections contain general references
associated with this product, Specifications,
and the Functional Overview.
This section contains Support, Service and
Warranty information.
Index of chapters.
ProSoft Technology, Inc. Page 5 of 133
February 4, 2008
Page 6
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
Page 6 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 7
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform IEC 60870-5-101 Master Communication Module
1 Start Here
In This Chapter
System Requirements .............................................................................7
Package Contents ...................................................................................8
Setting Jumpers ......................................................................................9
Installing the Module .............................................................................10
Connect your PC to the Processor ........................................................13
Download the Sample Program to the Processor..................................14
Connect your PC to the Module ............................................................17
Installing the MVI69-101M module requires a reasonable working knowledge of
the Rockwell Automation hardware, the MVI69-101M Module and the application
in which they will be used.
Caution: It is important that those responsible for implementati on can complete the
application without exposing personnel, or equipment, to unsafe or inappropriate working
conditions. Safety, quality and experience ar e key factors in a successful installation.
1.1 System Requirements
The MVI69-101M module requires the following minimum hardware and software
components:
Rockwell Automation CompactLogix or MicroLogix processor, with
compatible power supply and one free slot in the rack, for the MVI69-101M
module. The module requires 800mA of available power.
Rockwell Automation RSLogix 5000 (CompactLogix) or RSLogix 500
(MicroLogix) programming software
Rockwell Automation RSLinx communication software
Pentium® II 450 MHz minimum. Pentium III 733 MHz (or better)
recommended
Supported operating systems:
o Microsoft Windows XP Professional with Service Pack 1 or 2
o Microsoft Windows 2000 Professional with Service Pack 1, 2, or 3
o Microsoft Windows Server 2003
128 Mbytes of RAM minimum, 256 Mbytes of RAM recommended
100 Mbytes of free hard disk space (or more based on application
requirements)
256-color VGA graphics adapter, 800 x 600 minimum resolution (True Color
1024 × 768 recommended)
ProSoft Technology, Inc. Page 7 of 133
February 4, 2008
Page 8
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
CD-ROM drive
HyperTerminal or other terminal emulator program capable of file transfers
using Zmodem protocol.
1.2 Package Contents
The following components are included with your MVI69-101M module, and are
all required for installation and configuration.
Important: Before beginning the installation, please verify that all of the following items ar e
present.
Qty. Part Name Part Number Part Description
1
1 Cable
3 Cable
2 Adapter 1454-9F
1
MVI69-101M
Module
ProSoft
Solutions
CD
MVI69-101M IEC 60870-5-101 Master Communication Module
Cable #15, RS232
Null Modem
Cable #14, RJ45 to
DB9 Male Adapter
cable
For RS232 Connection to the CFG Port
For DB9 Connection to Module's Port
Two Adapters, DB9 Female to Screw Terminal.
For RS422 or RS485 Connections to Port 1 and 2
of the Module
Contains sample programs, utilities and
documentation for the MVI69-101M module.
If any of these components are missing, please contact ProSoft Technology
Support for replacement parts.
Page 8 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 9
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
1.3 Setting Jumpers
When the module is manufactured, the port selection jumpers are set to RS-232.
To use RS-422 or RS-485, you must set the jumpers to the correct position. The
following diagram describes the jumper settings.
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.
ProSoft Technology, Inc. Page 9 of 133
February 4, 2008
Page 10
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
1.4 Installing the Module
This section describes how to install the module into a CompactLogix or
MicroLogix rack
Before you attempt to install the module, make sure that the bus lever of the
adjacent module is in the unlocked (fully right) position.
Warning: This module is not hot-swappable! Always remove power from the rack before
inserting or removing this module, or damage may result to the module, the processor, or other
connected devices.
1 Align the module using the upper and lower tongue-and-groove slots with the
adjacent module and slide forward in the direction of the arrow.
2 Move the module back along the tongue-and-groove slots until the bus
connectors on the MVI69 module and the adjacent module line up with each
other.
Page 10 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 11
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
3 Push the module's bus lever back slightly to clear the positioning tab and
move it firmly to the left until it clicks. Ensure that it is locked firmly in place.
4 Close all DIN rail latches.
ProSoft Technology, Inc. Page 11 of 133
February 4, 2008
Page 12
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
5 Press the DIN rail mounting area of the controller against the DIN rail. The
latches will momentarily open and lock into place.
Page 12 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 13
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
1.5 Connect your PC to the Processor
1 Connect the right-angle connector end of the cable to your controller at the
communications port.
2 Connect the straight connector end of the cable to the serial port on your
computer.
ProSoft Technology, Inc. Page 13 of 133
February 4, 2008
Page 14
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
1.6 Download the Sample Program to the Processor
To download the sample program from RSLogix 5000 to the CompactLogix processor:
Note: The key switch on the front of the CompactLogix processor must be in the REM position.
1 If you are not already online to the processor, open the Communications
menu, and then choose Download. RSLogix will establish communication
with the processor.
2 When communication is established, RSLogix will open a confirmation dialog
box. Click the Download button to transfer the sample program to the
processor.
3 RSLogix will compile the program and transfer it to the processor. This
process may take a few minutes.
4 When the download is complete, RSLogix will open another confirmation
dialog box. Click OK to switch the processor from Program mode to Run
mode.
Note: If you receive an error message during these steps, refer to your RSLogix documentation to
interpret and correct the error.
Page 14 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 15
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
1.6.1 Configuring RSLinx
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 driv er type to choose for serial communication with
the processor is "RS-232 DF1 Devices".
ProSoft Technology, Inc. Page 15 of 133
February 4, 2008
Page 16
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
3 Click to select the driver, and then click Configure. This action opens the
Configure Allen-Bradley DF1 Communications Device dialog box.
4 Click the Auto-Configure button. RSLinx will attempt to configure your serial
port to work with the selected driver.
5 When you see the message "Auto Configuration Successful", click the OK
button to dismiss the dialog box.
Note: If the auto-configuration procedure fails, verify that the cables are connected correctly
between the processor and the serial port on your computer, and then try again. If you are still
unable to auto-configure the port, refer to yo ur RSLinx documentation for further troubleshooting
steps.
Page 16 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 17
Start Here MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
1.7 Connect your PC to the Module
With the module securely mounted, connect your PC to the Configuration/Debug
port using an RJ45-DB-9 Serial Adapter Cable and a Null Modem Cable.
1 Attach both cables as shown.
2 Insert the RJ45 cable connector into the Configuration/Debug port of the
module.
3 Attach the other end to the serial port on your PC or laptop.
ProSoft Technology, Inc. Page 17 of 133
February 4, 2008
Page 18
MVI69-101M ♦ CompactLogix or MicroLogix Platform Start Here
IEC 60870-5-101 Master Communication Module
Page 18 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 19
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
2 Module Configuration with RSLogix
In This Chapter
Installing and Configuring the Module with a CompactLogix Processor 19
Installing and Configuring the Module with a MicroLogix Processor...... 24
Module Data .......................................................................................... 26
Configuration File ..................................................................................29
Uploading and Downloading the Configuration File...............................49
2.1 Installing and Configuring the Module with a CompactLogix
Processor
If you are installing and configuring the module with a CompactLogix processor,
follow these steps. If you are using a MicroLogix processor, refer to the next
section.
This chapter describes how to install and configure the module to work with your
application. The configuration process consists of the following steps.
1 Use RSLogix to identify the module to the processor and add the module to a
project.
Note: The RSLogix software must be in "offline" mode to ad d the module to a project.
2 Modify the module's configuration files to meet the needs of your application,
and copy the updated configuration to the module. Example configuration
files are provided on the CD-ROM. Refer to the Modifying the Example
Configuration File section, later in this chapter, for more information on the
configuration files.
3 Modify the example ladder logic to meet the needs of your application, and
copy the ladder logic to the processor. Example ladder logic files are provided
on the CD-ROM.
Note: If you are installing this module in an existin g application, you can copy the necessary
elements from the example ladder logic into your application.
The rest of this chapter describes these steps in more detail.
ProSoft Technology, Inc. Page 19 of 133
February 4, 2008
Page 20
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
The first step in setting up the processor ladder file is to define the I/O type
module to the system. Right-click the mouse button on the I/O Configuration
option in the Controller Organization window to display a pop-up menu. Select
the New Module… option from the I/O Configuration menu.
This action opens the Select Module Type dialog box.
Select the 1769-Module (Generic 1769 Module) from the list and click OK.
You should configure the Connection Parameters according to the Block Transfer
Size parameter in the configuration file as follows:
Page 20 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 21
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
On the General page, fill in the values shown in the tables below, according to
the Block Transfer Size parameter in the configuration file. You must select the
Comm Format as Data - INT.
The configured Input Size and Output Size will depend on the block transfer size
parameter defined in the configuration file. Use the values in the table
corresponding with the block transfer size you configured.
Block Transfer Size = 60
Field Recommended Value
Type 1769-MODULE Generic 1769 Module
Parent Local
Name MVI69
Description MVI69 Application Module
Comm Format Data - INT
Slot The slot number in the rack where the module is installed
Input Assembly Instance 101
Input Size 62
Output Assembly Instance 100
Output Size 61
Configuration Assembly Instance 102
Configuration Size 0
Block Transfer Size = 120
Field Recommended Value
Type 1769-MODULE Generic 1769 Module
Parent Local
Name MVI69
Description MVI69 Application Module
Comm Format Data - INT
Slot The slot number in the rack where the module is installed
Input Assembly Instance 101
Input Size 122
Output Assembly Instance 100
Output Size 121
Configuration Assembly Instance 102
Configuration Size 0
Block Transfer Size = 240
Field Recommended Value
Type 1769-MODULE Generic 1769 Module
Parent Local
Name MVI69
Description MVI69 Application Module
ProSoft Technology, Inc. Page 21 of 133
February 4, 2008
Page 22
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Field Recommended Value
Comm Format Data - INT
Slot The slot number in the rack where the module is installed
Input Assembly Instance 101
Input Size 242
Output Assembly Instance 100
Output Size 241
Configuration Assembly Instance 102
Configuration Size 0
Important: If you set the Assembly Instance and Size values incorrectly, the module will not
communicate over the backplane of the CompactLogix or MicroLogix rack.
Click Next to continue.
For Block Size 60 words
For Block Size 120 words
Page 22 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 23
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
For Block Size 240 words
Fill in the dialog boxes as shown, adjusting the Name, Description and Slot
options for your application. You must select the Comm Format as Data - INT in
the dialog box. Failure to set the Assembly Instance and Size values correctly
will result in a module that will not communicate over the backplane of the
CompactLogix rack. Click Next to open the next dialog box.
Select the Request Packet Interval value for scanning the I/O on the module.
This value represents the minimum frequency the module will handle scheduled
events. This value should not be set to less than 1 millisecond. Values between 1
and 10 milliseconds should work with most applications.
ProSoft Technology, Inc. Page 23 of 133
February 4, 2008
Page 24
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
2.2 Installing and Configuring the Module with a MicroLogix Processor
If you are installing and configuring the module with a MicroLogix processor,
follow these steps. If you are using a CompactLogix processor, refer to the
previous section.
This chapter describes how to install and configure the module to work with your
application. The configuration process consists of the following steps.
1 Use RSLogix to identify the module to the processor and add the module to a
project.
Note: The RSLogix software must be in "offline" mode to ad d the module to a project.
2 Modify the module's configuration files to meet the needs of your application,
and copy the updated configuration to the module. Example configuration
files are provided on the CD-ROM. Refer to the Modifying the Example
Configuration File section, later in this chapter, for more information on the
configuration files.
3 Modify the example ladder logic to meet the needs of your application, and
copy the ladder logic to the processor. Example ladder logic files are provided
on the CD-ROM.
Note: If you are installing this module in an existin g application, you can copy the necessary
elements from the example ladder logic into your application.
The rest of this chapter describes these steps in more detail.
The first step in setting up the processor ladder file is to define the I/O type
module to the system. Start RSLogix 500, and follow these steps:
1 In RSLogix, open your existing application, or start a new application,
depending on your requirements.
2 Double-click the I/O Configuration icon located in the Controller folder in the
project tree. This action opens the I/O Configuration dialog box.
Page 24 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 25
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
3 On the I/O Configuration dialog box, select "Other - Requires I/O Card Type
ID" at the bottom of the list in the right pane, and then double-click to open
the Module dialog box.
4 Enter the values shown in the following illustration to define the module
correctly for the MicroLogix processor, and then click OK to save your
configuration.
The input words and output words parameter will depend on the Block
Transfer Size parameter you specify in the configuration file. Use the values
from the following table:
Block Transfer Size Input Words Output Words
60 62 61
120 122 121
240 242 241
5 Click Next to continue.
6 After completing the module setup, the I/O configuration dialog box will
display the module's presence.
The last step is to add the ladder logic. If you are using the example ladder logic,
adjust the ladder to fit your application. Refer to the example Ladder Logic
section in this manual.
Download the new application to the controller and place the processor in run
mode. If you encounter errors, refer to Diagnostics and
Troubleshooting (page
59) for information on how to connect to the module's Config/Debug port to use
its troubleshooting features.
ProSoft Technology, Inc. Page 25 of 133
February 4, 2008
Page 26
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
2.3 Module Data
All data related to the MVI69-101M module is stored in a user defined data type.
An instance of the data type is required before the module can be used. This is
done by declaring a variable of the data type in the Controller Tags Edit Tags
dialog box.
2.3.1 Module Status Data and Variables (MVI69101M_ModuleDef)
All status and variable data related to the MVI69-101M is stored in a user defined
data type. An instance of the data type is required before the module can be
used. This is done by declaring a variable of the data type in the Controller Tags
Edit Tags dialog box. The structure of the object is displayed in the following
illustration:
Name Data Type Description
DATA MV69101M_DATA Stores data point values
CONTROL MVI69101M_CONTROL Optional block handling
STATUS MVI69101M_STATUS Stores module status
UTIL MVI69101M_UTIL
This object contains objects that define variables to be used with the module and
status data related to the module. Each of these object types is discussed in the
following topics of the document.
Stores convenience variables for ladder
logic usage
Status Object (MVI69101M_STATUS)
This object stores the status data of the module. The MVI69101M_STATUS
object shown below 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
ProgramScanCounter INT Program cycle counter for module
ProductCode INT[2] Product code for module
ProductVersion INT[2] Revision level of module's code
OperatingSystem INT[2] Operating system version of module
RunNumber INT[2] Run number for module
Backplane_Read_Count INT Backplane read count
Backplane_Write_Count INT Backplane write count
Backplane_Parse_Count INT Backplane parse count
Backplane_Error_Count INT Backplane error count
EventCount INT
Event_Overflow INT
Session_Count INT
Current_Command INT
Events waiting to be sent to
processor
0 = no event buffer overflow. 1 =
event buffer overflow occurs
Number of sessions configured in
the module
Index of current command being
executed in the command list
Page 26 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 27
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Name Data Type Description
Command_Busy INT
Command_Count INT Number of configured commands
Command_Delay INT Command delay counter preset
Reserved1 INT Not used
Reserved2 INT Not used
Online DINT
Channel_Status
MVI69101M_ChannelStatus[
2]
0 = no commands currently being
executed and waiting for a response.
1 = command being executed and
wating for response
Each bit in this 32-bit register
indicates if the session is online. Bit
0 = On means session 0 is online
Channel specific status
Within the 101MStat objects are objects containing the status information for
each application port (101MCHStat). Refer to the Reference chapter for a
complete listing of the data stored in this object.
Channel Status Object (MVI69101M_ChannelStatus)
The MVI69101M_ChannelStatus object holds the status data related to a single
IEC 60870-5-101 master port. The structure of this object is shown in the
following example:
Name Data Type Description
State INT State machine value for channel 0
Command_Request INT Number of commands transferred out
Command_Response INT Number of command response received
Command_Error INT Number of error recognized at the channel
Requests INT Messages sent from the channel
Responses INT Messages received from the channel
Error_Sent INT Error messages sent
Error_Received INT Error messages received
Configuration_Error INT
Current_Error INT
Last_Error INT
Bit mapped word used to recognize configuration
error for channel 0. Refer to documentation for bit
structure
Error code for current command being executed.
Refer to the documentation for error code definition
Last error code recoginized on channel 0. Refer to
the documentation for error code definition
This information is passed to the controller from the module with each normal
read block image.
ProSoft Technology, Inc. Page 27 of 133
February 4, 2008
Page 28
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Configuration/Error Status Flags (CfgErr)
The Configuration_Error word member of the MVI69101M_ChannelStatus
reports configuration errors for the respective server. If the module is not
functioning as expected, inspect the value presented in this object. If a
configuration error exists, the associated bit will be 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 Invalid baud rate selected
1 0x0002 Invalid parity selected
2 0x0004 Received timeout set to 0
3 0x0008 Invalid Port selected for a session
4 0x0010 Invalid sector count for session
5 0x0020 Could not allocate memory for sector of a session.
6 0x0040
7 0x0080 Invalid failure delay or confirm timeout for session.
8 0x0100
9 0x0200
10 0x0400
11 0x0800
12 0x1000
13 0x2000
14 0x4000
15 0x8000
Invalid length data for session: Data link length Command
address of ASDU length Information object address length COT
octet count
Backplane Object (MVI69101M_UTIL)
The MVI69101M_UTIL 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 structure of this object is shown in the following illustration:
Name Data Type Description
Warmboot BOOL Requests warmboot of the module
ColdBoot BOOL Requests coldboot of the module
BPLastRead INT Index of last read
BPLastWrite INT Index of last write
BlockIndex INT Computed block offset for data table
BootTimer TIMER Used to clear output block ID after power up
LoopIndex INT Used as index during Loops
BlockTransferSize INT
Must match the configuration parameter Block Transfer (60,
120, 240). This value must be set in ladder by the user
The other members of the object are be utilized in the ladder logic to assist in the
data transfer operation.
Page 28 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 29
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
2.3.2 Data Object (MV69101M_DATA)
The MV69101M_DATA object is defined in the example ladder logic to
demonstrate how the data from a module can be stored in the processor. This
object stores data to be sent from the processor to the module (WriteData) and
data to be sent from the module to the processor (ReadData). A structure of this
type can be constructed for each session or sector or can be set as in the
example as one large database. The user should decide the best data storage
method for their application. Another factor in determining the database layout is
the simplicity of the ladder logic. In the example ladder logic, only one data copy
operation is required for each data type as the data is packed in the module. If
separate data areas are defined for each session, more copy instructions would
be required. This could simplify data management. The structure of the object
used in the example logic is shown in the following example:
Name Data Type Description
ReadData INT[480]
WriteData INT[480]
Read buffer where data is initially copied from the 101M
(command) data types and then copied from the buffer to
the module
Write buffer where (monitored) data is initially copied from
the module and then parsed to one of the 101M data types
2.4 Configuration File
In order for the module to operate, a configuration file (IEC101M.CFG) is
required. This configuration file contains all the information required to configure
the module's master drivers, set up the databases for the controlled devices and
established a command list. Each parameter in the file must be set carefully in
order for the application to be implemented successfully. The Reference chapter
contains an example listing of a IEC101M.CFG file.
The configuration file is separated into sections, with topic header names
enclosed in the [ ] characters. The configuration file consists of the following
sections:
[Section] Description
[Backplane Configuration] Backplane transfer parameter section
[IEC-870-5-101 Master] General Configuration for driver
[IEC-870-5-101 Master Port 0] Configuration for first application port
[IEC-870-5-101 Master Port 1] Configuration for second application port
[IEC-101 Master Session x] Definition for each control unit
[IEC-101 Master Session x Sector y] Definition for each sector in each controlled unit
[IEC-101 Master Commands] Command list to control slave units
After each section header, the file contains a set of parameters. Unique labels
are used under each section to specify a parameter. Each label in the file must
be entered exactly as shown in the file for the parameter to be identified by the
program. If the module is not considering a parameter, look at the label for the
data item. Each parameter's value is separated from the label with the ':'
character. This character is used by the program to delimit the position in the
data record where to start reading data. All data for a parameter must be placed
ProSoft Technology, Inc. Page 29 of 133
February 4, 2008
Page 30
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
after the ':' character. For numeric parameter values any text located after the
value will not be used. There must be at least one space character between the
end of the parameter value and the following text. An example of a parameter
entry is given below:
Baud Rate: 38400 #Baud rate for master port
The parameter label is "Baud Rate" and the parameter value is 38400. The
characters after the parameter value are ignored and are used for internal
documentation of the configuration file.
Any record that begins with the '#' character is considered to be a comment
record. These records can be placed anywhere in the file as long as the '#'
character is found in the first column of the line. These lines are ignored in the file
and can be used to provide documentation within the configuration file. Liberal
use of comments within the file can ease the use and interpretation of the data in
the file.
Use any text editor to alter the supplied IEC101M.CFG file for the specific
application. You must enter each parameter correctly for successful application
of the module. The Reference chapter contains a complete listing of all
parameters utilized by the module with a definition of each parameter.
The session sections of the configuration file are determined by the number of
sessions set in the configuration file. The sessions are referenced by a zero
based index value. For example, if the module is configured for four sessions, the
configuration file should contain sections for sessions 0 to 3 (that is, [IEC-101
Master Session 0] to [IEC-101 Master Session 3]. Each of these sections will
define the characteristics of the specific controlled device to be interfaced. Within
each session definition, is a parameter that specifies the number of sectors for
the session. For each sector defined for a session, there must exist a [IEC-101
Master Session x Sector y] section. Where the x value represents the session
index and the y value represents sector index. For example if session 0 contains
1 sector, there must be a section with the following name in the configuration file:
[IEC-101 Master Session 0 Sector 0]. The specific sector parameter set and
database is defined in this section.
The last section of the configuration file is the command list definition ([IEC-101
Master Commands]). This section can contain up to 1000 user defined
commands to be executed by the module and sent to the controlled devices.
There is no need to place Class 1 or Class 2 polls in the this list for the controlled
devices as the master driver for each port will execute these automatically when
the port is idle. In order for the port to be idle, make sure that there is idle time
available and that the commands do not constantly utilize the ports. The
command list section starts with a reserved label START and ends with the label
END. Each row in the file corresponds to an individual command with the first
character position in each row left blank (white space).
Page 30 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 31
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
2.4.1 [Backplane Configuration]
This section contains the backplane configuration information. It is used to
determine the number of registers moved between the module and the PLC
processor. Additionally, the backplane failure condition is defined as to whether
to continue using the protocol.
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
Range 0 to 3999
This parameter specifies the starting register in the module where the data
transferred from the processor will be placed. Valid range for this parameter is 0
to 3999.
Read 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.
Write Register Start
Range 0 to 3999
This parameter specifies the starting register in the module where data will be
transferred from the module to the processor. Valid range for this parameter is 0
to 3999.
Write Register Count
Range 0 to 4000
This parameter specifies the number of registers to be transferred from the
module to the processor. Valid entry for this parameter is 0 to 4000.
Failure Flag Count
0 through 65535
This parameter specifies the number of successive transfer errors that must
occur before the communication ports are shut down. If the parameter is set to 0,
the communication ports 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.
ProSoft Technology, Inc. Page 31 of 133
February 4, 2008
Page 32
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Pass-Through Events
Y or N (N = Default)
This parameter specifies if event messages received on the master ports will be
passed to the processor. If the parameter is set to N, event messages will not be
passed to the processor. If the parameter is set to Y, the module will pass all
events received to the processor using block identifier 9903.
Block Transfer Size
60, 120 or 240
This read-only parameter specifies the number of words in each block transferred
between the module and processor. Valid values for this parameter are 60, 120
and 240.
2.4.2 [IEC-870-5-101 Master]
This is the configuration for the IEC-870-5-101 master port emulated on the
module.
Session Count
1 to 32
This parameter specifies the maximum number of session to establish on the
module. This corresponds to the number of slaves to be interfaced with the
module. This value represents the total number of slaves on both ports
combined.
2.4.3 [IEC-870-5-101 Master Port x]
Baud Rate
This parameter specifies the baud rate to be used on the communication channel
(port). Values from 110 to 38.4K are permitted.
Parity
None, Odd, Even
This parameter specifies the parity for this port using the following code
definitions: N=none, O=odd, E=even.
RTS On
0 to 65535
The parameter sets the RTS pre-send delay. The value entered represents the
number of milliseconds the module will wait after setting the RTS modem line
before sending the data.
Page 32 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 33
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
RTS Off
1 to 65535
This parameter sets the RTS off delay. The value entered represents the number
of milliseconds the module will wait after the data packet is sent before dropping
the RTS modem line.
Minimum D elay
1 to 65535
This parameter specifies the minimum number of milliseconds to delay before
sending the message (setting RTS high). This can be used when the serial
network requires time for units to turn off their transmitters.
Receive Timeout
1 to 65535
This value represents the number of milliseconds to wait on a port from the time
the first character is received until the last character in the longest message
received on the port. This parameter should be set dependent on the baud rate.
A value of 2000 should work with most applications.
Single Char ACK F0, 1 or 3
Yes or No
If set to Y, a single character ACK (0xE5) will be sent instead of a fixed length
ACK (secondary function code 0) in response to a primary link function code 0, 1
or 3 if there is no access demand for class 1 data (ACD=1). If set to N, the fixed
length ACK will be sent.
Use Balanced Mode
Yes or No
This parameter specifies if the port will use balanced mode. If balanced mode is
used, only one controlled station will be permitted on the port. If unbalanced
mode is used, multiple controlled stations can be used on a port. Select Yes to
use balanced mode and No to use unbalanced mode.
ProSoft Technology, Inc. Page 33 of 133
February 4, 2008
Page 34
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
2.4.4 [IEC-101 Master Session x]
This section is used to define session x which runs on Port x. The session
sections of the configuration file are determined by the number of sessions set in
the configuration file. The sessions are referenced by a zero based index value.
For example, if the module is configured for four sessions, the configuration file
should contain sections for sessions 0 to 3 (that is, [IEC-101 Master Session 0] to
[IEC-101 Master Session 3]. Each of these sections will define the characteristics
of the specific controlled device to be interfaced.
Communication Port
0 or 1
This parameter sets the port to which the controlled device is connected. On this
module, values of 0 and 1 are permitted.
Sector Count
1 to 5
This parameter sets the number of sectors contained in this controlled device.
The range of values is from 1 to 5. A sector section is required for each sector in
a session to define its database and settings.
DL Address Length
0, 1 or 2
This parameter sets the number of octets used to define the data link address for
the session. A value of 0 is only permitted when balanced mode is used.
Data Link Address
0 to 254 or 0 to 65534
This parameter uniquely defines the data link address for this unit on the
communication channel The ranges of values depends on the value set in the DL
Address Length parameter.
Common Address of ASDU Len
1 or 2
This parameter specifies the number of octets used for the common address of
ASDU. This parameter must be set the same for all devices on the network.
Inform. Object Address Len
1, 2 or 3
This parameter sets the number of octets used to specify the address for an
information object in each sector for this session.
Page 34 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 35
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
COT octet count
1 or 2
This parameter sets the number of octets used for the COT field in each
message. If a value of 2 is selected, the value entered for the Originator Address
For COT will accompany each message from the controlling unit.
Originator address for COT
0 to 255
This parameter sets the address to be passed with each message when the COT
Octet Count parameter is set to 2.
Failure Delay
0 to 2000
This parameter sets the minimum number of seconds to delay before polling this
session when it is not online. This parameter is only used in unbalanced mode.
Confirm Timeout
0 to 2^32-1
This parameter sets the number of milliseconds to wait for a confirm response
from the controlled device.
Retry Count
0 to 255
This parameter sets the number of retries to be performed on the controlled
device when a communication occurs.
C1/C2 Poll Count Pend
0 to 65535
This parameter sets the maximum number of class 1 and class 2 polls performed
on this session before trying the next session. This parameter prevents a session
from monopolizing the communication port.
Class 1 Polls
0 to 65535
This parameter sets the maximum number of class 1 polls performed on this
session before switching to another session. This parameter prevents a session
from monopolizing the communication port.
Class 1 Pend Delay
0 to 2^32-1
This parameter sets the minimum number of milliseconds to delay between class
1 polls for pending data.
ProSoft Technology, Inc. Page 35 of 133
February 4, 2008
Page 36
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Class 2 Pend Delay
0 to 2^32-1
This parameter sets the minimum number of milliseconds to delay between class
2 polls for pending data.
Class 1 Poll Delay
0 to 2^32-1
This parameter sets the minimum number of milliseconds to delay between each
class 1 poll.
Class 2 Poll Delay
0 to 2^32-1
This parameter sets the minimum number of milliseconds to delay between each
class 2 poll.
Auto Clock Req Mode
0=Sync Only, 1=Load delay/sync, 2=Acquire delay/load delay/sync
This parameter specifies the method used to perform automatic clock
synchronization. 0 performs a synchronization without delay, 1 performs
synchronization using the fixed Propagation Delay and 2 computes the delay and
use this value when synchronization takes place.
Propagation Delay
0 to 65535
This parameter sets the fixed propagation delay to be utilized if the Auto Clock
Req Mode parameter is set to a value of 1.
Response Timeout
0 to 2^32-1
This parameter sets the maximum number of milliseconds to wait for a
confirmation from the controlled station to a request from this module.
ACTTERM with setpoint
Yes or No
This parameter determines if an ACTTERM will be sent. If the parameter is set to
Yes, then setpoint commands will issue an ACTTERM when the command is
complete. If the parameter is set to No, ACTCON is the last response to a
setpoint command.
Page 36 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 37
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
2.4.5 [IEC-101 Master Session x Sector y]
This section sets the parameters for a specific sector of a session. Within each
session definition, is a parameter that specifies the number of sectors for the
session. For each sector defined for a session, there must exist a [IEC-101
Master Session x Sector y] section. Where the x value represents the session
index and the y value represents sector index. For example if session 0 contains
1 sector, there must be a section with the following name in the configuration file:
[IEC-101 Master Session 0 Sector 0]. The specific sector parameter set and
database is defined in this section.
Common ASDU Address
0 to 255 (1 oct) or 0 to 65535 (2 oct)
This parameter sets the common ASDU address to association with this sector of
the specified session. The range of address for this parameter are dependent on
the length value set in the session section.
Use Time tag commands
Yes or No
This parameter specifies if a time tag field is to be included with commands. This
is as specified in the IEC-870-5-104 specification and should only be utilized if
the controlled device supports these new data types. If the parameter is set to
Yes, a time tag will be added to all commands. If the parameter is set to No, the
normal IEC 60870-5-101 data type messages will be utilized.
Online Time Sync.
Yes or No
This parameter specifies if the sector in the controlled device will be sent a time
synchronization command when the unit is first recognized as being online. This
should only be used for devices that do not send an EOI message after
initializing.
Online General Int
Yes or No
This parameter specifies if the sector in the controlled device will be sent a
general interrogation command when the unit is first recognized as being online.
This should only be used for devices that do not send an EOI message after
initializing.
EOI Time Sync.
Yes or No
This parameter specifies if the sector in the controlled device will be sent a time
synchronization command after this module received an EOI message from the
controlled unit.
ProSoft Technology, Inc. Page 37 of 133
February 4, 2008
Page 38
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
EOI General Int
Yes or No
This parameter specifies if the sector in the controlled device will be sent a
general interrogation command after this module received an EOI message from
the controlled unit.
Database Definition
Database definition for this session/sector.
Data Types are as follows:
Monitored Data
1 = Single point
3 = Double point
5 = Step point
7 = Bitstring of 32-bits
9 = Measured normalized points
11 = Measured scaled points
13 = Measured short float points
15 = Integrated totals
110 = Measured normalized parameter (word-addressing/1 point = 1 data
word)
111 = Measured scaled parameter (word-addressing/1 point = 1 data word)
112 = Measured short float parameters (double-word-addressing/1 point = 2
data words)
240 = Integrated totals BCD format (3 word-addressing/1 point = 3 data
words)
2.4.6 [IEC-101 Master Commands]
This section contains the commands for the module. This section can contain up
to 1000 user defined commands to be executed by the module and sent to the
controlled devices. There is no need to place Class 1 or Class 2 polls in the this
list for the controlled devices as the master driver for each port will execute these
automatically when the port is idle. In order for the port to be idle, make sure that
there is idle time available and that the commands do not constantly utilize the
ports. The command list section starts with a reserved label START and ends
with the label END. Each row in the file corresponds to an individual command
with the first character position in each row left blank (white space).
Enable Code
0 = Disabled
1 = Enabled with Poll Interval (seconds) utilized
2 = Conditional (executed when point in database changes)
This field defines whether or not the command is to be executed and under what
conditions. If the parameter is set to 0, the command is disabled and will not be
executed in the normal polling sequence. The command can be executed under
the control of the PLC processor through the use of a Command Control block.
Setting the parameter to a value of 1 for the command causes the command to
be executed each scan of the command list if the Poll Interval Time is set to zero.
Page 38 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 39
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
If the Poll Interval time is set, the command will be executed, when the interval
timer expires. If the parameter is set to 2, the command will execute only if the
internal data associated with the command changes. This value is valid only for
write commands.
Database Index
Database Index is the location in the module's database to use as the source for
the data in the command. The data type
(page 39) field determines the meaning
of the index.
Poll Interval
This parameter specifies the minimum frequency at which the module should
execute the command. The value is entered in units of seconds. For example, to
execute a command every 10 seconds, enter a value of 10 in the field. A value of
0 for the parameter implies that the command should be executed every scan of
the list.
Session Index
Session Index represents the session index in the module to associate with the
command. This index is set when the session is read in from this file. The range
of values for this field is 0 to 31.
Sector Index
Sector Index represents the sector index for the specific session. The range of
values for this field is 0 to 4.
Data Type
Data type file represents the ASDU type as follows:
Type Description DB Index type
45 Single point command Bit address
46 Double point command Bit address
47 Regulating Step point command Byte address
48 Setpoint, normalized point command Word address
49 Setpoint, scaled point command Word address
50 Setpoint, short float point command Double-word address
51 Bitstring (32-bits) point command Double-word address
100 Group interrogation command NA
101 Counter interrogation command NA
102 Read command NA
103 Clock Synchronization NA
104 Test command (101 standard) NA
105 Reset process command NA
107 Test command (104 standard) NA
ProSoft Technology, Inc. Page 39 of 133
February 4, 2008
Page 40
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Type Description DB Index type
110 Parameter, normalized measured value Word address
111 Parameter, scaled measured value Word address
112 Parameter, short float value Double-word address
113 Parameter activation command NA
242 BCD integrated setpoint command 3 word address
255 Send a class 2 poll NA
Point Index
Point Index field specifies the address in the remote slave device of the point to
interact with.
2.4.7 Qualifier Parameter
The Qualifier Parameter field defined for a command is dependent on the data
type used in the command. In order to compute the qualifier for a command, add
all the values for the features to use with a command together to form a single
number. This number should be entered in the command record. Each data set is
discussed below:
Single Point, Double Point, and Regulating Setup
The format of the field for Single Point (45), Double Point (46), and Regulating
Step (47) commands is as follows:
Single Point, Double Point and Regulating Step Point Commands
Bit Single Double Step
0 Value Control Control
1 0 Value Value
2
3
4
Qualifier Code
5
6
7
8
9
Select/Execute Code
Deselect Code
Use Override Value
10
to
Not Utilized
15
The value field for the different data types can be derived from the module's
database or that set in the command. The User Override bit is utilized to select
the source of the data value. The values for each data type are defined below:
Page 40 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 41
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Single Point Value:
0=Off
1=On Double Point Value:
0=Not permitted
1=Off
2=On
3=Not Permitted
Regulating Point Value (Set by module using database value -1=next lower,
1=next higher unless override enabled):
0=Not permitted
1=Next step lower if database point is set to -1
2=Next step high if database point set to +1
3=Not Permitted The Qualifier Code area defines the operation to perform as
defined below:
Qualifier Code (Select one of the following):
0=No additional definition (slave dependent)
4=Short pulse duration
8=Long pulse duration
12=Persistent output
The Select/Execute area defines if the command should perform a direct execute
or select before execute command sequence. The values for this field are as
follows (Select one of the values for the following list):
0=Direct execution without select
128=Select executed followed by execute
256=Deselect command
The value field for the qualifier can be derived from the module's database or be
that defined in the qualifier. If the override flag is used, the module will issue the
command using the values contained in the qualifier defined for the command. If
the override flag is not set, the module will use the value in the database to send
to the controlled device. The values to use for the override flag are as follows:
0=Use value in database (value field should be set to zero for qualifier
parameter)
512=Use override value for state (preferred when using block 9902 with value
field set for command to execute)
ProSoft Technology, Inc. Page 41 of 133
February 4, 2008
Page 42
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Normalized, Scaled, and Short Float
The format of the field for Normalized (48), Scaled (49), and Short Float (50)
setpoint command is as follows:
Normalized, Scaled and Short Float Setpoint Commands
Bit
0
1
Description
Select/Execute Code
Deselect Code
2
to
15
The value read from database for point specified is used with this qualifier to
build a command.
The Qualifier Parameter uses one of the following codes:
0=Direct execution without select
1=Select executed followed by execute
2=Deselect command
Bitstring for 32 Bits
The format of the field for 32-Bitstring (51) setpoint command is as follows:
Not Utilized
Bitstring of 32 Bit Command
Bit
Description
0
to
15
Not Utilized
The value read from database for point specified is used with this qualifier to
build a command.
The Qualifier Parameter is not currently used to construct commands.
Page 42 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 43
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
The format of the field for Interrogation Command (100) is as follows:
Interrogation Command
Bit
Description
0
to
Interrogation Group
7
8
to
15
Not Utilized
No database value is associated with the construction of this command.
The Qualifier Parameter used with this command defines the interrogation group
to request. Only a single group can be requested in a single command. The
codes to use for this field are as follows:
0=Not used
1 to 19 = Reserved by standard
20=Station interrogation (global)
21=Interrogation group 1
22=Interrogation group 2
23=Interrogation group 3
24=Interrogation group 4
25=Interrogation group 5
26=Interrogation group 6
27=Interrogation group 7
28=Interrogation group 8
29=Interrogation group 9
30=Interrogation group 10
31=Interrogation group 11
32=Interrogation group 12
33=Interrogation group 13
34=Interrogation group 14
35=Interrogation group 15
36=Interrogation group 16
37 to 63 = Reserved by standard
64 to 255 = Reserved for special use (private range)
ProSoft Technology, Inc. Page 43 of 133
February 4, 2008
Page 44
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Counter Interrogation
The format of the field for Counter Interrogation Command (101) is as follows:
Counter Interrogation Command
Bit
Description
0
to
Counter Interrogation Group
5
6
to
Freeze/Reset Qualifier
7
8
to
15
Not Utilized
No database value is associated with the construction of this command.
The Qualifier Parameter used with this command defines the counter
interrogation group to request. Only a single group can be requested in a single
command. The qualifier also contains the freeze/reset operation to be utilized
with the command The codes to use for this field are as follows:
Counter Interrogation Group:
0=No counter requested
1=Request counter group 1
2=Request counter group 2
3=Request counter group 3
4=Request counter group 4
5=Request general counter group
6 to 31 = Reserved by standard
32 to 63 = Reserved for special use (private range)
Freeze/Reset Qualifier:
0=No freeze or reset
64=Counter freeze without reset
128=Counter freeze with reset
192=No freeze with counter reset
Page 44 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 45
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Read Command
The format of this field for the Read (102) command is as follows:
Read Command
Bit
Description
0
to
15
No database value is associated with the construction of this command and no
qualifier value is used in this release of the software.
Clock Synchronization
The format of this field for the Clock Synchronization (103) command is as
follows:
Not Utilized
Clock Synchronization Command
Bit
0
1
Description
Synchronization Mode
Qualifier
0
to
15
No database value is associated with the construction of this command.
Not Utilized
The Qualifier Parameter for this command has one of the following values:
0=Clock synchronization with out delay utilized
1=Synchronize clock with delay set
2=Measure delay, load delay then synchronize clock
Test Command
The format of this field for the test command (104 and 107) is as follows:
Test Command (both 101 and 104 versions)
Bit
Description
0
to
15
No database value is associated with the construction of this command and no
qualifier value is used in this release of the software.
ProSoft Technology, Inc. Page 45 of 133
February 4, 2008
Not Utilized
Page 46
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Reset Process
The format of this field for the Reset Process (105) command is as follows:
Reset Process Command
Bit
Description
0
to
Reset Qualifier
7
8
to
15
No database value is associated with the construction of this command.
The Qualifier Parameter has one of the following values as define in the protocol
specification:
0=Not used
1=General reset of process
2=Reset pending information with time tag of the event buffer
3 to 127 = Reserved by standard
128 to 255 = Reserved for special use (private range)
Parameter Setting
The format of this field for the Parameter Setting (110=Normalized,
111=Scaled, 112=Short float) is as follows:
Not Utilized
Parameter Setting (Normalized, Scaled, Short Float) Command
Bit
Description
0
to
Kind of Parameter
5
6
7
Local change
Operation
8
to
15
The value from module's database utilized to build the command.
The Qualifier Parameter used with this command is determined by summing the
options from lists that follow:
Kind of parameter:
0=Not used
1=Threshold value
2=Smoothing factor (filter time constant)
3=Low limit for transmission of measured values
3=High limit for transmission of measured values
Page 46 of 133 ProSoft Technology, Inc.
Not Utilized
February 4, 2008
Page 47
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
5 to 31 = Reserved by standard
32 to 63 = Reserved for special use (private range)
Local parameter change:
0=No change
64=Change Parameter in operation:
0=Operation
128=Not in operation
Parameter Activation
The format of this field for the Parameter Activation (113) is as follows:
Parameter Activation Command
Bit
Description
0
to
Parameter Qualifier
7
8
Activation Qualifier
9
to
15
Not Utilized
No database value used with the construction of this command.
The Qualifier Parameter used with the command is determined by summing the
options from the lists that follow:
Parameter Qualifier:
0=Not used
1=Act/Deact of previously loaded parameters (point index = 0)
2=Act/Deact of the parameter of the point index specified
3=Act/Deact of persistent cyclic or periodic transmission of the addressed
object
4 to 127 = Reserved by standard
128 to 255 = Reserved for special use (private range)
Activation Qualifier:
0=Deactivate
256=Activate
ProSoft Technology, Inc. Page 47 of 133
February 4, 2008
Page 48
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
BCD Integrated Setpoint
The format of this field for BCD Integrated Setpoint (242) command is as
follows:
The value in database is utilized for this command . The data resides in a 6-byte
data area in the module.
The Qualifier Parameter used with this command is selected from the following
list:
0=Direct execution without select
1=Select executed followed by execute
2=Deselect command The format of this field for the Class 2 poll (255) command
is as follows:
Class 2 Poll
Bit
Description
0
to
15
No database or qualifier is used with this command.
Not Utilized
Page 48 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 49
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
2.5 Uploading and Downloading the Configuration File
ProSoft modules are shipped with a pre-loaded configuration file. In order to edit
this file, you must transfer the file from the module to your PC. After editing, you
must transfer the file back to the module.
This section describes these procedures.
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. For specific
information about the configuration/debug menus in your module, refer to The Configuration/Debug
Menu (page 59).
2.5.1 Required Hardware
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.
2.5.2 Required Software
In order to send and receive data over the serial port (COM port) on your
computer to the module, you must use a communication program (terminal
emulator).
A simple communication program called HyperTerminal is pre-installed with
recent versions of Microsoft Windows operating systems. If you are connecting
from a machine running DOS, you must obtain and install a compatible
communication program. The following table lists communication programs that
have been tested by ProSoft Technology.
DOS ProComm, as well as several other terminal emulation programs
Windows 3.1 Terminal
Windows 95/98 HyperTerminal
Windows NT/2000/XP HyperTerminal
The module uses the Zmodem file transfer protocol to send (upload) and receive
(download) configuration files from your module. If you use a communication
program that is not on the list above, please be sure that it supports Zmodem file
transfers.
ProSoft Technology, Inc. Page 49 of 133
February 4, 2008
Page 50
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
2.5.3 Transferring the Configuration File to Your PC
1 Connect your PC to the Configuration/Debug port of the module using a
terminal program such as HyperTerminal. Press [?] to display the main
menu.
2 From the Transfer menu in HyperTerminal, select Receive File.
3 In the Receive File dialog box, browse to the location on your PC where the
configuration file should be stored, and select Zmodem (or Zmodem with
Crash Recovery) as the receiving protocol.
When you have completed your selections, click Close.
Page 50 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 51
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
4 Press [S] (Send Module Configuration), and then press [Y] to confirm the
transfer.
The file transfer will then begin automatically, using the protocol and location
you specified in Step 3.
When the configuration file has been transferred to your PC, the dialog box
will indicate that the transfer is complete.
The configuration file is now on your PC at the location you specified.
5 You can now open and edit the file in a text editor such as Notepad. When
you have finished editing the file, save it and close Notepad.
ProSoft Technology, Inc. Page 51 of 133
February 4, 2008
Page 52
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
2.5.4 Transferring the Configuration File to the Module
Perform the following steps to transfer a configuration file from your PC to the
module.
1 Connect your PC to the Configuration/Debug port of the module using a
terminal program such as HyperTerminal. Press [?] to display the main
menu.
2 Press [R] (Receive Module Configuration). The message "Press Y key to
confirm configuration receive!" is displayed at the bottom of the screen.
Page 52 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 53
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
3 Press [Y]. The screen now indicates that the PC is ready to send.
4 From the Transfer menu in HyperTerminal, select Send File.
The Send File dialog appears.
ProSoft Technology, Inc. Page 53 of 133
February 4, 2008
Page 54
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
5 Use the Browse button to locate the configuration file your computer.
Note: This procedure assumes that you are uploading a newly edited configuration file from your
PC to the module. However, configuration files ar e also available on the ProSoft CD as well as the
ProSoft Technology web site.
6 Select Zmodem as the protocol.
7 Click the Send button. This action opens the Zmodem File Send dialog box.
Page 54 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 55
Module Configuration with RSLogix MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
When the upload is complete, the screen indicates that the module has
reloaded program values and displays information about the module.
8 Your module now contains the new configuration.
ProSoft Technology, Inc. Page 55 of 133
February 4, 2008
Page 56
MVI69-101M ♦ CompactLogix or MicroLogix Platform Module Configuration with RSLogix
IEC 60870-5-101 Master Communication Module
Page 56 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 57
Ladder Logic MVI69-101M ♦ CompactLogix or MicroLogix Platform IEC 60870-5-101 Master Communication Module
3 Ladder Logic
Ladder logic is required for application of the MVI69-101M module. 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 ProSoft Solutions 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. Page 57 of 133
February 4, 2008
Page 58
MVI69-101M ♦ CompactLogix or MicroLogix Platform Ladder Logic
IEC 60870-5-101 Master Communication Module
Page 58 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 59
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform IEC 60870-5-101 Master Communication Module
4 Diagnostics and Troubleshooting
In This Chapter
Reading Status Data From the Module ................................................. 59
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.
4.1 Reading Status Data From the Module
The MVI69-101M module returns a status data set to the CompactLogix or
MicroLogix processor in each read block. This data is transferred to the
ControlLogix processor continuously with each read block.
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
Facility to upload and download the module's configuration file
4.1.1 The Configuration/Debug Menu
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 terminal application (for
example, HyperTerminal). 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.
ProSoft Technology, Inc. Page 59 of 133
February 4, 2008
Page 60
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
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.
The organization of the menu structure is represented in simplified form in the
following illustration:
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 [Shift],
[Ctrl] or [Alt] keys to enter them correctly. For example, on US English
keyboards, enter the [?] command as [Shift][/].
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.
4.1.2 Required Hardware
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.
Page 60 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 61
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
4.1.3 Required Software
In order to send and receive data over the serial port (COM port) on your
computer to the module, you must use a communication program (terminal
emulator).
A simple communication program called HyperTerminal is pre-installed with
recent versions of Microsoft Windows operating systems. If you are connecting
from a machine running DOS, you must obtain and install a compatible
communication program. The following table lists communication programs that
have been tested by ProSoft Technology.
DOS ProComm, as well as several other terminal emulation programs
Windows 3.1 Terminal
Windows 95/98 HyperTerminal
Windows NT/2000/XP HyperTerminal
The module uses the Zmodem file transfer protocol to send (upload) and receive
(download) configuration files from your module. If you use a communication
program that is not on the list above, please be sure that it supports Zmodem file
transfers.
4.1.4 Using the Configuration/Debug Port
To connect to the module's Configuration/Debug port:
1 Connect your computer to the module's port using a null modem cable.
2 Start the communication program on your computer and configure the
communication parameters with the following settings:
Baud Rate 57,600
Parity None
Data Bits 8
Stop Bits 1
Software Handshaking None
3 Open the connection. When you are connected, press the [?] key on your
keyboard. If the system is set up properly, you will see a menu with the
module name followed by a list of letters and the commands associated with
them.
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 Verify that RSLinx is not controlling the COM port. Refer to Disabling the
RSLinx Driver for the Com Port on the PC (page 98).
3 Verify that your communication software is using the correct settings for baud
rate, parity and handshaking.
4 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, you can contact ProSoft
Technology Technical Support for further assistance.
ProSoft Technology, Inc. Page 61 of 133
February 4, 2008
Page 62
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
4.1.5 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 on
your terminal screen:
Caution: Some of the commands available to you from this menu ar e 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 co mmand.
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.
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.
Page 62 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 63
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Opening the IEC-101 Master Menu
Press [I] from the Main Menu to open the IEC-870-5-101 Master Driver Menu.
Use this menu command to view detailed configuration information for the
module.
Transferring the Configuration File from PC to MVI69 module
Press [R] to send (upload) the configuration file from your PC to the module and
store the file on the module's Compact Flash Disk.
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 be certain the module is
configured correctly.
Transferring the Configuration File from MVI69 module to PC
Press [S] to receive (download) 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.
Exiting the Program
Caution: Some of the commands available to you from this menu ar e 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 co mmand.
ProSoft Technology, Inc. Page 63 of 133
February 4, 2008
Page 64
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
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 ROM to configure the
module.
4.1.6 Database View Menu
Press [D] from the Main Menu to open the Database View menu. Use this menu
command to view the current contents of the module's database. Press [?] to
view a list of commands available on this menu.
M = Main Menu
D = Database Menu
? = Display Menu Redisplays (refreshes) this menu
0 – 3 = Pages 0 to 3000
S = Show Again Redisplays last select ed page of data
–= Back 5 Pages
P = Previous Page
+ = Skip 5 Pages
N = Next Page
D = Decimal Display
H = Hexadecimal Display
F = Float Display
A = ASCII Display
M = Main Menu Goes up one level to main menu
Selects page 0, 1000, 2000 or 3000
Goes back five pages of data
Goes back one page of data
Goes forward five pages of dat a
Goes forward one page of data
Displays data in decimal format
Displays data in hex format
Displays data in floating point format
Displays data in text format
Viewing Register Pages
To view sets of register pages, use the keys described below:
Command Description
[0]
[1]
[2]
Display registers 0 to 99
Display registers 1000 to 1099
Display registers 2000 to 2099
And so on. The total number of register pages available to view depends on your
module's configuration.
Page 64 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 65
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Displaying the Current Page of Registers Again
This screen displays the current page of 100 registers in the database.
Moving Back Through 5 Pages of Registers
Press [-] from the Database View menu to skip back to the previous 500
registers of data.
Viewing the Previous 100 Registers of Data
Press [P] from the Database View menu to display the previous 100 registers of
data.
Skipping 500 Registers of Data
Hold down [Shift] and press [=] to skip forward to the next 500 registers of data.
Viewing the Next 100 Registers of Data
Press [N] from the Database View menu to select and display the next 100
registers of data.
Viewing Data in Decimal Format
Press [D] to display the data on the current page in decimal format.
Viewing Data in Hexadecimal Format
Press [H] to display the data on the current page in hexadecimal format.
Viewing Data in Floating Point Format
Press [F] from the Database View menu. Use this command to display the data
on the current page in floating point format. The program assumes that the
values are aligned on even register boundaries. If floating-point values are not
aligned as such, they are not displayed properly.
Viewing Data in ASCII (Text) Format
Press [A] 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. Page 65 of 133
February 4, 2008
Page 66
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
Returning to the Main Menu
Press [M] to return to the Main Menu.
4.1.7 IEC-101M Master Menu
Press [I] from the Main Menu to open the ICE-870-5-101 Master Driver Menu.
Use this menu command to view detailed configuration information for the
module.
M = Main Menu
I = IEC-101 Master Driver Men u
? = Display Menu
A = Data Analyzer
C = General Configuration
I = Command List Menu
P = Port Configuration Menu
Q = Port Status Menu
S = Session Menu
V = Version
Z = Previous Menu
Redisplays (refreshes) this menu
Displays Data Analyzer screen
Displays General Configuration screen
Opens IEC-870-5-103 Master Command List menu
Opens Port Configuration Menu
Opens Port Status Menu
Opens Session Configuration Menu
Displays version information
Goes up one level to main menu
See IEC-101 Master
Command List section
See Port Configuration
section
See Port Status section
See Session Configuration
section
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 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 th e 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 Protocol Configuration
Press [C] to view configuration information for the 101M protocol.
Opening the Command List Menu
Press [I] to open the Command List menu. Use this command to view the
configured command list for the module.
Page 66 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 67
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Viewing Port Configuration
Press [P] to view configuration information for the application port.
Use this command to display detailed configuration information for the port.
Viewing Port Communication Status
Press [Q] to view the port communication status for the application port.
Use this command to view communication status and statistics for the selected
port. This information can be informative when trouble-shooting communication
problems.
Opening the Session Configuration Menu
Press [S] to open the Session Configuration menu. Use this command to view
the session configuration data.
Refer to Session Configuration Menu for more information about the commands
on this menu.
4.1.8 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.
Note: The Port selection commands on the Data Analyzer menu differs very slightly in different
modules, but the functionality is basically the same. Use t he illustration above as a general guide
only. Refer to the actual data analyzer menu on your module for the specific port commands to
use.
Important: When in analyzer mode, program execution will slow down. Only use this tool during a
troubleshooting session. Before disconnecting from th e 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.
Analyzing Data for the first application port
Press [1] to display I/O data for the first application port in the Data Analyzer.
The following illustration shows an example of the Data Analyzer output.
Analyzing Data for the second application port
Press [2] to display I/O data for the second application port in the Data Analyzer.
ProSoft Technology, Inc. Page 67 of 133
February 4, 2008
Page 68
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
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] 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.
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. An example display
is shown below:
The Data Analyzer displays the following special characters:
Page 68 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 69
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
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 th e 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.
4.1.9 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:
ProSoft Technology, Inc. Page 69 of 133
February 4, 2008
Page 70
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
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:
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
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.
button.
Page 70 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 71
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
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.
ProSoft Technology, Inc. Page 71 of 133
February 4, 2008
Page 72
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
4.1.10 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 M enu
? = 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.
Page 72 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 73
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
4.1.11 Session Configuration Menu
Press [S] from the IEC-101 Master Driver Menu to open the Session
Configuration menu. Use this command to view the session configuration for
each controlled device.
Online State
The Online State indicator displays 0 if the module is not online, 1 if the module
is online.
Session State
The Session State indicator displays 1 if there is a configuration error, or 2 if the
module is ready for communication. If the session is not in use, the Session State
indicator displays 0.
ProSoft Technology, Inc. Page 73 of 133
February 4, 2008
Page 74
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
4.1.12 Sector Configuration Menu
Press [1] from the IEC-101 Master Driver Menu to open the Sector Configuration
menu. Use this command to view the contents of the Sector Configuration
Databases for each session (controlled device). The module supports up to three
sectors (databases) per session.
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 Sector Database Menu
Press [D] from the Sector Configuration menu to open the Sector Database
menu. Use this command to look at the configuration and current value for each
point.
The IEC-870-Master Command List Menu section has more information about
the commands on this menu.
Redisplaying the Current Page
Press [S] to display the current page of data.
Displaying the Next Page
Press [N] to display the next 100 registers. Use this command to step forward
through the data a page at a time.
Displaying the Previous Page
Press [P] to display the previous 100 registers. Use this command to step
backward through the data a page at a time.
Returning to the Main Menu
Press [M] to return to the Main Menu.
Page 74 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 75
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
4.1.13 Sector Database Menu
Press [D] from the Sector Configuration menu to open the Sector Database
menu. Use this command to display the sector database values. Each session
(controlled device) contains one or more data sets (sectors) that are defined by
the vendor of the device.
M = Main Menu
I = IEC-101 Master Driver Menu
S = Session Menu
1 = Sector Configuration Menu
D = Sector Database Menu
? = Display Menu
S = Show Again
0 = Single Point Data
1 = Double Point Data
2 = Step Point Data
3 = Bitstring Point Data
4 = Normalized Measure Point Data
5 = Scaled Measure Point Data
6 = Short Float Measure Data
7 = Integrated Total Point Data Integrated totals M_IT_NA_1
8 = Parameter Normalized Data
9 = Parameter Scaled Data
M = Return to Sector Goes up one level to previous menuM = Return to Sector Goes up one level to previous menuA = Parameter Short Float Data
M = Return to Sector Goes up one level to previous menuM = Return to Sector Goes up one level to previous menuB = BCD Integrated Total Data BCD integrated setpoint command
M = Return to Sector Goes up one level to previous menuM = Return to Sector Goes up one level to previous menuM = Return to Sector Menu Goes up one level to previous menu
Redisplays (refreshes) this menu
Displays current page of 100 registers.
Single-point information M_SP_NA_1
Double-point information M_DP_NA_1
Step position information M_ST_NA_1
Bitstring of 32 bit M_BO_NA_1
Measured value, normalized value
M_ME_NA_1
Measured value, scaled value
M_ME_NB_1
Measured value, short floating point
value M_ME_NC_I
Parameter of measured value,
normalized value P_ME_NA_1
Parameter of measured value, scaled
value P_ME_NB_1
Parameter of measured value, short
floating point value P_ME_NC_1
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.
Redisplaying the Current Page
Press [S] to display the current page of data.
Returning to the Main Menu
Press [M] to return to the Main Menu.
ProSoft Technology, Inc. Page 75 of 133
February 4, 2008
Page 76
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
4.2 LED Status Indicators
The LEDs indicate the module's operating status as follows:
ProSoft
Module
CFG Green
BP ACT Amber
OK
Color Status Indication
Data is being transferred between the module and a
remote terminal using the Configuration/Debug port.
No data is being transferred on the Configuration/Debug
port.
The MVI69-101M 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.
The card is not receiving any power and is not securely
plugged into the rack.
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 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.
Red /
Green
On
Off
On Data being transferred on the first application port P1 Green
Off No data being transferred on port
On Data being transferred on the second application port P2 Green
Off No data being transferred on port
Off The MVI69-101M is working normally. APP Status Amber
On
On
Off
Off
Green The module is operating normally.
Red
Off The battery voltage is OK and functioning. BAT Red
On
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
CompactLogix or MicroLogix processor.
Page 76 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 77
Diagnostics and Troubleshooting MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 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
Processor I/O LED
flashes
Verify that the module is plugged into the slot that has been configured for
the module.
Verify that the slot in the rack configuration has been set up correctly in the
ladder logic.
This indicates a problem with backplane communications. Verify that all
modules in the rack are configured in the ladder logic.
Module has a power supply distance rating of 2 on Compact Logix. The
module must be within 2 slots of the power supply on Compact Logix, or
that the MicroLogix backplane can supply the 800ma required for the
module.
Module Errors
Problem Description Steps to take
BP ACT LED remains
off or blinks slowly
OK LED remains red
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 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 reinsert the card in the rack, and then restore power to the rack.
ProSoft Technology, Inc. Page 77 of 133
February 4, 2008
Page 78
MVI69-101M ♦ CompactLogix or MicroLogix Platform Diagnostics and Troubleshooting
IEC 60870-5-101 Master Communication Module
Page 78 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 79
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
5 Reference
In This Chapter
Product Specifications........................................................................... 79
Functional Overview.............................................................................. 81
Master Driver......................................................................................... 96
Cable Connections ................................................................................ 97
MVI69-101M Status Data Area............................................................ 103
MVI69-101M Configuration Data Definition ......................................... 107
Database Form.................................................................................... 112
Command List Form............................................................................113
Interoperability..................................................................................... 114
5.1 Product Specifications
The MVI69 IEC 60870-5-101 Master Communication Module allows
CompactLogix and MicroLogix I/O compatible processors to interface easily with
IEC 60870-5-101 master (controlled unit) devices.
5.1.1 Features and Benefits
The MVI69-101M module interfaces up to 32 serial communication devices with
the CompactLogix processor. Two communication ports on the module act as
controlling devices (masters) to interface with controlled devices on their own
networks. Each port is individually configurable and can be set for balanced or
unbalanced mode. Data is exchanged between the serial network and the
CompactLogix processor using the internal database contained in the module
and direct control by the processors ladder logic.
5.1.2 General Specifications
Single Slot - 1769 backplane compatible
The module is recognized as an Input/Output module and has access to
processor memory for data transfer between processor and module
Ladder Logic is used for data transfer between module and processor.
Sample ladder file included.
Configuration data obtained from configuration text file downloaded to
module. Sample configuration file included.
Supports all CompactLogix processors: L20/L30/L31/L32/L35, L43 and L45
(L43 and L45 supported with RSLogix 5000 v16.03 or later)
Also supports MicroLogix 1500 LRP
ProSoft Technology, Inc. Page 79 of 133
February 4, 2008
Page 80
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
5.1.3 Hardware Specifications
Specification Description
Dimensions Standard 1769 Single-slot module
Current Load 800 mA max@ 5 VDC
Power supply distance rating of 2
Operating Temp. 0 to 60°C (32 to 140°F)
Storage Temp. -40 to 85°C (-40 to 185°F)
Relative Humidity 5% to 95% (non-condensing)
LED Indicators Battery and Module Status
Application Status
Serial Port Activity
CFG Port Activity
CFG Port (CFG) RJ45 (DB-9F with supplied cable)
RS-232 only
No hardware handshaking
App Ports (P1,P2) (Serial modules) RS-232, RS-485 or RS-422 (jumper selectable)
RJ45 (DB-9F with supplied cable)
RS-232 handshaking configurable
500V Optical isolation from backplane
Shipped with Unit RJ45 to DB-9M cables for each port
6-foot RS-232 configuration Cable
5.1.4 Functional Specifications
Built in accordance to the approved international specification
Two independent master ports completely user configurable
Support for balanced and unbalanced mode
Up to 32 sessions
Up to five sectors (separate databases) for each session
Individual database definition for each sector
1000 commands to control stations
Processor can issue control commands directly to the module or a controlled
device (10 at each scan)
Pass-through of event messages from controlled device to processor for
logging of time-tagged events
Operation via simple ladder logic
Supports clock synchronization from/to the processor
Receives events from the slave and sends them to the processor
Supports monitored data
o Single-point
o Double-point
o Step-point
o Measured-point
o Bitstring 32-bit
o Integrated total point
Page 80 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 81
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Class 1 and Class 2 delay parameter in the configuration file
Complete set up and monitoring of module through RSLogix 5000 software
and user constructed configuration file (IEC101M.CFG)
All data related to the module is contained in user data files to simplify
monitoring and interfacing with the module
5.2 Functional Overview
This section provides an overview of how the MVI69-101M module transfers data
using the 101M protocol. You should understand the important concepts in this
chapter before you begin installing and configuring the module.
The standards used to build the module are listed in the following table:
Publication Title
IEC 60870-5-101 Companion Standard for Basic Telecontrol Tasks
IEC 60870-5-101
Amendment 1
IEC 60870-5-1 Transmission Frame Formats
IEC 60870-5-2 Link Transmission Procedures
IEC 60870-5-3 General Structure of Application Data
IEC 60870-5-4 Definition and Coding of Application Information Elements
IEC 60870-5-5 Basic Application Functions
IEC 60870-5-104 Network access for IEC 60870-5-101 using standard transport profiles
Companion Standard for Basic Telecontrol Tasks
These documents should be obtained, reviewed, and understood in order to fully
appreciate the protocol implementation. Most of the complexity of the protocol is
hidden from the user and simplified in the application of the module. Detailed
questions of about the protocol can be answered by reading these documents. In
addition to calling our technical support group, there is also help available for the
protocol using the following mail list Web Site:
www.TriangleMicroWorks.com/iec870-5
. Go to this site to join the mail list and to
review questions and answers from mail list users.
5.2.1 General Concepts
The following discussion explains several concepts that are important for
understanding the operation of the MVI69-101M module.
Module Power Up
On power up the module begins performing the following logical functions:
1 Initialize hardware components
2 Initialize CompactLogix or MicroLogix backplane driver
3 Test and clear all RAM
4 Initialize the serial communication ports
5 Read configuration for module from IEC101M.CFG file on Compact Flash
Disk
6 Initialize the databases and ports
7 Set up the serial communication interface for the debug/configuration port
ProSoft Technology, Inc. Page 81 of 133
February 4, 2008
Page 82
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
After the module has received the configuration, the module will begin receiving
and transmitting messages with devices on the serial networks.
Main Logic Loop
Upon completing the power up configuration process, the module enters an
infinite loop that performs the following functions:
From Power Up Logic
Call I/O Handler
Call CFG/DEBUG Port
Driver
Call Network Master
Drivers
Transfers data between the module and processor
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 I/O Hand le r
(user, status, etc.)
Call Serial Port Driver
Call N e twork M aster D r iv e rs
Generate Messages.
Backplane Data Transfer
The MVI69-101M module communicates directly over the CompactLogix or
MicroLogix backplane. Data is paged between the module and the processor
across the backplane using the module's input and output images. The frequency
of update of the images is determined by the scheduled scan rate defined by the
user for the module and the communication load on the module. Typical updates
are in the range of 2.5 to 10 milliseconds.
This bi-directional transference of data is accomplished by the module filling in
data in the module's input image to send to the processor. Data in the input
image is placed in the Controller Tags in the processor by the ladder logic. The
input image for the module is user configurable. This large data area permits fast
throughput of data between the module and the processor.
The processor inserts data to the module's output image to transfer to the
module. The module's program extracts the data and places it in the module's
internal database. The output image for the module is user configurable. This
large data area permits fast throughput of data from the processor to the module.
Page 82 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 83
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
All data transferred between the module and the processor over the backplane is
through the input and output images. Ladder logic must be written in the
processor to interface the input and output image data with data defined in the
Controller Tags. All data used by the module is stored in its internal database.
This database is defined as a virtual Modbus data table with addresses from 0
(40001 Modbus) to 7221 (47222 Modbus). The following illustration shows the
layout of the database:
Data contained in this database is paged through the input and output images by
coordination of the ladder logic and the MVI69-101M module's program. Each
image has a defined structure depending on the data content and the function of
the data transfer as defined in the following topics.
Normal Data Transfer
Normal data transfer includes the paging of the user data found in the module's
internal database in registers 0 to 3999, a portion of the status data, input file
data and global output data. These data are transferred through read (input
image) and write (output image) blocks.
The Write Block ID is associated with the block requests data from the processor.
Under normal, program operation, the module sequentially sends read blocks
and requests write blocks. For example, if three read and two write blocks are
used with the application, the sequence will be as follows:
R1W1 R2W2 R3W1 R1W2 R2W1 R3W2 R1W1
This sequence will continue until interrupted by other write block numbers sent by
the controller. The number of read and write blocks generated will depend on the
read and write areas configured by the user based on the following configuration
parameters:
Read Register Count
Write Register Count
The number of blocks transferred between the module and the processor
also depends on the number of read and writes data words transferred per
block. Therefore the following parameter will also determine the number of
blocks transferred:
Block Transfer Size For example, with the following parameter values configured:
Read Register Count = 240
Write Register Count = 240
Block Transfer Size = 60
ProSoft Technology, Inc. Page 83 of 133
February 4, 2008
Page 84
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
The following number of blocks would be transferred between the module and
the processor:
Read Blocks = 6 blocks
Write Blocks = 4 blocks
Note: when Block Transfer Size parameter is config ured for 120 or 240 words the actual number of
data words is less than the block size. Refer to the tables in this section for the actual number of
data words transferred in each read and write blocks.
Refer to Module Configuration (page 19) for a description of the data objects
used with the blocks and the ladder logic required. The structure and function of
each block is discussed in the following topics.
Read Block
These blocks of data transfer information from the module to the processor. The
structure of the input image used to transfer this data depends on the block
transfer size configured by the user, as shown in the following tables:
Block Transfer Size = 60 Words
Offset Description Length
0 Read Block ID (1 to 67) 1
1 Write Block ID (1 to 67) 1
2 to 61 Read Data 60
Block Transfer Size = 120 Words
Offset Description Length
0 Read Block ID 1
1 Write Block ID 1
2 to 121 Read Data 120
Block Transfer Size = 240 Words
Offset Description Length
0 Read Block ID 1
1 Write Block ID 1
2 to 241 Read Data 240
Note: Offset and length are given as words.
The Read Block ID is an index value used to determine the location where the
data will be placed in the processor controller tag array read data. The maximum
amount of data that each transfer can move will depend on the block transfer
size as follows:
Block Transfer Size = 60 => Read Data Count per Block = 60 words
Block Transfer Size = 120 => Read Data Count per Block = 88 words
Block Transfer Size = 240 => Read Data Count per Block = 193 words
Page 84 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 85
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Therefore, when configured for block transfer size of 120 or 240 words the
module also updates the global input data that is used for high-speed data
movement.
When the module is configured for block transfer size of 60 words the following
block can be used to update the global input data:
Offset Description Length
0 -1, 0, or 80 1
Note: Offset and length are given as words.
The block 80 is periodically sent by the module to update the global input data.
The blocks -1 and 0 are generated if the number of read blocks sent by the
module (based on the configured read data area) is equal to one or zero. The
processor can send a request for block 80 as listed on the Write Block section.
Write Block
These blocks of data transfer information from the processor to the module. The
structure of the output image used to transfer this data will depend on the Block
Transfer Size value configured by the user as shown in the following tables:
Block Transfer Size = 60 words
Offset Description Length
0 Write Block ID (1 to 67) 1
1 to 60 Write Data 60
Block Transfer Size = 120 words
Offset Description Length
0 Write Block ID (1 to 54) 1
1 to 120 Write Data 120
Block Transfer Size = 240 words
Offset Description Length
0 Write Block ID (1 to 21) 1
1 to 240 Write Data 240
Note: Offset and length are given as words.
Warm Boot
This block is sent from the CompactLogix or MicroLogix processor to the module
(output image) when the module is required to perform a warm-boot (software
reset) operation. This block is commonly sent to the module any time
configuration data modifications are made in the controller tags data area. This
will force the module to read the new configuration information and to restart. The
structure of the control block is shown in the following table:
Offset Description Length
0 9998 1
1 to n Spare n
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
ProSoft Technology, Inc. Page 85 of 133
February 4, 2008
Page 86
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
Cold Boot
This block is sent from the CompactLogix processor to the module (output
image) when the module is required to perform the cold boot (hardware reset)
operation. This block is sent to the module when a hardware problem is detected
by the ladder logic that requires a hardware reset. The structure of the control
block is shown in the following table:
Offset Description Length
0 9999 1
1 to n Spare n
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
5.2.2 Data Type Mapping and Addressing
When interfacing data in the processor to that of the IEC 60870-5-101 protocol, it
is important that the user understand the mapping of the data types to their
corresponding representation in the modules database. The table that follows
lists the data types supported by the module and their associated storage
representation.
IEC-870-5-101 Data Types
Type ID Type Description Data representation
1
3
5
7
M_SP_NA
_1 (7.3.1.1)
M_DP_NA
_1 (7.3.1.3)
M_ST_NA
_1 (7.3.1.5)
M_BO_NA
_1 (7.3.1.7)
Monitored Single-point Information:
This data type stores a single binary
input point. Associated time-tagged
event information for this type are
M_SP_TA_1 (2) and M_SP_TB_1
(30).
Monitored Dual-point Information:
This data type stores a dual-point
binary input value (that is, valve
status). Associated time-tagged
event information for this type are
M_DP_TA_1 (4) and M_DP_TB_1
(31).
Monitored Step-point Information:
This data type is used for step
position of transformers or other
step position information. The value
for the position ranges from -64 to
63. Associated time-tagged event
information for this type are
M_ST_TA_1 (6) and M_ST_TB_1
(32).
Monitored Bitstring of 32-bit data -This data type stores 32-bit data in
binary form. Each bit in the string
has a value of 0 or 1. Associated
time-tagged event information for
this type are M_BO_TA_1 (8) and
M_BO_TB_1 (33).
Single bit value (7.2.6.1) with
0=Off and 1=On.
Dual-bit status (7.2.6.2) with 00b
(0 decimal) = indeterminate or
intermediate, 01b (1 decimal) =
Off, 10b (2 decimal) = On and
11b (3 decimal) = indeterminate.
Step data (7.2.6.5) is stored in a
single character value with bits 0
to 6 (-64 to +63) representing the
step position and bit 7
representing the following states:
0 = Equipment is not in transient
state 1 = Equipment in transient
state
Each of the 32 bits in the bitstring
has a value of 0 or 1 (7.2.6.13).
Page 86 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 87
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Type ID Type Description Data representation
9
11
13
15
45
46
47
48
49
50
51
M_ME_NA
_1 (7.3.1.9)
M_ME_NB
_1
(7.3.1.11)
M_ME_NC
_1
(7.3.1.13)
M_IT_NA_
1 (7.3.1.15)
C_SC_NA
_1 (7.3.2.1)
C_DC_NA
_1 (7.3.2.2)
C_RC_NA
_1 (7.3.2.3)
C_SE_NA_
1 (7.3.2.4)
C_SE_NB_
1 (7.3.2.5)
C_SE_NC
_1 (7.3.2.6)
C_BO_NA
_1 (7.3.2.7)
Monitored Normalized Measured
Value: This data type is used for
analog input data. Associated timetagged event information for this
type are M_ME_TA_1 (10) and
M_ME_TD_1 (34).
Monitored Scaled Measured Value -This data type is used for analog
input data. Associated time-tagged
event information for this type are
M_ME_TB_1 (12) and M_ME_TE_1
(35).
Monitored Measured Value, Short
Floating-Point Number: This data
type is used for analog input data
stored in floating point format
according to the IEEE STD 754,
QDS format. Associated time-tagged
event information for this type are
M_ME_TC_1 (14) and M_ME_TE_1
(36).
Monitored Integrated Total-point
Information --This data type stores
meter or other count data.
Associated time-tagged event
information for this type are
M_IT_TA_1 (15)and M_IT_TB_1
(37).
Single-point Command: This
command controls a single binary
point such as a relay.
Double-point Command: This
command controls a dual-point
binary control device such as a
trip/close relay.
Regulating Step Command: This
command controls a stepping device
such as a transformer.
Setpoint Command, Normalized
Value: This command controls an
analog device.
Setpoint Command, Scaled Value:
This command controls an analog
device.
Setpoint Command, Short FloatingPoint Format: This command
controls an analog device accepting
an IEEE STD 754 floating-point
format value.
Setpoint Command, 32-bit Bitstring:
This command controls a bitstring in
a device.
Normalized values (7.2.6.6) are
stored in a word (16-bit) data
area with a range of -1..+1-2
-15
Scaled values (7.2.6.7) are
stored in a word (16-bit) data
area with a range of -2
15
.. +215-1
Short floating-point number
stored in IEEE STD 754 format
(Fraction, Exponent, Sign)
(7.2.6.8)
Binary counter data (7.2.6.9) is
stored in a double-word (32-bit)
value with a range of -2
31
..+231-1.
Single bit value (7.2.6.15) with 0
= Off and 1 = On
Double Command (7.2.6.16) with
0 = Not permitted 1 = Off 2 = On
3 = Not permitted
Regulating Step Command
(7.2.6.17) with 0 = Not permitted
1 = Next step lower 2 = Next step
higher 3 = Not permitted
Normalized values (7.2.6.6) are
stored in a word (16-bit)data area
with a range of -1..+1-2
-15
Scaled values (7.2.6.7) are
stored in a word (16-bit) data
area with a range of -2
15
.. +215-1
Short floating-point number
stored in IEEE STD 754 format
(Fraction, Exponent, Sign)
(7.2.6.8)
Each of the 32 bits in the bitstring
has a value of 0 or 1 (7.2.6.13).
ProSoft Technology, Inc. Page 87 of 133
February 4, 2008
Page 88
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
The data addressing is resumed in the following table:
Data Size Example
Single Point 1 bit
Dual Point 2 bits
Step Point 1 byte
Bitstring 32 bit 2 words
Normalized Measured
Value
Scaled Measured Value 1 word Address 100 refers to word 100 in database
Short Float Point
Measured Value
Integrated Total Point 2 words
1 word Address 100 refers to word 100 in database
2 words
Address 1600 refers to word 100, bit 1 in
database
Address 1600 refers to word 100, bits 1 and 2 in
database
Address 200 refers to word 100, lower byte in
database
Address 50 refers to word 100 and 101 in
database
Address 50 refers to words 100 and 101 in
database
Address 50 refers to words 100 and 101 in
database
Another important concept to understand is the direction of data transfer for the
different data types with reference to the controller. The following illustration
shows the data types (monitored data) that are transferred from the module to
the processor.
Read Data Input Data Types
M_SP_NA_1
M_DP_NA_1
M_ST_NA_1
M_BO_NA_1
M_ME_NTA_1
M_ME_NB_1
M_ME_NC_1
M_IT_NA_1
The next diagram shows the movement of control data from the processor to the
module. This data is then sent to the controlled devices on the serial networks.
Write Data
Output Data Types
C_SC_NA_1
C_DC_NA_1
C_RC_NA_1
C_SE_NA_1
C_SE_NB_1
C_SE_NC_1
C_BO_NA_1
Page 88 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 89
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
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. The block identification codes used by the module are
displayed in the following table:
Block Range Descriptions
-1 Null block
0 Null block
1 to 20 Read or write data
9901 User Constructed Command
9902 Command Control Block (Add command to Command List Queue)
9903 Event Messages from Master port
9950 Command List Error data
9970 Set PLC time using module's time
9971 Set module's time using PLC time
9998 Warm Boot Request from PLC (Block contains no data)
9999 Cold Boot Request from PLC (Block contains no data)
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 serial network) and to send data from the
processor to the module (control data to send to the end devices). Block
identification codes 9901 to 9999 are used for special control blocks to control
the module. Each of these blocks are discussed in the following topics.
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.
User Constructed Command Block (9901)
Block identification code 9901 issues one or more user constructed commands.
When the module receives a block 9901 identification code, it will place the
included commands into the command queue.
Word Offset in Block Data Field(s) Description
0 Block ID
1
2 to 7 Command #1
8 to 13 Command #2
14 to 19 Command #3
Command
Count
This field contains the block identification code of
9901 for the block.
This field defines the number of user commands
contained in the block. The valid range for the field is
1 to 10.
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
ProSoft Technology, Inc. Page 89 of 133
February 4, 2008
Page 90
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
Word Offset in Block Data Field(s) Description
20 to 25 Command #4
26 to 31 Command #5
32 to 37 Command #6
38 to 43 Command #7
44 to 49 Command #8
50 to 55 Command #9
56 to n Spare Not used
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
Data required to build the user defined command in
the command queue.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
The following fields are used for each 6-word record in the command list:
Word Offset Definitions Description
0 Database Index Address in module to associate with the command
1 Session Index
2 Sector Index Sector index for session as defined in the module.
3 Data Type ASDU data type associated with the command.
4 Point Index
5 Qualifier
Session index defined in the module to associate
with the command.
Information object address for the point on which
command operates.
Qualifier as defined for the command parameter is
data type dependent. list. This
Refer to the command list section of this documentation for a detailed definition
of the fields contained in this block. They are the same as those used in
constructed the commands in the command list.
There is no response block built by the module to send back to the processor
after the block is processed. The commands are placed in the command queue
and issued at a high priority.
This block and block 9902 should be used when controlling single-point, doublepoint and regulating step data points in remote units. If the persistent output
qualifier is used in a command list, the command list can be utilized. For points
that are controlled using the short or long pulse or no definition given qualifier,
block 9901 should be used to control the output. For example, if the command
list controls a short pulse output for a single point using the enable code of 2, any
time the point's value in the database changes the command will be executed.
When the point changes to a value of 0, the short pulse off command will be
executed. When the point changes to a value of 1, the short pulse on command
will be executed. This may not be what is desired for the application. If block
9901 is utilized instead, the ladder logic can execute a short pulse on command
using a database point it that is set to 1.
Page 90 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 91
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
For step control, if the database value is set to -1, the regulating step command
of next lower will be executed. If the value in the database is 1, the regulating
step command of next higher will be executed. Using block 9901 control of end
device may be more reliable.
Command Control Block (9902)
The block 9902 identification code is used by the processor to send a list of
commands to be placed in the command queue from the user configured
command list. Commands placed in the queue with this method need not have
their enable bit set in the command list.
Word Offset in Block Data Field(s) Description
0 Block ID
1 Command count
2 to 51
52 to n Spare Not used
Command
Numbers to
enable
This field contains the value of 9902 identifying the
enable command to the module.
This field contains the number of commands to
enable in the command list. Valid values for this field
are 1 to 60.
These 60 words of data contain the command
numbers in the command list to enable. The
commands in the list will be placed in the command
queue for immediate processing by the module. The
first command in the list has an index of 0.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
There is no response to this block by the module. The module will place the
selected commands into the command queue. If the command references a unit
that is not defined, the command will not be placed in the command queue.
Normal processing of the command list will continue after the commands
specified in this block are processed.
For digital output control, the use of block 9901 and 9902 is preferred to the use
of the command list. The exact state of the output can be specified in the
command list and then the command can be enabled through the use of block
9902. Therefore, the command list can contain an short pulse on command.
When the user wishes to execute this command (knowing the state of the
command), can enable the command with the block 9902 request.
Event Message Block (9903)
Block identification code 9903 sends event messages received on the master
port to the processor.
Word Offset in Block Data Field(s) Description
0 Reserved
1 Block ID This is the next block requested by the module.
2 Event Count
3 to 16 Event 1 Event message
17 to 30 Event 2 Event message
This field contains the block identification code of
9903 for the block.
This field contains the number of events present in
the block. Values of 1 to 4 are valid.
ProSoft Technology, Inc. Page 91 of 133
February 4, 2008
Page 92
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
Word Offset in Block Data Field(s) Description
31 to 44 Event 3 Event message
45 to 58 Event 4 Event message
59 to n Spare Not Used
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
The format of each 14 word data region in the block is as follows:
Word Offset Definitions Description
0 Session Index
1 Sector Index
2 COT
3 Reserved
4 to 5 Point Index
6 ASDU Type
7
8
9 Month and Day
10 Year This field contains the year the event occurred.
11 Qualifier
12 to 13 Value
Milliseconds
and Seconds
Minutes and
Hours
This field contains the session index used to define
the controlled unit in the module from which the
event was generated.
This field contains the sector index used to define
the database within the controlled unit from which
the event was generated.
This field contains the COT for the event message
received from the IED. If the size of the COT is a
single byte, the originator address will always be
zero. The COT is in the LSB and the originator
address is in the MSB.
This field is reserved for future use and is added
here to keep the structure double-word aligned for all
platforms.
This field contains the point index in the remote
device that generated the event.
This field contains the ASDU type code for the data
contained in the message.
This word contains the seconds and milliseconds
when the event occurred.
This field contains the minutes and hours the event
occurred.
This field contains the month and day of the month
the event occurred.
This field contains the point qualifier, quality or
sequence value as described in the protocol
specification.
This field contains the a double word value for the
point associated with the event message.
In order for this feature to be activated, the event pass-through parameter must
be set. When a master driver receives an event message from a controlled
station, it will build an event message corresponding to the event in the event
buffer of the module. This buffer is then sent to the processor when any
messages are present. Therefore, these blocks are sent to the processor on a
high priority. After the block is sent, the event message is removed from the
module's event buffer.
Page 92 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 93
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
If too many events are present in the buffer (>200), the module will set the event
message overflow flag in the error/status data area of the normal read data
block. There is no response block to be received by the module from the
processor.
Command List Error Data Block (9950)
Block 9950 identification code requests the Command List Error Table from the
module for the 1000 user configurable commands. The format for the block is
shown in the following table:
Word Offset in Block Data Field(s) Description
0 Block ID
1
2
3 to n Spare Not Used
Number of
Commands to
report
Start Index of
First Command
This field contains the value of 9950 identifying the
block type to the module.
This field contains the number of commands to
report in the response message. The value has a
range of 1 to 200.
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.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
The module will respond to a valid request with a block containing the requested
error information. The format for the block is shown in the following table:
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
3
4 to 53
54 to n Spare Not Used
Number of
Commands
reported
Start Index of
First Command
Command List
Errors
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 200.
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.
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
block. The number of valid command errors in the
block is set in word 2 of the block. Refer to the
command error list to interpret the error codes
reported.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
ProSoft Technology, Inc. Page 93 of 133
February 4, 2008
Page 94
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
Set PLC Time Block (9970)
Block 9970 identification code requests the module's date and time. Use this data
to set the PLC clock.
Word Offset in Block Data Field(s) Description
0 Block ID
1 to n Spare Not Used
This field contains the value of 9970 identifying the
block type to the module.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
The module will respond to a valid block 9970 request with a block containing the
requested date and time. The format for the block is shown in the following table:
Word Offset in Block Data Field(s) Description
0 Reserved Reserved (0)
1 Block Write ID This is the next block requested by the module.
2 Year
3 Month
4 Day
5 Hour
6 Minute
7 Seconds
8 Milliseconds
9 to n Not Used Not Used
This field contains the four-digit year to be used with
the new time value.
This field contains the month value for the new time.
Valid entry for this field is in the range of 1 to 12.
This field contains the day value for the new time.
Valid entry for this field is in the range of 1 to 31.
This field contains the hour value for the new time.
Valid entry for this field is in the range of 0 to 23.
This field contains the minute value for the new time.
Valid entry for this field is in the range of 0 to 59.
This field contains the second value for the new
time. Valid entry for this field is in the range of 0 to
59.
This field contains the millisecond value for the new
time. Valid entry for this field is in the range of 0 to
999.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
Set Module Time Block (9971)
Block identification code 9971 passes the clock time to the module. The date and
time provided will be used to set the module's clock.
Word Offset in Block Data Field(s) Description
0 Block ID
1 Year
2 Month
3 Day
This field contains the block identification code of
9971 for the block.
This field contains the four-digit year to be used with
the new time value.
This field contains the month value for the new time.
Valid entry for this field is in the range of 1 to 12.
This field contains the day value for the new time.
Valid entry for this field is in the range of 1 to 31.
Page 94 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 95
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
Word Offset in Block Data Field(s) Description
4 Hour
5 Minute
6 Seconds
7 Milliseconds
8 to n Not Used Not Used
This field contains the hour value for the new time.
Valid entry for this field is in the range of 0 to 23.
This field contains the minute value for the new time.
Valid entry for this field is in the range of 0 to 59.
This field contains the second value for the new
time. Valid entry for this field is in the range of 0 to
59.
This field contains the millisecond value for the new
time. Valid entry for this field is in the range of 0 to
999.
where n = 60, 120, or 240 depending on the Block Transfer Size parameter (refer
to the configuration file).
The module does not send a response block to the processor after receiving this
block.
Warm Boot Block (9998)
Block 9998 performs a warm-boot operation on the module. The format of the
block constructed by the processor is as follows:
Offset Description Length
0 9998 1
1 to 247 Spare 247
In this version of the module, the warm and cold boot processes perform the
same operation as many of the variables that must be initialized are fixed when
the module first boots and cannot be changed after the application starts.
Cold Boot Block (9999)
Block 9999 performs a cold-boot operation on the module. The format of the
block constructed by the processor is as follows:
Offset Description Length
0 9999 1
1 to 247 Spare 247
In this version of the module, the warm and cold boot processes perform the
same operation as many of the variables that must be initialized are fixed when
the module first boots and cannot be changed after the application starts.
ProSoft Technology, Inc. Page 95 of 133
February 4, 2008
Page 96
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
5.3 Master Driver
The master driver supported on each application port of the module emulates an
IEC 60870-5-101 master device. Configuration of each port is independent and
should be connected to different serial networks.
Each port on the module communicates with one or more controlled stations on
what are referred to as sessions. A session represents a controlled device with a
unique data link layer address. Each session (controlled device) contains one or
more data sets (sectors) that are defined by the vendor of the device. The
following illustration shows these relationships.
Port 0 on the module communicates with 4 sessions (0, 1, 3 and 4) each of which
has their own data set(s). Session 1 only has one sector (all data for device
contained in a single database). This sector is addressed by the master using the
Common address of ASDU value set for the sector in the configuration file.
Session 0 contains two sectors each with their own unique Common address of
ASDU value to identify the sector. Port 0 must operate in unbalanced mode as
more than one device exists on the network.
Port 1 may operate in balanced mode as it only contains one device on the
network. This device is defined in the Session 2 section of the configuration file.
In this example, all data of the device is stored in a single sector.
The module supports two application ports. Thirty-two session can be defined on
the module with each session being assigned to an application port. Within each
session, up to five sectors can be defined. This system permits a very flexible
assignment of resources in the module. The definition of the data associated with
each sector in the system is defined by the user in the configuration file.
Page 96 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 97
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
The following diagram shows the functionality of the master driver:
Processor Memory
Backplane Interface
IEC 60870-5-101 Module
ControlLogix
Controller Tags
from Module
Register
Data
storage
Status
Database
Addresses
0
4999
Register
Data
Status
2
Status
Configuration
5
Master
Mode
Driver
6
1
3
1 The master driver is configured as specified by the IEC101M.CFG file
2 The master will construct control commands using the data in the database
3 The master will send these commands and class polls out on the serial
network
4 Response messages or spontaneous messages generated by controlled
devices on the serial network are received by the master driver
5 Monitor data (static and event) received by the master is passed to the
module's database and passed to the processor
6 Additionally, status data for the module is passed to the processor
4
5.4 Cable Connections
The application ports on the MVI69-101M module support RS-232, RS-422, and
RS-485 interfaces. Please inspect the module to ensure that the jumpers are set
correctly to correspond with the type of interface you are using.
Note: When using RS-232 with radio modem applications, some radios or modems require
hardware handshaking (control and monitoring of modem signal lines). Enable this in the
configuration of the module by setting the U seCTS parameter to 1.
ProSoft Technology, Inc. Page 97 of 133
February 4, 2008
Page 98
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
5.4.1 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 for communications on this port is shown in the following
diagram:
Disabling the RSLinx Driver for the Com Port on the PC
The communication port driver in RSLinx can occasionally prevent other
applications from using the PC's COM port. If you are not able to connect to the
module's configuration/debug port using ProSoft Configuration Builder (PCB),
HyperTerminal or another terminal emulator, follow these steps to disable the
RSLinx Driver.
1 Open RSLinx and go to Communications>RSWho
2 Make sure that you are not actively browsing using the driver that you wish to
stop. The following shows an actively browsed network:
Page 98 of 133 ProSoft Technology, Inc.
February 4, 2008
Page 99
Reference MVI69-101M ♦ CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication Module
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 When you have verified that the driver is not being browsed, go to
Communications>Configure Drivers
You may see something like this:
If you see the status as running, you will not be able to use this com port for
anything other than communication to the processor. To stop the driver press
the "Stop" on the side of the window:
or the icons.
5 After you have stopped the driver you will see the following:
ProSoft Technology, Inc. Page 99 of 133
February 4, 2008
Page 100
MVI69-101M ♦ CompactLogix or MicroLogix Platform Reference
IEC 60870-5-101 Master Communication Module
6 Upon seeing this, you may now use that com port to connect to the debug
port of the module.
Note: You may need to shut down and restart your PC before it will allow you to stop the driver
(usually only on Windows NT machines). If you have followed all of the above steps, and it will not
stop the driver, then make sure you do not have RSLogix open. If RSLogix is not open, and you
still cannot stop the driver, then reboot your PC.
5.4.2 RS-232
When the RS-232 interface is selected, the use of hardware handshaking
(control and monitoring of modem signal lines) is user definable. If no hardware
handshaking will be used, the cable to connect to the port is as shown below:
RS-232: Modem Connection
This type of connection is required between the module and a modem or other
communication device.
The "Use CTS Line" parameter for the port configuration should be set to 'Y' for
most modem applications.
Page 100 of 133 ProSoft Technology, Inc.
February 4, 2008
Loading...