Professional Documents
Culture Documents
FOR
SCOPE
This document describes the features and operation of the Protocol Configuration Tool for WSOS.
LIMITATIONS
This document is copyright and is provided solely for the use of the recipient. It is not to be copied
in any way, nor its contents divulged to any third party, nor to be used as the basis of a tender or
specification without the express written permission of Schneider Electric (Australia) Pty Limited.
This document discloses confidential intellectual property that belongs to Schneider Electric
(Australia) Pty Limited. This document does not invest any rights to Schneider Electric (Australia)
Pty Limited intellectual property in the recipient. Moreover, the recipient is required not to disclose
any of the intellectual property contained in this document to any other party unless authorised in
writing by Schneider Electric (Australia) Pty Limited.
Internal: ^/WSOS/Documentation/WSOS5/WSOS01-DOC-102.doc
WSOS01-DOC-102R13 1
Protocol Configuration Tool
REVISION RECORD
2 WSOS01-DOC-102R13
Protocol Configuration Tool
CONTENTS
1. Introduction ......................................................................................................................................... 1
5.1. Adding DNP3, IEC60870-5-101/104 and Modbus Protocol to controller configuration ...... 24
5.2. Reading Existing DNP3, IEC60870-5-101/104 and Modbus Mappings from the Controller 25
5.4. Writing New DNP3/ IEC60870-5-101/104/Modbus Mappings into the Controller ............. 28
WSOS01-DOC-102R13
Protocol Configuration Tool
7. INDEX ..................................................................................................................................................... i
WSOS01-DOC-102R13
Protocol Configuration Tool
1. Introduction
The Protocol Configuration Tool allows WSOS users to generate custom DNP3, IEC60870-5-
101/104 and Modbus I/O mappings and load them into a switchgear device controller.
1.1. Scope
The Protocol Configuration Tool can only create mappings that are compatible with ADVC
software versions A41-03.xx or higher for DNP3 protocol maps, version A42-00.00 or higher for
IEC60870-5-101/104 protocol maps, version A43-00.00 or higher for Modbus protocol maps.
The Tool is available with WSOS version 5.1.0 or later and will work on Microsoft Windows 2000
and XP. The IEC60870-5-101/104 protocol is supported in WSOS version 5.10.02 onwards. The
Modbus protocol is supported in WSOS version 5.6.23 onwards.
Note: A full description of the manufacturer’s DNP3 implementation is available in the “DNP3
Protocol Technical Manual for Advanced Controllers”, Part Number ADC01-DOC-146. The
corresponding description of the IEC60870-5-101/104 protocol is available in ADVC IEC 60870-5-
101/104 Protocol Technical Manual”,. The corresponding description of the Modbus protocol is
available in “MODBUS Protocol Technical Manual for ADVC Controller Range”, Part Number
ADC01-DOC-357. It is important to read these documents before attempting to create protocol
mappings with this tool. A copy of this manual can be viewed by selecting “Help -> Tech Manual”
from the Tool menu.
2. Overview of Protocol Configuration
The types of actions that can be mapped are dependent on the software version loaded in the
Switchgear Device’s controller. When the tool is started the user is asked to input the software
version. This is then used to retrieve a valid set of points to use when constructing mappings
within the tool.
The protocol configuration tool is intended to be used Off-Line only. Mappings are created, saved
and linked to a WSOS switchgear device configuration while disconnected from the switchgear.
Once these tasks have been completed the user connects to the device and writes the new
mapping into the controller along with the switchgear device configuration.
Warning: Make sure the Tool is closed after a mapping has been edited. If the Tool is left open while the
Automatic Data Retrieval feature is running it may attempt to update a mapping file that is already open in
the Tool. This will either cause the read operation to fail or result in a situation where the newly read file
differs from the file open within the Tool.
2 WSOS01-DOC-102R13
Protocol Configuration Tool
After entering these details click the “OK” button to open the blank file.
Note: Default values that appear in the version information boxes are the latest version supported
by WSOS. There is no upper limit on the minor version and cut version numbers of the maps.
However the protocol points supported/available in the WSOS is limited by the default version
number.
The following warning is displayed if the entered version is greater than the supported version
3 WSOS01-DOC-102R13
Protocol Configuration Tool
4 WSOS01-DOC-102R13
Protocol Configuration Tool
The new filename is limited to 40 characters. This limitation is to make it compatible with the
naming convention used within the switchgear controller. Allowed characters in a file name are A-Z
a-z 0-9 [] space !@#$%^()_+-={}';., and `.
5 WSOS01-DOC-102R13
Protocol Configuration Tool
Note: The Tool expects files to be located in a particular directory on the hard drive. If the file is
saved in an alternative location it will not be listed in the File Options dialog box when opening
existing files. Refer to section 6.1 for further details.
Protocol Point
Insert Point Inserts a new row at the current cursor
position on the grid so that a new point can be
added to the protocol map.
Delete Point Deletes a row at the current cursor position on
the grid shifting rows in the table below the
deleted point upwards. (New row added to the
end of the grid).
DNP
Binary Inputs Lists the Binary Inputs used in the mapping.
Analog Inputs Lists the Analog Inputs used in the mapping.
Counters Lists the Counters used in the mapping.
Binary Outputs Lists the Binary Outputs used in the mapping.
Analog Outputs Lists the Analog Outputs used in the mapping.
IEC60870-5-101/104
Binary Singles Lists the Binary Inputs used in the mapping.
Measured Values Lists the Analog Inputs used in the mapping.
Set Point Commands Lists the Set Point commands used in the
mapping.
Single Commands List of single commands used in the mapping
Integrated Totals List of Integrated totals used in the mapping
Binary Doubles List of binary doubles in the mapping
Double commands List of double commands used in the mapping
MODBUS
Binary Inputs Lists the Binary Inputs used in the mapping.
Analog Inputs Lists the Analog Inputs used in the mapping.
Binary Outputs Lists the Binary Outputs used in the mapping.
Analog Outputs Lists the Analog Outputs used in the mapping.
6 WSOS01-DOC-102R13
Protocol Configuration Tool
3.3.2. Toolbar
Below the menu is a tool bar with two buttons with icons and three or five buttons depending on
which protocol map you are configuring. The buttons with the icons are used to launch the
input/output Configuration Toolbox and Upgrade Software Version dialog.
Figure 5: Toolbars
7 WSOS01-DOC-102R13
Protocol Configuration Tool
Note: A full points list is available in HTML format by selecting “Protocol Configuration Tool Help -
> Points List” from the Tool’s menu.
3.4. Upgrading Software Versions
This feature allows the user to take advantage of additional features that may be available when
the controller software version has been upgraded to a later version. Clicking this button will have
the effect of making extra points available in the configuration toolbox for creating mappings.
The Upgrade Software Version button will only be activated if the Tool detects that the software
version actually loaded in the controller from which the mapping has been read, is greater than the
software version stored within the mapping. In all other cases it will be de-activated.
8 WSOS01-DOC-102R13
Protocol Configuration Tool
Warning: If a mapping is upgraded to a newer software version it will then be incompatible with
other switchgear devices running older software. Make sure the software version you are
upgrading to is compatible with all other switchgear devices you wish to use the mapping in before
upgrading. If the mapping software version is incompatible you will not be able to write it into the
switchgear.
9 WSOS01-DOC-102R13
Protocol Configuration Tool
Points are added by selecting a row on one of the tabbed pages then double clicking or dragging a
point from the Configuration Toolbox. If a row is not selected, the point will either be entered at the
end of the table.
Points are deleted by right-clicking on the Address column of the row and selecting “Delete” from
the right-click menu or by selecting “Edit -> Delete Point” from the menu. The Delete function can
also be accessed by Protocol Configuration Tool >> Protocol Point 1>> Insert Point A a blank row
can be inserted by right clicking on the Address column of the row and choosing “Insert”. The
insert function can also be access by Protocol Configuration Tool >> Protocol Point >> Insert
Point. A blank point represents a reserved or unused DNP Address, IEC 101/104 Address or
Modbus point. Its value is defaulted to zero.
All point supported by the WSOS will be visible in the point list. Points that are introduced after the
version of the map are not allowed to be used in the map.
4.1. Binary Inputs and Binary Singles
Attributes of Binary status points are described below. Binary status points are configurable under the tab
Binary Singles in IEC 101/104 and under “Binary inputs” for all other protocols.
10 WSOS01-DOC-102R13
Protocol Configuration Tool
Figure 7: Binary Input Tab (For DNP3, IEC 101/104 & Modbus protocols respectively)
11 WSOS01-DOC-102R13
Protocol Configuration Tool
12 WSOS01-DOC-102R13
Protocol Configuration Tool
Figure 8: Analog Input Tab for DNP3, IEC101/104 and Modbus protocols.
13 WSOS01-DOC-102R13
Protocol Configuration Tool
Range: 0, 1, 2, 3.
See section 6.2.1 for a description of Classes in DNP3.
See ADVC IEC 60870-5-101/104 Protocol Technical Manual for details of Classes for IEC
Protocol Min The minimum returnable value for the analog input. For DNP3 and IEC 101/104,
the default value displayed is determined by the “Return Min”, “Resolution” and
Multiplier” values listed in the Configuration Toolbox.
For Modbus, the default value displayed is determined by the “Point Min”,
"Multiplier", “Divisor” and “Conversion”.
This field is read-only. Its value will change if the “Multiplier” is modified.
Protocol Max The maximum returnable value for the analog input. For DNP3 and IEC 101/104,
the default value displayed is determined by the “Return Min”, “Resolution” and
Multiplier” values listed in the Configuration Toolbox.
For Modbus, the default value displayed is determined by the “Point Max”,
"Multiplier", “Divisor” and “Conversion”.
This field is read-only. Its value will change if the “Multiplier” is modified.
Multiplier For DNP3 and IEC 101/104, the multiplier is used to multiply/divide the reported
analog value by the amount entered. For example, a multipler of ten will divide the
protocol max, protocol min and deadband (protocol units) relative to a multiplier
of 1. For example, a multiplier of 10 given an initial multiplier of 1 will divide the
values by 10. A multiplier of 10 given and initial multiplier of 100 will multiply the
values by 10.
For Modbus, the multiplier is used to multiply the reported analog value by the
amount entered. Entered value will be converted to an integer, if the conversion
fails 1 will be used. The range for multiplier is between 1 and 32767 (inclusive).
For IEC 60870-5-101/104 the allowed range for multiplier is between 0.1 and
32767 (inclusive). This column allows a maximum of one decimal point.
For DNP3 the allowed range for multiplier is between 0.001 and 32767 (inclusive).
This column allows a maximum of 9 effective digits.
Divisor This is only used in Modbus. The divisor is used to divide the reported analog value by the
amount entered. Entered value will be converted to an integer, if the conversion
fails 1 will be used. The range for divisor is between 1 and shown protocol
max value (inclusive).
Units Displays the units represented by the point such as Amps, kVA and Volts.
This field is read-only and cannot be changed.
Deadband the change in value required to stimulate a points ‘change of state’ status. Right
click the column heading to select protocol or engineering unit dead-bands.
Modbus does not use a dead-band.
Deadband (Eng Units) Displays the deadband value for the point in engineering units with reference to the
Point Min and Point Max values.
14 WSOS01-DOC-102R13
Protocol Configuration Tool
Comment Used to add descriptive comments about the point. The comment is saved to the
mapping file when saved but is not written into the controller.
Normalisation Max IEC670870-5-101/4 grid provides two views for the maps older than A44-16.06.
Scaled view and Normalised view. The views are selected using the
Scaled/Normalised dropdown that appears at the right hand side end of the
protocol toolbar. When in normalised view a “Norm Max Eng-Units” column
appears. The values for normalisation max for each point can be specified in this
column. This value takes effect when the data type is configured as Normal from
the IEC670870-5-101/4 Data Configuration dialog. For the details of how
normalised values are calculated based on engineering values and normalisation
max values please refer the IEC670870-5-101/4 technical manual. For details
regarding normalised data type please refer to the IEC670870-5-101/4 Protocol
Standard document. Point specific normalisation is supported only for the map
files newer than A44-16.06. WSOS 5.10.02 and later provides three new input
fields for global normalisation values for Currents, Voltages and Power. These new
fields are added in IEC670870-5-101/4 Data Configuration dialog. Please see the
section 6.5 for more details. The normalisation max column is made visible by
selecting the “Normalised” item from the Scaled/Normalised
15 WSOS01-DOC-102R13
Protocol Configuration Tool
Comment Used to add descriptive comments about the point. The comment is saved to the mapping
file when saved but is not written into the controller.
Group Represents the interrogation group associated with the point. Please see the IEC101/104
Standard documents for more details
Configurable Protocol Mapping file version A45-42.00+ on ADVC controllers, for IEC101-104 SCADA
protocols have two additional configuration columns for ‘Integrated Totals’, ‘Integration Time’, and
‘Integration Action’.
Integration Time
When set to zero (0) the associated information object operates in an IEC Mode-D
integrated total (default-behaviour). A non-zero integration time makes the associated
information object function as an IEC Mode-A integrated total.
A setting of the integrated time period of between 1 (one) and 720 hours may be set.
The first integration period starts when the controllers clock (time/date) transitions the
next o’clock hour, e.g. 09:00AM, following the time period being made active, i.e. by
writing the configurable protocol mapping file to the controller, or the IEC protocol
process being warm/cold-started.
Integration Action
The Integration Action (FREEZE, or FREEZE and RESET) is carried out when the integration
time period (whole hours) has elapsed since the initial integration o’clock start time (and
every multiple of ‘Integration Time’ thereafter).
The Integration Action is performed upon the information object, and the integrated ‘data-
value’ is made available to the controlling station by a ‘spontaneous’ event.
For further information refer to section 7.4.8 of the “IEC 60870-5-101” standard,
and the “ADVC IEC 60870-5-101/104 Protocol Technical Manual”.
17 WSOS01-DOC-102R13
Protocol Configuration Tool
Figure 10: Binary Output Tab for DNP3, IEC101/104 & Modbus protocols
Comments Used to add descriptive comments about the point. The comment is saved to the mapping
file when saved but is not written into the controller.
Additional Columns for IEC 101/104
No Additional Definition Sets the “No additional Definition” parameter for the point.
Select Before Execute Sets the “Select Before Execute” parameter for the point.
19 WSOS01-DOC-102R13
Protocol Configuration Tool
Behaviour of invert column will depend on whether the point is made of duplicate points or distinct points.
The invert tick boxes of a double point made of duplicate single points cannot have same values. When the
invert of one point is changed the invert of the other toggles.
If the double point is made of distict single points then the invertcheck boxes are independent of each
other.
Creating a double point with distinct points
When a point is double clicked or dragged into the grid from the configuration tool box by default a double
point is created by duplicating both the lines with that points. One can assign a binary single point to either
of the two lines of the double point to make a double point with distinct point
20 WSOS01-DOC-102R13
Protocol Configuration Tool
For example follow the following steps to create a double point with “Switchgear tripped” and “Switchgear
Opened”.
Step1: Double click/drag drop switchgear tripped
Step2: Drag and Drop another point to one of the lines. Selecting a point-line and double clicking on a point
in Configuration Tool Box has the same effect
Resulting Point
21 WSOS01-DOC-102R13
Protocol Configuration Tool
22 WSOS01-DOC-102R13
Protocol Configuration Tool
Figure 11: Analog Output Tab for DNP3, IEC/101/104 & Modbus protocols
23 WSOS01-DOC-102R13
Protocol Configuration Tool
24 WSOS01-DOC-102R13
Protocol Configuration Tool
Make sure WSOS is On-Line. Select “Options -> Read Switchgear Settings from the Switchgear”
from the menu in WSOS. A message box will appear allowing the user to choose what information
to read from the switchgear controller. Tick the “Protocol Mapping” (or “DNP3 Mapping” if the
controller software version V41 or below) checkbox and enter a password when requested. Click
the “OK” button to start the read operation.
During a Switchgear Read the DNP3, IEC60870-5-101/104 or Modbus mapping will be written into
a file if the controller has valid mapping. The filename used will be the mapping name displayed on
the “DNP3 Point Configuration” status page and on the “IEC60870-5-101/104 Communications
Configuration” page and on the “Modbus Communications Configuration” page. If a file of this
name already exists in the WSOS DNPADVC directory it will only be overwritten if the mapping
itself is different from the one in the file.
Note: The comments within a mapping file are not written into the controller. Therefore overwriting
an existing file by reading a mapping from a controller will have the effect of wiping the comments
from the file.
After a read switchgear operation has been performed the resulting mapping file can be opened
and edited off-line using the Protocol Configuration Tool.
Note: Ticking Protocol mapping only reads the IO map. To read the controller IEC60870-5-
101/104 Settings, DNP3 settings or Modbus settings for transmission services, unsolicited,
communications, and database configuration then the Telecontrol tick box should also be
selected.
25 WSOS01-DOC-102R13
Protocol Configuration Tool
The “DNP3 Standard ACR” map is the default IO map. It reflects points that are available with
default settings in the controller. If a feature is made available via configuration then the user is
required to manually add any related points to the IO list as required
A “DNP3 Legacy 27-17 ACR” map is also available with the tool. It contains an IO map that
emulates PTCC V27-17 or newer DNP3 IO points list.
26 WSOS01-DOC-102R13
Protocol Configuration Tool
27 WSOS01-DOC-102R13
Protocol Configuration Tool
If the map is incompatible with the version of software currently loaded into the controller or if it is
in some way invalid, a warning message will appear and the write operation will be terminated.
Note: Ticking Protocol mapping only writes the IO map. To write to the
controller IEC60870-5-101/104/DNP3/Modbus settings for transmission
services, unsolicited, communications, and database configuration then
the Telecontrol tick box should also be selected.
28 WSOS01-DOC-102R13
Protocol Configuration Tool
6. Technical Appendix
6.1. File Locations
Protocol mapping filenames are also the map identification shown on the controller panel.
Filenames must therefore not be longer than 40 characters to conform to the filename length
restrictions within the controller.
Note: .D3M/.PTM/.MBM/.I101 files cannot be edited outside of the Tool. The tool retains a
checksum of the filename and contents. If it detects a difference then it rejects the map as corrupt.
6.2. DNP3 Term Glossary
6.2.1. DNP3 Classes
There are four classes in DNP3. These are defined as follows:
0 Class 0 is not an event class. It is used when reporting current (static) data values and not
change of state events.
Note: Setting a point to Class 0 will prevent the controller’s protocol handler from reporting
change of state events for that point to the master station. The point still remains
accessible through static data polls.
1 Class 1 is used to report high priority events. Events in this class take precedence.
2 Class 2 is used to report medium priority events.
3 Class 3 is used to report low priority events.
2. The invert parameter of double point is not supported in ADVC version A44-16.06 or
earlier. When a map older than that is operated the following warning is shown. The
behaviour of the check box is as usual but the values are discarded by ADVCs older than
A44-16.06
1.
29 WSOS01-DOC-102R13
Protocol Configuration Tool
Voltage: Value in Volts for normalisation max for all points under A_2.2
Current: Value in Amps for normalisation max for all points under A_2.1
Power : Value in KW for normalisation max for all points under A_2.3
30 WSOS01-DOC-102R13
Protocol Configuration Tool
7. INDEX
A
Analog Inputs....................................................................................................................................................12
Classes ................................................................................................................................................................1
Comments ........................................................................................................................................................11
i WSOS01-DOC-102R13
Protocol Configuration Tool
Counters ...........................................................................................................................................................16
Introduction........................................................................................................................................................1
Open ..................................................................................................................................................................5
Print....................................................................................................................................................................6
Save ...................................................................................................................................................................5
ii WSOS01-DOC-102R13
Protocol Configuration Tool
Save As .............................................................................................................................................................5
Toolbar ...............................................................................................................................................................7
iii WSOS01-DOC-102R13