Technical Manual For WSOS Protocol Configuration Tool
Technical Manual For WSOS Protocol Configuration Tool
Technical Manual For WSOS Protocol Configuration Tool
FOR
SCOPE
This document describes the features and operation of the Protocol Configuration Tool for
WSOS.
WSOS01-DOC-102
R11
80 Schneider Road
Eagle Farm 4009
Queensland
Australia.
Tel +61 7 3635 7500
Fax +61 7 3635 7560
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.
WSOS01-DOC-102R10
REVISION RECORD
Level
R00
R01
Date
18 June 2004
17 Oct 2004
Author
LM
LM
R02
R03
23 Nov 2004
25 Nov 2004
LM
LM
R04
22 Jun 2005
GC
R05
07 July 2005
VL
R06
17 Oct 2005
GC
R07
R08
30 March 2006
30 March 2006
GC
RDM
R09
8 July 2009
NCD
R10
R11
13 Jan 2010
30 Nov 2010
YM
VB
Comment
Created from N00-718R01
Updated for launch features, screen
shots, etc.
Updated screen shots again
Minor corrections as per document
review
New version of Protocol Configuration
Tool
Updated WSOS 5 sections to reflect new
changes
Protocol Configuration Tool merged into
WSOS with Analog Input changes
Minor changes to update document
Clarify Analogue Inputs Dead-bands
column.
Updated company name, address and
phone numbers.
Modbus
Added IEC changes and updated
screenshots to reflect the current version
of CPMT
WSOS01-DOC-102R10
CONTENTS
1.
2.
3.
4.
5.
6.
7.
Introduction ............................................................................................................................. 1
1.1.
Scope ........................................................................................................................... 1
Overview of Protocol Configuration....................................................................................... 1
Operation of Protocol Configuration Tool .............................................................................. 3
3.1.
Creating New Files...................................................................................................... 3
3.2.
Opening Existing Protocol Mappings ......................................................................... 4
3.3.
Deleting Existing Protocol Mappings ......................................................................... 4
3.4.
Main Interface ............................................................................................................. 5
3.4.1.
Menu Items...................................................................................................................5
3.4.2.
Toolbar .........................................................................................................................7
3.4.3.
Input/Output and Counter Tabs....................................................................................7
3.4.4.
Configuration Tool Box ...............................................................................................7
3.5.
Upgrading Software Versions ..................................................................................... 8
Creating a Protocol Mapping ................................................................................................ 10
4.1.
Binary Inputs and Binary Singles .............................................................................. 10
4.2.
Analog Inputs and Measured Values......................................................................... 12
4.3.
Counters and Integrated Totals.................................................................................. 16
4.4.
Binary Outputs and Single Commands ..................................................................... 18
4.5.
Double Commands.................................................................................................... 19
4.6.
Binary Doubles.......................................................................................................... 20
Example of a double point made of distinct points............................................................... 20
Creating a double point with distinct points.......................................................................... 20
Using Protocol Mappings in WSOS...................................................................................... 25
5.1.
Adding DNP3, IEC60870-5-101/104 and Modbus Protocol to controller
configuration ......................................................................................................................... 25
5.2.
Reading Existing DNP3, IEC60870-5-101/104 and Modbus Mappings from the
Controller .............................................................................................................................. 26
5.3.
Attaching Protocol Mappings to Switchgear Device Configurations ....................... 27
5.4.
Writing New DNP3/ IEC60870-5-101/104/Modbus Mappings into the Controller. 29
5.5.
Removing Protocol Mappings from the Controller................................................... 29
Technical Appendix ................................................................................................................ 1
6.1.
File Locations .............................................................................................................. 1
6.2.
DNP3 Term Glossary .................................................................................................. 1
6.2.1.
DNP3 Classes...............................................................................................................1
6.3.
DNP3 Specifications ................................................................................................... 1
6.4.
Special Behaviour of CPMT for IEC60870-5-101/104............................................... 1
6.5.
New parameters in IEC670870-5-101/4 Data Configuration dialog........................... 2
INDEX..................................................................................................................................... 3
WSOS01-DOC-102R10
1. Introduction
The Protocol Configuration Tool allows WSOS users to generate custom DNP3, IEC60870-5101/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 manufacturers 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-5101/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.
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.
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
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
Delete Point
DNP
Binary Inputs
Analog Inputs
Counters
Binary Outputs
Analog Outputs
IEC60870-5-101/104
Binary Singles
Measured Values
Set Point Commands
Single Commands
Integrated Totals
Binary Doubles
Double commands
Binary Inputs
Analog Inputs
Binary Outputs
Analog Outputs
MODBUS
Open in HTML
Protocol Configuration Tool Help
DNP3 Technical Manual
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.
DNP3 & Modbus Toolbar
Figure 5: Toolbars
Note: A full points list is available in HTML format by selecting Protocol Configuration Tool Help > Points List from the Tools menu.
Figure 7: Binary Input Tab (For DNP3, IEC 101/104 & Modbus protocols respectively)
Address
Name
Enabled
Gives the user the ability to deactivate a point in the protocol map without removing
the configured point. If the point is disabled, data for this point is still included in the
map when it is uploaded to the Remote Terminal Unit (RTU). The point will be
configured, however, the settings will have no effect on the RTU. This field is
unavailable in the Modbus protocol.
Class
The DNP3 or IEC 60870-5-101/104 class of the point. The default class can be
modified by selecting from the dropdown list. This field is unavailable in the
Modbus protocol.
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
Invert
Specifies whether the point will be inverted. If the point is inverted it will be
transmitted when the condition is false rather than true.
Range: Yes, No.
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 Column for IEC 101/104
Group
Figure 8: Analog Input Tab for DNP3, IEC101/104 and Modbus protocols.
Address
Name
By dragging a point from the configuration tool box into the cell.
Selecting the cell then double clicking a point in the configuration
toolbox.
Point Min
Point Max
Enabled
Class
configured, however, the settings will have no effect on the RTU. This field is
unavailable in the Modbus protocol.
The DNP3 or IEC 60870-5-101/104 class of the point. The default class can
be modified by selecting from the dropdown list.
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 and DNP3 the allowed range for multiplier is
between 0.1 and 32767 (inclusive). This column allows a maximum of one
decimal point
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
Deadband (Eng Units) Displays the deadband value for the point in engineering units with
reference to the Point Min and Point Max values.
Conversion
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.
Additional Columns for IEC 101/104
Group
Represents the interrogation group associated with the point. Please see the
IEC101/104 Standard documents for more details
Normalisation Max IEC670870-5-101/4 grid provides two views for the maps older than A4416.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
Name
Min
Max
Enabled
Gives the user the ability to deactivate a point in the protocol map without removing
the configured point. If the point is disabled, data for this point is still included in the
map when it is uploaded to the RTU. The point will be configured, however, the
settings will have no effect on the RTU.
Displays the units represented by the point such as Seconds and kWH.
This field is read-only and cannot be changed.
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.
Additional Column for IEC 101/104
Group
Represents the interrogation group associated with the point. Please see the
IEC101/104 Standard documents for more details
Figure 10: Binary Output Tab for DNP3, IEC101/104 & Modbus protocols
Address
Name
Enabled
Gives the user the ability to deactivate a point in the protocol map without removing
the configured point. If the point is disabled, data for this point is still included in the
map when it is uploaded to the RTU. The point will be configured, however, the
settings will have no effect on the RTU. This field is unavailable in the Modbus
protocol.
Pulse
Latch
Trip/Close
Sets whether the point will accept a Trip/Close command. This columns is replaced
by No Additional Definition in IEC60870-5-101/104.
Range: Yes, No. (DNP3 only)
Invert
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.
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
Figure 11: Analog Output Tab for DNP3, IEC/101/104 & Modbus protocols
Address
Name
Min
The minimum valid value that can be written to the analog output.
This field is read-only.
Max
The maximum valid value that can be written to the analog output.
This field is read-only.
Units
Displays the units represented by the point such as Amps, kVA and Volts.
This field is read-only and cannot be changed.
Enabled
Gives the user the ability to deactivate a point in the protocol map without removing
the configured point. If the point is disabled, data for this point is still included in the
map when it is uploaded to the RTU. The point will be configured, however, the
settings will have no effect on the RTU. This field is unavailable in the Modbus
protocol.
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.
Additional Columns for IEC 101/104
Select Before Execute
Sets the Select Before Execute parameter for the point.
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.
Note: Ticking Protocol mapping only reads the IO map. To read the controller IEC60870-5101/104 Settings, DNP3 settings or Modbus settings for transmission services, unsolicited,
communications, and database configuration then the Telecontrol tick box should also be
selected.
Note: Ticking Protocol mapping only writes the IO map. To write to the controller IEC60870-5101/104/DNP3/Modbus settings for transmission services, unsolicited, communications, and
database configuration then the Telecontrol tick box should also be selected.
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.
1.
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
7. INDEX
A
Add DNP3 Mapping Capability .........................................................................................................24
Analog Input Class .............................................................................................................................15
Analog Input Deadband......................................................................................................................16
Analog Input Return Max...................................................................................................................15
Analog Input Return Min ...................................................................................................................15
Analog Input Scale Factor ..................................................................................................................15
Analog Input Units .............................................................................................................................16
Analog Inputs .....................................................................................................................................13
Analog Output Max............................................................................................................................23
Analog Output Min ............................................................................................................................23
Analog Output Units ..........................................................................................................................23
Analog Outputs ..................................................................................................................................22
Attaching DNP3 Mappings to Switchgear Device Configurations ....................................................27
B
Binary Input Class ..............................................................................................................................12
Binary Inputs ......................................................................................................................................10
Binary Output Latch ...........................................................................................................................21
Binary Output Pulse ...........................................................................................................................21
Binary Output Trip/Close...................................................................................................................21
Binary Outputs ...................................................................................................................................19
C
Classes..................................................................................................................................................1
Comment ..........................................................................................................................16, 18, 21, 23
Comments...........................................................................................................................................12
Configuration Tool Box .......................................................................................................................7
Counter Max.......................................................................................................................................17
Counter Min .......................................................................................................................................17
Counter Units .....................................................................................................................................18
Counters .............................................................................................................................................17
Creating New Files...........................................................................................................................3, 5
D
Deleting Existing DNP3 Mappings......................................................................................................4
DNP ID.......................................................................................................................12, 14, 17, 20, 23
DNP3 Term Glossary ...........................................................................................................................1
F
File Locations .......................................................................................................................................1
I
Input Example ..............................................................................................................................12, 21
Introduction ..........................................................................................................................................1
Invert Binary Input .............................................................................................................................12
Invert Binary Output...........................................................................................................................21
M
Main Interface ......................................................................................................................................5
Menu Items...........................................................................................................................................5
N
New File ...............................................................................................................................................3
O
Open .....................................................................................................................................................5