We always want you to feel that you made the right decision to use our products. If you have suggestions, comments,
compliments or complaints about our products, documentation, or support, please write or call us.
Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products
and services of, their respective owners.
®
, ProLinx ®, inRAx ®, ProTalk®, and RadioLinx ® are Registered Trademarks of ProSoft
ProSoft Technology® Product Documentation
In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments.
User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided on the enclosed CD-ROM,
and are available at no charge from our web site: www.prosoft-technology.com
Printed documentation is available for purchase. Contact ProSoft Technology for pricing and availability.
North America: +1.661.716.5100
Asia Pacific: +603.7724.2080
Europe, Middle East, Africa: +33 (0) 5.3436.87.20
Latin America: +1.281.298.9109
Important Installation Instructions
Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b)
of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian
Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following
warnings must be heeded:
A WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR
CLASS I, DIV. 2;
B WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE
REPLACING OR WIRING MODULES
C WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
D THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.
All ProLinx® Products
WARNING – EXPLOSION HAZARD – DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
AVERTISSEMENT – RISQUE D'EXPLOSION – AVANT DE DÉCONNECTER L'EQUIPMENT, COUPER LE
COURANT OU S'ASSURER QUE L'EMPLACEMENT EST DÉSIGNÉ NON DANGEREUX.
Markings
UL/cUL ISA 12.12.01 Class I, Div 2 Groups A, B, C, D
cUL C22.2 No. 213-M1987
183151
CL I Div 2 GPs A, B, C, D
II 3 G
Ex nA nL IIC X
0°C <= Ta <= 60°C
II – Equipment intended for above ground use (not for use in mines).
3 – Category 3 equipment, investigated for normal operation only.
G – Equipment protected against explosive gasses.
ProLinx Gateways with Ethernet Ports
Series C ProLinx™ Gateways with Ethernet ports do NOT include the HTML Web Server. The HTML Web Server
must be ordered as an option. This option requires a factory-installed hardware addition. The HTML Web Server now
supports:
8 MB file storage for HTML files and associated graphics files (previously limited to 384K)
32K maximum HTML page size (previously limited to 16K)
To upgrade a previously purchased Series C model:
Contact your ProSoft Technology distributor to order the upgrade and obtain a Returned Merchandise Authorization
(RMA) to return the unit to ProSoft Technology.
To order a ProLinx Plus gateway with the -WEB option
Add -WEB to the standard ProLinx part number. For example, 5201-MNET-MCM-WEB.
IEC-101 Slave ♦ ProLinx Communication Gateway Contents
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
Contents
Your Feedback Please ........................................................................................................................ 2
Using ProSoft Configuration Builder ...................................................... 13
For most applications, the installation and configuration steps described in this
section will work without additional programming. ProSoft Technology strongly
recommends that you complete the steps in this chapter before developing a
custom application.
1.1 What's New
This new and enhanced version 3 of ProSoft Technology's IEC 60870-5-101
Slave implementation includes several new features not found on previous
versions. Version 3 now supports 32-bit bitstring data types. Version 3 also
supports more Causes of Transmission than previous versions. For additional
details, please see the Interoperability Statement (page 129).
1.2 ProLinx Reference Guide
The ProLinx Reference Guide on the ProSoft Solutions CD-ROM provides
detailed information on the entire range of ProLinx gateways. If you have any
questions that are not answered in the 101S Protocol Manual, please refer to the
ProLinx Reference Guide.
ProSoft Technology, Inc. Page 11 of 159
August 6, 2010
Start Here IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
You must install the ProSoft Configuration Builder (PCB) software to configure
the gateway. You can always get the newest version of ProSoft Configuration Builder from the ProSoft Technology website.
To install ProSoft Configuration Builder from the ProSoft website
1 Open your web browser and navigate to http://www.prosoft-
technology.com/pcb
2 Click the D
Configuration Builder.
3 Choose S
4 Save the file to your Windows Desktop, so that you can find it easily when
you have finished downloading.
5 When the download is complete, locate and open the file, and then follow the
instructions on your screen to install the program.
If you do not have access to the Internet, you can install ProSoft Configuration Builder from the ProSoft Solutions Product CD-ROM, included in the package
with your gateway.
To install ProSoft Configuration Builder from the Product CD-ROM
1 Insert the ProSoft Solutions Product CD-ROM into the CD-ROM drive of your
PC. Wait for the startup screen to appear.
2 On the startup screen, click P
Windows Explorer file tree window.
3 Click to open the U
and files you will need to set up and configure your gateway.
4 Double-click the S
PCB_*.
software on your PC. The information represented by the "*" character in the
file name is the PCB version number and, therefore, subject to change as
new versions of PCB are released.
OWNLOAD HERE link to download the latest version of ProSoft
AVE or SAVE FILE when prompted.
RODUCT DOCUMENTATION. This action opens a
TILITIES folder. This folder contains all of the applications
ETUP CONFIGURATION TOOL folder, double-click the
EXE file and follow the instructions on your screen to install the
Note: Many of the configuration and maintenance procedures use files and other utilities on the
CD-ROM. You may wish to copy the files from the Utilities folder on the CD-ROM to a convenient
location on your hard drive.
1.3.1 Using the Online Help
Most of the information needed to help you use ProSoft Configuration Builder is
provided in a Help System that is always available whenever you are running
ProSoft Configuration Builder. The Help System does not require an Internet
connection.
To view the help pages, start ProSoft Configuration Builder, open the H
menu, and then choose CONTENTS.
Page 12 of 159 ProSoft Technology, Inc.
August 6, 2010
ELP
IEC-101 Slave ♦ ProLinx Communication Gateway Start Here
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
1.4 Using ProSoft Configuration Builder
ProSoft Configuration Builder (PCB) provides a quick and easy way to manage
gateway configuration files customized to meet your application needs. PCB is
not only a powerful solution for new configuration files, but also allows you to
import information from previously installed (known working) configurations to
new projects.
1.4.1 Setting Up the Project
To begin, start ProSoft Configuration Builder (PCB). If you have used other
Windows configuration tools before, you will find the screen layout familiar.
ProSoft Configuration Builder’s (PCB's) window consists of a tree view on the
left, an information pane, and a configuration pane on the right side of the
window. When you first start PCB, the tree view consists of folders for Default
Project and Default Location, with a Default Module in the Default Location
folder. The following illustration shows the PCB window with a new project.
ProSoft Technology, Inc. Page 13 of 159
August 6, 2010
Start Here IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
To add the gateway to the project
1 Use the mouse to select DEFAULT MODULE in the tree view, and then click the
right mouse button to open a shortcut menu.
2 On the shortcut menu, choose C
Choose Module Type
dialog box.
HOOSE MODULE TYPE. This action opens the
3 In the Product Line Filterarea of the dialog box, select the appropriate
product type radio button.
4
In the STEP 1: Select Module Type dropdown list, select the model number
that matches your gateway, and then click OK
return to the
PCB Main window.
to save your settings and
Page 14 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway Start Here
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
1.4.2 Renaming PCB Objects
Notice that the contents of the information pane and the configuration pane
changed when you added the gateway to the project.
At this time, you may wish to rename the Default Project and Default Location
folders in the tree view.
To rename an object
1 Select the object, and then click the right mouse button to open a shortcut
menu. From the shortcut menu, choose R
ENAME.
2 Type the name to assign to the object.
3 Click away from the object to save the new name.
1.4.3 Configuring Module Parameters
1 Click on the [+] sign next to the gateway icon to expand gateway information.
2 Click on the
configuration options.
3 Double-click any
4 To edit a parameter, select the parameter in the left pane and make your
changes in the right pane.
5 Click OK
[+]sign next to any icon to view gateway information and
icon to open an Edit dialog box.
to save your changes.
ProSoft Technology, Inc. Page 15 of 159
August 6, 2010
Start Here IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
1.4.4 Creating Optional Comment Entries
1 Click the [+] to the left of the icon to expand the module
comments.
2 Double-click the
appears.
icon. The Edit - Module Comment dialog box
3 Enter your comment and click OK
to save your changes.
1.4.5 Printing a Configuration File
1 Select the gatewayicon, and then click the right mouse button to open a
shortcut menu.
2 On the
View Configuration window.
3 On the View Configuration window, open the F
This action opens the Print dialog box.
4 On the Print dialog box, choose the printer to use from the drop-down list,
select printing options, and then click OK.
shortcut menu, choose VIEW CONFIGURATION. This action opens the
ILE menu, and choose PRINT.
Page 16 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway Start Here
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
1.4.6 Using the CommonNet Data Map
The Data Map section allows you to copy data between areas in the gateway's
internal database.
You can copy a maximum of 100 registers per Data Map command, and you can
configure a maximum of 200 separate copy commands.
You can copy data from the error or status tables in upper memory to internal
database registers in the User Data memory area.
You can rearrange the byte and/or word order during the copy process. For
example, by rearranging byte or word order, you can convert floating-point values
to the correct format for a different protocol.
You can also use the Data Map to condense widely dispersed data into one
contiguous data block, making it easier to access.
ProSoft Technology, Inc. Page 17 of 159
August 6, 2010
Start Here IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
From Address
0 to highest Status Data address
This field specifies the beginning internal database register address for the copy
operation. This address can be any valid address in the User Data Area or the
Status Data Area of the gateway.
To Address
0 to 3999
This parameter specifies the beginning destination register address for the copy
operation. This address must always be within the User Data registers area.
Take care to specify a destination address that will not overwrite data that has
been stored in memory by one of the communication protocols running on the
gateway.
Register Count
1 to 100
This parameter specifies the number of registers to copy.
Swap Code
NO CHANGE, WORD SWAP, WORD AND BYTE SWAP, BYTE SWAP
You may need to swap the order of the bytes in the registers during the copy
process in order to change the alignment of bytes between dissimilar protocols.
This parameter is helpful when dealing with floating-point or other multi-register
values, as there is no standard method of storage of these data types in slave
devices.
Page 18 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway Start Here
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
The following table defines the values and their associated operations:
Swap Code Description
No Swap No change is made in the byte ordering (1234 = 1234)
Word Swap The words are swapped (1234=3412)
Word and
Byte Swap
Bytes The bytes in each word are swapped (1234=2143)
The words are swapped, then the bytes in each word are swapped (1234=4321)
ProSoft Technology, Inc. Page 19 of 159
August 6, 2010
Start Here IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
Delay Preset
This parameter sets an interval for each Data Map copy operation. The value you
put for the Delay Preset is not a fixed amount of time. It is the number of firmware
scans that must transpire between copy operations.
The firmware scan cycle can take a variable amount of time, depending on the
level of activity of the protocol drivers running on the ProLinx gateway and the
level of activity on the gateway's communication ports. Each firmware scan can
take from 1 to several milliseconds to complete. Therefore, Data Map copy
operations cannot be expected to happen at regular intervals.
If multiple copy operations (several rows in the Data map section) happen too
frequently or all happen in the same update interval, they could delay the process
scan of the gateway protocols, which could result in slow data updates or missed
data on communication ports. To avoid these potential problems, you should set
the Delay Preset to different values for each row in the Data Map section and set
them to higher, rather than lower, numbers.
For example, Delay Preset values below 1000 could begin to cause a noticeable
delay in data updates through the communication ports. And you should not set
all Delay Presets to the same value. Instead, use different values for each row in
the Data Map such as 1000, 1001, and 1002 or any other different Delay Preset
values you like. This will prevent the copies from happening concurrently and
prevent possible process scan delays.
Page 20 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway Start Here
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
1.4.7 Downloading the Project to the Module
For the gateway to use the settings you configured, you must download (copy)
the updated Project file from your PC to the gateway.
To Download the Project File
1 In the tree view in ProSoft Configuration Builder, click once to select the
gateway.
2 Open the P
program will scan your PC for a valid com port (this may take a few seconds).
When PCB has found a valid COM port, the Download
ROJECT menu, and then choose MODULE/DOWNLOAD. The
dialog box will open.
3 Choose the COM port to use from the
D
OWNLOAD button.
dropdown list, and then click the
The gateway will perform a platform check to read and load its new settings.
When the platform check is complete, the status bar in the Download
box will display the message Module Running.
dialog
ProSoft Technology, Inc. Page 21 of 159
August 6, 2010
Start Here IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
Page 22 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway 101S Protocol Configuration
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
2 101S Protocol Configuration
In This Chapter
[IEC-870-5-101 Port 0] .......................................................................... 24
Group Codes ......................................................................................... 50
ProSoft Technology, Inc. Page 23 of 159
August 6, 2010
101S Protocol Configuration IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
2.1 [IEC-870-5-101 Port 0]
This section provides information required to configure a slave application with
the gateway.
2.1.1 Enabled
YES or NO
Enables or disables the primary port. If the port is not enabled (No), then the
gateway will not use the port. If the port is enabled (Yes), the gateway will
emulate an IEC 60870-101 slave device on the port.
2.1.2 Time DB Offset
-1, or 0to 3994
This parameter defines the location in the database where the time maintained
for the IEC protocol is copied. This time is updated whenever a time
synchronization command is received from the host and continually as the
program runs. If the parameter is set to -1, the time will not be placed in the
database.
Page 24 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway 101S Protocol Configuration
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
2.1.3 Disable Time Sync Events
YES orNO
This feature can be used when the Master receives the event timestamp with
only minutes and milliseconds information for each event message (CP24 time
type). If the parameter is set to N, the spontaneous time sync events will be
generated to indicate the change of hour. If this parameter is set to Y, then the
spontaneous time sync event messages are not generated to indicate the
change of hour.
2.1.4 Data Link Address Value
0 to65535
This parameter defines the Data Link Address for the emulated device on the
gateway. This address identifies the gateway on the network along with the
common address of ASDU.
2.1.5 Data link address length
0, 1, or 2
This parameter specifies the number of octets used for the data link address.
This parameter must be set the same for all devices on the network. A value of 0
is only valid when the balanced mode is used. If unbalanced mode is used, a
value of 1 or 2 must be used.
2.1.6 Common Address of ASDU Val
0to 65535
This parameter specifies the common address of the ASDU (section address) for
access to data in the gateway. There is only one value entered for access to all
data in the gateway.
Refer to ASDU Configuration for more information on Application Service Data
Unit configuration.
2.1.7 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.
ProSoft Technology, Inc. Page 25 of 159
August 6, 2010
101S Protocol Configuration IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
2.1.8 Inform. Object Address Len
1, 2, or 3
This parameter specifies the number of octets used to define the address of an
information object (point address).
2.1.9 Cyclic Data Transmission
0 to 4,294,967,296 (2 raised to the power of 32) milliseconds
This parameter defines the number of milliseconds between cyclic updates. The
range of values allow for update times between 1 millisecond and 49.7 days. Set
this parameter to 0 to disable cyclic data reporting.
2.1.10 Select/Operate Timeout
0 to 4,294,967,296 (2 raised to the power of 32) milliseconds
This parameter sets the number of milliseconds to wait for a valid Execute
command after receiving a Select command. The range of values allows for
update times between 1 millisecond and 49.7 days. Set this parameter to 0 to
disable this feature.
2.1.11 Use ACTTERM with Set Point
Y - YES or N - NO
This parameter determines if an ACTTERM will be sent. If the parameter is set to
Y
ES, then set point commands will issue an ACTTERM when the command is
complete. If the parameter is set to N
O, ACTCON is the last response to a set
point command.
2.1.12 Use ACTTERM with Step
Y - YES or N - NO
This parameter determines if an ACTTERM will be sent. If the parameter is set to
Y
ES, then step commands will issue an ACTTERM when the command is
complete. If the parameter is set to N
O, ACTCON is the last response to a step
command.
2.1.13 Single char ACK F0, 1 or 3
Y-YES or N-NO
If set to Yes, 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 No, the fixed
length ACK will be sent.
Page 26 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway 101S Protocol Configuration
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
2.1.14 Single char ACK C1 or C2
Y-YES or N-NO
If set to Yes, a single character ACK (0xE5) will be sent instead of a fixed length
NACK (secondary function code 9) when no response user data is available. If
set to No, the fixed length NACK will be sent.
2.1.15 Maximum ASDU Resp Len
25 to 252
Sets the maximum ASDU response message length (usually 252).
2.1.16 Cause of Trans(mission) Octets
1 or 2
Specifies the number of COT octets (1 or 2)
2.1.17 Freeze Start Type
D=DAY,H=HOUR,M=MINUTE,N=NOT USED
The Freeze Start Type parameter defines when the gateway starts sending the
M_IT messages.
ProSoft Technology, Inc. Page 27 of 159
August 6, 2010
101S Protocol Configuration IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
Example I - Freeze Start Type
If the gateway should send the counter points on the hourly turn around time and
also 45 minutes later, the Mode A parameters should be configured as follows:
So the gateway would send events as follows (Hours:Minutes:Seconds):
The following illustration shows a typical communication example when the Mode
A is selected during unbalanced mode operation:
Page 28 of 159 ProSoft Technology, Inc.
August 6, 2010
IEC-101 Slave ♦ ProLinx Communication Gateway 101S Protocol Configuration
IEC 60870-5-101 v3 Slave (Firmware version 3.xx) Protocol Manual
Example II - Freeze Start Type
If the gateway powers up with the following date and time settings on its internal
clock:
03/25/2004 18:07:42
And if you configure the Interval For Freeze parameter to 15 seconds, as follows:
The Freeze Start Type parameter determines when the gateway will begin
sending these messages, as follows:
If the Freeze Start Type is set to: Then Messages will start being sent at:
D 03/26/2004 00:00:00 and every 15 seconds thereafter
H 03/25/2004 19:00:00 and every 15 seconds thereafter
M 03/25/2004 18:08:00 and every 15 seconds thereafter
Once message transmission begins, the gateway will freeze and transmit counter
values at whatever interval has been configured using the Interval For Freeze
parameter. In this example, that would be every 15-seconds.
2.1.18 Interval for Freeze
0 to 65535seconds
Freeze Start Type and Interval for Freeze are used if Mode A operation is to be
used for the counter freeze operation. If they are not used, the gateway will
operate in Mode D.
ProSoft Technology, Inc. Page 29 of 159
August 6, 2010
101S Protocol Configuration IEC-101 Slave ♦ ProLinx Communication Gateway
Protocol Manual IEC 60870-5-101 v3 Slave (Firmware version 3.xx)
2.1.19 Set Priority Queues
YES or NO
This section defines priority queues for the gateway. You can assign priorities to
data types that return events so that events of some data types will be returned
before events of other data types. If this feature is utilized, each data type must
be assigned a unique index from 0 to 7. The lower the index, the higher the
priority (0=highest priority, 7=lowest priority).
Events of ASDUs with lower numbers will be reported before events from other
ASDUs with higher numbers.
Note: In some configurations, depending on the total number of events generated for all data
types, setting priorities may cause some events to be lost, as the event buffers for low priority
queues may overflow before their events can be reported.
For more information, refer to Event Priority (page 31).
Page 30 of 159 ProSoft Technology, Inc.
August 6, 2010
Loading...
+ 129 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.