ProSoft Technology inRax MVI69-101M User Manual
MVI69-101M
CompactLogix or MicroLogix Platform
IEC 60870-5-101 Master Communication
Module
User Manual
February 04, 2008
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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Loading...