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.
ProSoft Technology ®, ProLinx ®, inRAx ®, ProTalk ®, and RadioLinx ® are Registered Trademarks of ProSoft
Technology, Inc. All other brand or product names are or may be trademarks of, and are used to identify products
and services of, their respective owners.
ProSoft Technology® Product Documentation
In an effort to conserve paper, ProSoft Technology no longer includes printed manuals with our product shipments.
User Manuals, Datasheets, Sample Ladder Files, and Configuration Files are provided on the enclosed CD-ROM in
Adobe® Acrobat Reader file format (.PDFs). These product documentation files may also be freely downloaded from
our web site: www.prosoft-technology.com
Important Installation Instructions
Power, Input, and Output (I/O) wiring must be in accordance with Class I, Division 2 wiring methods, Article 501-4 (b)
of the National Electrical Code, NFPA 70 for installation in the U.S., or as specified in Section 18-1J2 of the Canadian
Electrical Code for installations in Canada, and in accordance with the authority having jurisdiction. The following
warnings must be heeded:
WARNING - EXPLOSION HAZARD - SUBSTITUTION OF COMPONENTS MAY IMPAIR SUITABILITY FOR CLASS
I, DIV. 2;
WARNING - EXPLOSION HAZARD - WHEN IN HAZARDOUS LOCATIONS, TURN OFF POWER BEFORE
REPLACING OR WIRING MODULES
WARNING - EXPLOSION HAZARD - DO NOT DISCONNECT EQUIPMENT UNLESS POWER HAS BEEN
SWITCHED OFF OR THE AREA IS KNOWN TO BE NON-HAZARDOUS.
THIS DEVICE SHALL BE POWERED BY CLASS 2 OUTPUTS ONLY.
ProLinx® Products Warnings
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.
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.
Markings
Label Markings
<cULus>
E183151
Class I Div 2
Groups A,B,C,D T6
-30°C <= Ta <= 60°C
<Ex>
II 3 G
Ex nA IIC T4
-20°C <= Ta <= 50°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.
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.
ProSoft Technology, Inc. Page 11 of 139
August 4, 2011
Start Here 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
1.1 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 104C v3 Protocol Manual, please refer to
the ProLinx Reference Guide.
Page 12 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Start Here
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
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 Technology website
1 Open your web browser and navigate to http://www.prosoft-
technology.com/pcb
2 Click the link at the Current Release Version section to download the latest
version of ProSoft Configuration Builder.
3 Choose 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.
AVE
or S
AVE FILE
TILITIES
ETUP CONFIGURATION TOOL
EXE
file and follow the instructions on your screen to install the
when prompted.
RODUCT DOCUMENTATION
folder. This folder contains all of the applications
folder, double-click the
. This action opens a
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.2.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 C
ONTENTS
.
ProSoft Technology, Inc. Page 13 of 139
August 4, 2011
ELP
Start Here 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
Page 14 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
Printing a Configuration File .................................................................. 41
ProSoft Technology, Inc. Page 15 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
2.1 IEC 60870-5-104 Client Section
The IEC-104 Client section allows the user to setup the following features:
General Client driver parameters
Client parameters to access each remote server (up to four)
Monitored data configuration to receive data from remote servers
Command (control) data configuration to send data to remote servers
SNTP client parameters for clock update
Page 16 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
2.1.1 [SNTP CLIENT]
The [SNTP CLIENT] section of the configuration (.CFG) file or of the PCB
configuration is used to specify the parameters for the Simple Network Time
Protocol (SNTP) Client provided with the protocol driver. The Client is required in
order to keep the driver's internal clock set correctly. This version of the driver
supports SNTP Revision 3 and stratum between 1 and 14.
The updated time and date information is used when sending clock
synchronization commands to remote IEC-60870-5-104 servers.
SNTP is used for time synchronization of produced and consumed commands.
When an exchange occurs, the driver compares time stamps from the previous
exchange. When the new exchange time is less than the previous exchange, the
exchange is ignored. This can occur when the Ethernet packets are routed and
delayed. Time synchronization provides for data integrity.
As Seen in the Configuration (.CFG) File
# This section used to define the parameters required for the Simple Network
Time
# Protocol (SNTP) client.
[SNTP CLIENT]
#SNTP SERVER IP ADDRESS : 132.163.4.102 #IP address for NIST, Boulder,
Colorado
SNTP SERVER IP ADDRESS : 0.0.0.0 #IP Address for SNTP Server
TIME ZONE : 8 #Number of hours from GMT (-11 to
+11)
USE DAYLIGHT SAVINGS TIME : No #Yes or No
DATABASE REGISTER : 3000 #database word location to store
time
#(-1=ignore). This register value should
#be an even number.
ProSoft Technology, Inc. Page 17 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
As Seen in PCB
The SNTP driver will compute a new clock value every 5 minutes using the
average value of 10 samples each collected over an approximate 6-second
period. This new value will be used to adjust the clock maintained by the SNTP
driver and used by the application. If a valid database register is specified, the
driver will place the time value into the module's database. The first two registers
will contain the number of seconds and the next two registers will contain the
number of microseconds since January 1, 1970.
A list of some of the common SNTP servers can be obtained at
http://www.ntp.org/
or, http://support.ntp.org/bin/view/Servers/WebHome
Other server lists can be found by searching the World Wide Web for SNTP
Servers.
SNTP Server IP Address
Enter in dotted notation
This parameter sets the IP address of the SNTP server to utilize for time
acquisition. Select an SNTP server with the greatest accuracy that can be
accessed all the time from your network. Setting this IP address to 0.0.0.0
disables SNTP server requests.
Page 18 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
Time Zone
-11 to 11
This parameter specifies the time zone offset to be used from the UTC time
zone. A value of zero uses UTC time. If the value entered is positive, the time
zone is west of the UTC time zone (for example, Eastern Standard Time is 5). If
the value entered is negative, the time zone is east of the UTC time zone (for
example, Continental Europe is -1).
Use Daylight Savings Time
YES or NO
This parameter specifies if daylight savings time will be used in the time
computation.
Database Register
-1 or 0 to 3996 as an even value
This parameter specifies if the NTP time computed by the driver is to be placed
into the module’s database. If a value of -1 is specified, the time will not be
placed into the database. If the value is between 0 and 3992, the time will be
placed in the database. The first 4 bytes will represent the seconds since
1/1/1970, and the second 4 bytes will represent the number of microseconds. An
even value should be used for the register value in order for the data to be stored
correctly.
2.1.2 [IEC-870-5-104]
This section provides the parameters required for general driver configuration.
Most entries contained within this section are self-explanatory.
ProSoft Technology, Inc. Page 19 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
Time DB Offset
-1 or 0 to 3994
This parameter sets the location in the database where the gateway’s 104C Client date and time will be copied to.
Note: The following table lists the 12-byte data area placed in the database if the Time DB Offset
parameter is set to a value other than -1:
Byte Length Range Description
0 to 1 2 0 to 59,999 Seconds and milliseconds
2 1 0 to 59 Minutes
3 1 0 to 23 Hour
4 1 Reserved
5 1 1 to 31 Day of the month
6 1 1 to 12 Month
7 to 8 2 0 to 65,535 Year (four-digit format, for example 2005)
9 1 Reserved
10 1 0 or 1 Invalid flag (0 = Valid, 1 = Invalid)
11 1 Reserved
Driver Status Offset
0-3982
Database location of general client driver status data
Disable = -1
Refer to section 6.3 (Server Error and Status Data) for the detailed contents of
the status block.
NOTE: requires 18 registers
Mailbox Offset
0 - 3872
Database offset to the mailbox interface area. This feature is applicable to the
5201-DFNT-104C module. The mailbox allows the DFNT driver to request
specific tasks from the 104 driver such as time update and dynamically sending
commands
Disable = -1
Refer to section 4 (Mailbox feature) for further information about the mailbox
functionality.
The mailbox interface requires 128 database registers.
Page 20 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
Pass-Through Events
This parameter specifies if spontaneous event messages received from the
servers will be passed to the mailbox interface. If the parameter is set to N,
event messages will not be passed to the mailbox interface. If the parameter is
set to Y, the driver will pass all events received to the mailbox interface using
mailbox identifier 9903 & -9903. The Mailbox Interface should be enabled by
setting a valid value for "Mailbox Offset" if this feature is utilized.
2.1.3 [IEC-60870-5-104 Client x]
Server IP Address
IP address of the remote server that will be connected to this client
Sector Count - 1 to 2
1 to 2
This parameter sets the number of Sectors (separate databases or Multiple
Application Layer ASDU addresses) contained in this Session (controlled
device). This version of the application supports 1 to 2 sectors for each
Client/session.
ProSoft Technology, Inc. Page 21 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
t0 Connection Timeout
1 to 30, default value = 30
This is a timeout value, in seconds, to determine if a connection has been lost
with the remote server. If no traffic from the remote server is received for the
period of time specified by this parameter, the currently open IP socket
connection will be closed. The connection can be re-established by the Client by
opening a new connection.
t1 Timeout Set Value
1 to 255 DEFAULT VALUE = 15
This is the timeout of send or test ASDUs and is in units of seconds. After a
packet is sent from the unit, the server must acknowledge the packet within this
time interval or else the unit will close the connection.
t2 Timeout Set Value
1 to 255 DEFAULT VALUE = 10
This is a timeout of when to send an S-format message to the host to
acknowledge outstanding messages received. This parameter is in units of
seconds and must be less than the value set for t1.
t3 Timeout Set Value
1 to 255 DEFAULT VALUE = 20
This is the timeout to wait on an idle line before the unit will send a TestFr.Act
message. This value is in units of seconds.
k (maximum queue)
1 to 20 DEFAULT VALUE = 6
This parameter specifies the number of unacknowledged messages the unit will
buffer. This parameter must match that in the server. If the set number of buffers
is filled in the unit, no other messages will be sent until the server unit
acknowledges some or all the messages.
w (latest ack threshold)
1 to 20 DEFAULT VALUE = 4
This parameter must match that of the server unit and specifies the number of
messages the gateway will receive before sending an S-format sequence
acknowledge message when no I-format data is ready to send. It is
recommended to set this value to 2/3 the value of k.
Originator address for COT
0 to 255 DEFAULT VALUE = 1
This parameter sets the address to be passed with each message when the COT
Octet Count parameter is set to 2.
Page 22 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
Response Timeout
0 to 5000 milliseconds DEFAULT VALUE = 5000
This parameter sets the maximum number of milliseconds to wait for a
confirmation from the controlled station to a request from this module to
application level messages.
ACTTERM with Set Point
Y - YES or N - NO
This parameter determines if an ACTTERM (Activation Termination) will be sent.
If the parameter is set to YES, then Set point commands will issue an ACTTERM
when the command is complete. If the parameter is set to NO, ACTCON
(Activation Confirmation) is the last response to a Set point command.
Status Offset
Range -1 to 3956
Database location of client status data
Range = 0 - 3956
Disable = -1
(Refer to the status section for further information about the content of this
section).
NOTE: requires 44 registers
ProSoft Technology, Inc. Page 23 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
2.1.4 [IEC-60870-5-104 Client x Sector x] Parameters
Common ASDU Address
At the application level, the gateway is identified by the Common ASDU
(Application Service Data Unit) Address. This address must match the CASDU
sent at the server unit. An ASDU is a data unit that transfers information objects
between the Client and the server.
If the gateway sends a message to a different Common ASDU, the server should
ignore the command.
Online Time Sync
Yes or No
This parameter specifies if the sector in the server device will be sent a time
synchronization command when the server device 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 server will be sent a general
interrogation command when the unit is first recognized as being online.
Page 24 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
EOI Time Sync
Yes or No
This parameter specifies if the sector in the server device will be sent a time
synchronization command after this module received an EOI (End of
Initialization) message from the server device.
EOI General Int
Yes or No
This parameter specifies if the sector in the server will be sent a general
interrogation command after this module receives an EOI message from the
controlled unit.
ProSoft Technology, Inc. Page 25 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
2.1.5 [IEC-60870-5-104 Client x Sector y]
This section allows the user to associate the monitored data points to module
database. These points are sent from the remote server to the module. There
are 3 parameters for each point association that you create: Data Type, Point
Index, Database Address.
The data type must be selected among one of the following supported types. The
Point Index is the Information Object Address which identifies the point in the
network. The Database Address defines the gateway database location on
where the point value will be stored. The database address could be defined as
bit-addressing, byte addressing, word addressing or double-word addressing
depending on the data type.
For additional information on how to set these parameters, see the Reference
chapter of this manual. The following ASDU data types are supported:
Page 26 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
Monitor Single Point [M_SP_NA]
This section defines the Monitor Single-Point information object database.
Each information object (point) indicates one of two states, 1 = Bit On, 0 = Bit Off.
Each information object is one bit and the DB Address value corresponds to the
bit offset in the gateway memory database.
For additional information on how to set these parameters, see the Reference
chapter of this manual.
Monitor Double Point [M_DP_NA]
Each information object in the database can have one of four possible states, 00
= Intermediate, 01 = Off, 10 = On, and 11 = Intermediate.
Each information object is two bits and the DB Address value corresponds to the
bit offset in the gateway memory database.
Monitor Step Position [M_ST_NA]
Each information object is one 8-bit byte and the DB Address value corresponds
to the byte offset in the gateway memory database.
[M_BO_NA_1 104]
Each information object is four 8-bit bytes (two 16-bit words) and the DB Address
value corresponds to the double-word offset in the gateway memory database.
Monitor Normalized Measured [M_ME_NA]
Each information object is one 16-bit word and the DB Address value
corresponds to the word offset in the gateway memory database.
Monitor Scaled Measured [M_ME_NB]
Each information object is one 16-bit word and the DB Address value
corresponds to the word offset in the gateway memory database.
Monitor Short Floating-Point [M_ME_NC]
Each information object is two 16-bit words and the DB Address value
corresponds to the double-word offset in the gateway memory database.
Monitor Integrated Totals (Counter) [M_IT_NA]
Each information object is two 16-bit words and the DB Address value
corresponds to the double-word offset in the gateway memory database.
ProSoft Technology, Inc. Page 27 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
2.1.6 [IEC-60870-5-104 Client Commands]
Each row of this section allows the configuration of one command to be sent to
the remote server. The command can be either a control point (single point,
double-point, etc..) or a general command such as clock synchronization to a
specific client.
The following parameters must be configured for each command:
Enable Code
This field determines when the command will be executed according to the
following codes:
Value Description
Command is disabled and will only execute if enabled from mailbox interface (see mailbox
Disabled
Enabled with
Poll Interval Command will execute no more frequently than the time set in the Poll interval parameter
Conditional
interface for further details)
Command will execute when the last value read in the database differs from the current
value
Page 28 of 139 ProSoft Technology, Inc.
August 4, 2011
104C Version 3 ♦ ProLinx Gateway Configuring the Gateway
IEC 60870-5-104 Client (Firmware v3.xx) Protocol Manual
Database Address
The interpretation for the database address parameter will depend on the
selected data type. The database address value is only significant to the control
data types (single point, double-point, etc…).
Examples:
If you select single point command type the database address is interpreted as a
bit-address. For example, a value of 32 means bit 0 of database word 2.
If you select regulating step point command type the database address is
interpreted as a byte-address. For example, a value of 32 means byte 0 of
database word 16.
If you select measured scaled integer command type the database address is
interpreted as a word-address. For example, a value of 32 means database word
32
If you select measured scaled integer command type the database address is
interpreted as a double-word-address. For example, a value of 32 means
database word 16, For the other command types (clock synchronization, read
command, reset process command and test command) you can use the
database address to trigger the command upon data change. However the value
itself is not used within the command.
FIELD DESCRIPTION
This field specifies the location in the module's internal database to associate with
Database
Index used in the command determines addressing of the index 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 *Word address
101 Counter interrogation command *Word address
102 Read command *Word address
103 Clock synchronization command *Word address
105 Reset process command *Word address
107 Test command (IEC-870-5-104 type) *Word address
110 Parameter, normalized measured value Word address
111 Parameter, scaled measured value Word address
112 Parameter, short float value Float (double-word address)
113 Parameter activation command *Word address
*Word address = Value only used to signal when to send event (Enable Code = 2)
the command. The data type
ProSoft Technology, Inc. Page 29 of 139
August 4, 2011
Configuring the Gateway 104C Version 3 ♦ ProLinx Gateway
Protocol Manual IEC 60870-5-104 Client (Firmware v3.xx)
Poll Interval
This parameter is used if the Enable Code field is set as Enabled With Poll
Interval. It sets the minimum number of seconds to delay between successive
execution of the command.
Session
This parameter is utilized to associate the command with one of the
sessions/clients defined for the module.
Sector
This parameter is used to associate the command with the proper sector of the
selected session.
Data Type
This parameter is used to set the ASDU data type to be used with the message.
The codes specified are those defined for the IEC-870-5-101 protocol. The
following is a listing of command control data types supported in this module: