0% found this document useful (0 votes)
212 views320 pages

SMP Gateway User Manual

Uploaded by

Kamale Kasa
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
212 views320 pages

SMP Gateway User Manual

Uploaded by

Kamale Kasa
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 320

MN912001EN, Version 38

SMP Gateway
User Manual
Notices
Contact and copyright information.
For use with version 8.1R2, or later, of the SMP Gateway Software and Tools.
All brand and product names appearing in this document are either trademarks or registered
trademarks of their respective holders.
© 2015-2020 Eaton – All rights reserved.

The information in this document is subject to change without notice.


Eaton's Energy Automation Solutions
1990 5th Street
Suite 220
Levis, Quebec, CANADA
G6W 5M6
Phone: 1.800.815.2258 (English support only)

Phone: 1.877.834.0009 (English and French support)

Fax: +1.514.227.5256

Web: http://www.eaton.com/smartgrid

Email: [email protected]

Technical Assistance: [email protected]


Table of contents
1. Welcome................................................................................................................................. 14
1.1. SMP Gateway automation platforms............................................................................ 14
1.2. Related documentation and software........................................................................... 15
1.3. Getting assistance........................................................................................................ 17
1.4. Getting started.............................................................................................................. 18
1.5. Overview....................................................................................................................... 18
2. Principles of operation......................................................................................................... 20
2.1. Logical architecture.......................................................................................................20
2.1.1. Masters and slaves.............................................................................................20
2.1.2. Introducing the SMP Gateway in the automation system...................................21
2.1.3. SMP Gateway internals...................................................................................... 21
2.1.4. Communications components.............................................................................22
2.2. Configuring the SMP Gateway..................................................................................... 23
2.2.1. The transparent SMP Gateway.......................................................................... 24
2.2.2. Using the SMP Gateway as a protocol translator...............................................26
2.2.3. Using the SMP Gateway as a data concentrator............................................... 27
2.2.4. Using the SMP Gateway as a communication processor...................................28
2.2.5. Putting it all together.......................................................................................... 29
2.2.6. Securing the substation...................................................................................... 30
3. SMP Tools overview............................................................................................................. 31
4. SMP Manager.........................................................................................................................33
4.1. Starting SMP Manager................................................................................................. 33
4.2. Main Window of SMP Manager....................................................................................34
4.3. Adding an SMP Device.................................................................................................34
4.4. SMP Manager polling mechanisms.............................................................................. 36
4.5. Information provided by the SMP Gateway icon.......................................................... 37
4.6. Customizing the display................................................................................................38
4.6.1. Adding or removing a column............................................................................ 39
4.6.2. Changing the position of a column.....................................................................39
4.6.3. Tree view display................................................................................................39
4.6.4. Searching for an SMP Device............................................................................ 40
4.6.5. Filtering SMP Devices displayed on SMP Manager...........................................41
4.7. Connecting with IED Manager Suite............................................................................ 41
4.8. The statuses of the SMP Gateway explained.............................................................. 44
Contents | ii

4.9. The statuses of the Local Configuration column explained.......................................... 48


4.10. Selecting the Web browser used by SMP Manager...................................................49
4.11. Changing the current login in SMP Manager..............................................................50
4.12. Restarting the SMP Gateway..................................................................................... 50
4.12.1. Forcing a safe mode restart............................................................................. 51
5. Configuring the SMP Gateway.............................................................................................52
5.1. Creating a configuration file..........................................................................................52
5.2. Saving a configuration file with errors.......................................................................... 53
5.3. Opening configuration files........................................................................................... 54
5.4. Creating master protocol instances.............................................................................. 55
5.4.1. Creating a master protocol instance by importing it from another configuration
file.................................................................................................................................. 56
5.4.2. Creating a master protocol instance by copying it from another SMP Config
file.................................................................................................................................. 57
5.4.3. Creating a master protocol instance from a template.........................................57
5.4.4. Creating a master protocol instance manually................................................... 58
5.4.5. Creating a master protocol instance using the autoconfiguration function..........59
5.4.6. Device prefix and naming conventions for data points.......................................60
5.4.7. Data point name’s length and alternate names..................................................60
5.4.8. Configuring the master protocol general settings...............................................62
5.4.9. Accessing protocol-specific documentation........................................................63
5.5. Configuring the data points...........................................................................................63
5.5.1. Adding data points from a protocol instance of a configuration file.................... 64
5.5.2. Adding data points from a protocol template file................................................ 65
5.6. Creating a template from a master protocol instance...................................................66
5.7. Duplicating a master protocol instance........................................................................ 66
5.8. Configuring communications links................................................................................ 67
5.8.1. Serial port naming conventions.......................................................................... 67
5.8.2. Serial ports access............................................................................................. 67
5.8.3. Serial port usages...............................................................................................67
5.8.4. Configuring a serial port for asynchronous communications.............................. 69
5.8.5. Configuring a serial port for radio communications............................................ 70
5.8.6. Configuring TCP/IP master connections............................................................ 70
5.8.7. Configuring UDP/IP master connections............................................................ 71
5.9. Associating a master protocol instance with a communications link............................ 72
5.10. Validating and saving the configuration...................................................................... 73
Contents | iii

5.10.1. Sending the configuration to the SMP device.................................................. 73


5.10.2. Retrieving a configuration file........................................................................... 74
5.11. Configuration file import/export capabilities................................................................ 75
5.12. Working with SMP Config...........................................................................................76
5.12.1. Copy a protocol instance form another SMP Config file...................................76
5.12.2. Selecting cells and rows...................................................................................76
5.12.3. Duplicating a row.............................................................................................. 77
5.12.4. Copying a value to a group of cells................................................................. 77
5.12.5. Re-sequencing a group of rows....................................................................... 78
5.12.6. Deleting an item................................................................................................79
5.12.7. Using tooltips.................................................................................................... 79
5.12.8. Searching and replacing points in a configuration............................................80
6. Configuring alarms............................................................................................................... 81
6.1. Configuring alarms based on analog and binary inputs............................................... 81
6.2. Defining alarms categories........................................................................................... 83
6.3. Setting up an alarm buzzer.......................................................................................... 84
7. Archives................................................................................................................................. 85
7.1. Configuring the archive folder.......................................................................................85
8. Log files................................................................................................................................. 86
8.1. Viewing log files............................................................................................................ 86
8.2. Information provided by the log files............................................................................ 86
8.2.1. Maximum number of entries per log file.............................................................87
8.3. SMP Log features......................................................................................................... 88
8.3.1. Searching in SMP Log....................................................................................... 88
8.3.2. Printing a Log..................................................................................................... 88
8.3.3. Saving a Log file.................................................................................................88
8.3.4. Viewing multiple Log folders at once..................................................................89
8.3.5. Changing how time information is displayed...................................................... 89
8.3.6. Deactivating the auto scroll feature.................................................................... 89
8.3.7. Log retrieval by scripting.................................................................................... 89
9. Viewing protocol exchanges in real time........................................................................... 92
9.1. Information provided by SMP Trace............................................................................. 92
9.2. SMP Trace features...................................................................................................... 93
9.2.1. Searching in SMP Trace.................................................................................... 93
9.2.2. Using the Load traces selections feature for debugging purposes.....................94
9.2.3. Printing Traces....................................................................................................94
Contents | iv

9.2.4. Recording live traces.......................................................................................... 95


9.2.5. Saving all the scrolled information..................................................................... 95
9.2.6. Changing how time information is displayed...................................................... 96
9.2.7. Deactivating the auto scroll feature.................................................................... 96
10. Statistics...............................................................................................................................97
10.1. Viewing communications statistics in real time...........................................................97
10.2. Information provided by SMP Stats............................................................................98
10.3. SMP Stats features.....................................................................................................99
10.3.1. Resetting statistics............................................................................................ 99
10.3.2. Printing statistics............................................................................................. 100
10.3.3. Changing how time information is displayed.................................................. 100
11. Connecting the SMP Gateway to a control center.........................................................101
11.1. Creating slave protocol instances............................................................................. 101
11.2. Configuring slave protocol instances........................................................................ 101
11.3. Subscribing to the master data points...................................................................... 102
11.4. Configuring the data points.......................................................................................103
11.5. Configuring the communications links...................................................................... 103
11.5.1. Setting up a TCP/IP slave connection............................................................ 104
11.5.2. TCP ports reserved for SMP Gateway core components or protocols............105
11.5.3. UDP ports reserved for SMP Gateway core components or protocols........... 106
11.5.4. Setting up a UDP/IP slave connection........................................................... 106
11.6. Associating a slave protocol instance with a communications link........................... 107
11.7. Validating and activating the configuration................................................................108
11.8. Testing the configuration........................................................................................... 108
12. Maintenance and commissioning with the SMP Gateway HMI.....................................109
12.1. The SMP Gateway HMI............................................................................................109
12.2. Accessing the SMP Gateway HMI........................................................................... 109
12.2.1. Remote access............................................................................................... 110
12.2.2. Local access................................................................................................... 111
12.3. Navigating through the SMP Gateway HMI..............................................................112
12.3.1. The HMI menu................................................................................................113
12.3.2. The HMI toolbar..............................................................................................114
12.3.3. The Favorites Bar application (optional).........................................................115
12.4. SMP Gateway HMI requirements............................................................................. 116
12.4.1. Required privileges for the SMP Gateway HMI..............................................117
12.4.2. Specific SMP Gateway requirements for the touchscreen............................. 118
Contents | v

12.5. Setting up the touch screen for the local display..................................................... 118
12.5.1. Touch screen calibration for the SMP Gateway HMI...................................... 118
12.5.2. SMP Gateway HMI local display mouse support............................................118
12.5.3. The local display screen resolution................................................................ 119
12.6. Setting up the SMP Gateway HMI........................................................................... 119
12.6.1. Enabling SMP Gateway HMI in the configuration file.....................................120
12.6.2. Enabling the HMI applications........................................................................ 120
12.6.3. Selecting the page displayed at startup......................................................... 121
12.6.4. Setting up HMI session timeouts....................................................................122
12.6.5. Changing how time information is displayed.................................................. 122
12.6.6. Setting up and using the screen saver...........................................................123
12.6.7. Uploading the configuration file to the SMP Gateway.................................... 123
12.6.8. Changing the display language...................................................................... 124
12.6.9. Deactivating the virtual keyboard for the Local HMI.......................................124
12.6.10. Creating keyboard shortcuts for the local display.........................................124
12.7. Using the SMP Gateway HMI applications...............................................................125
12.7.1. Using the communication dashboard............................................................. 125
12.7.2. Using the Redundancy dashboard................................................................. 126
12.7.3. Using the System dashboard......................................................................... 129
12.7.4. Viewing data in real time................................................................................ 130
12.7.5. Archives files from the HMI............................................................................ 133
12.7.6. Statistics files from the HMI............................................................................134
12.7.7. Log files from the HMI....................................................................................134
12.7.8. The Commissioning Tool................................................................................ 135
12.7.9. Using the Alarm log........................................................................................ 143
12.7.10. Using the Features Status application..........................................................144
13. Operations with the SMP Gateway HMI..........................................................................146
13.1. The Active Alarms page........................................................................................... 146
13.1.1. The preview pane........................................................................................... 147
13.2. Setting up the Active Alarms page........................................................................... 148
13.3. Setting up the Blocked Alarms page........................................................................ 150
13.4. Setting up the Alarms History page..........................................................................151
13.5. Managing control permission on control points........................................................ 152
13.6. Diagrams for the SMP Gateway HMI....................................................................... 152
13.6.1. Using SMP Diagram Editor............................................................................ 153
13.6.2. The SMP Diagram Editor interface.................................................................154
Contents | vi

13.6.3. Supported languages in Diagrams and Device's Front panels pages............ 155
13.6.4. Supported fonts on the local display of the SMP Gateway HMI..................... 155
13.6.5. Implementation of a control interlock software mechanism in Diagrams........ 156
13.6.6. Creating Diagrams via SMP Config................................................................156
13.6.7. Templates........................................................................................................157
13.6.8. SMP Diagram Editor's specific applications................................................... 162
13.6.9. Multi-control capability of SMP Diagram........................................................ 166
13.6.10. The Control Interaction Configuration window..............................................166
13.6.11. Linking diagram pages using SMP Diagram's shape interaction.................. 167
13.6.12. Exporting a diagram to the SMP Gateway HMI file format........................... 168
13.6.13. Uploading an SMP Gateway HMI package file on the SMP Gateway.......... 169
13.6.14. Retrieving HMI Diagram files from an SMP Gateway.................................. 170
13.7. Using the SMP Gateway HMI operational applications............................................ 171
13.7.1. Managing alarms............................................................................................ 171
13.7.2. Blocking and reactivating blocked alarms...................................................... 173
13.7.3. The Alarms History page................................................................................173
13.7.4. The Single alarm display................................................................................ 174
13.7.5. Enabling or disabling sound on a new alarm................................................. 175
13.7.6. Using the Diagrams or Device's Front Panels application..............................175
13.7.7. Performing control operations from a Diagram or Device's Front Panel
page.............................................................................................................................175
13.7.8. Managing alarms from the Diagram or Device's Front Panel page................ 177
13.7.9. Troubleshooting animation errors on a diagram page....................................178
13.7.10. Enable or disable zoom control.................................................................... 179
14. SMP Gateway add-in for Microsoft Excel®.................................................................... 180
14.1. Installing the SMP Excel add-in................................................................................181
14.2. Accessing the SMP Excel add-in............................................................................. 181
14.2.1. Unsuccessful connection to the SMP Gateway..............................................182
14.2.2. Opening an existing list.................................................................................. 183
14.3. The Instances list......................................................................................................183
14.3.1. Using the Instances list.................................................................................. 184
14.4. The Data Points list.................................................................................................. 184
14.4.1. Using the Data Points list............................................................................... 185
14.5. The Working Plan list................................................................................................185
14.5.1. Using the Working Plan list............................................................................ 187
15. Security.............................................................................................................................. 188
Contents | vii

15.1. Displaying appropriate use banner........................................................................... 188


15.2. Meeting NERC CIP requirements.............................................................................189
15.2.1. Identifying which ports are open in the SMP Gateway firewall....................... 189
15.2.2. Extending the SMP Gateway security model................................................. 190
15.3. Substation network security considerations..............................................................190
15.3.1. The SMP Gateway integrated firewall............................................................ 190
15.3.2. Using SMP Tools through a substation LAN firewall...................................... 191
15.4. SMP Gateway authentication policy......................................................................... 193
15.4.1. Defining the SMP Gateway authentication policy (first time).......................... 193
15.4.2. Defining the SMP Gateway authentication policy (not for the first time)......... 194
15.4.3. User account lockout...................................................................................... 194
15.4.4. Unlocking user accounts................................................................................ 195
15.5. The SMP Device security database......................................................................... 195
15.5.1. Default groups and privileges.........................................................................196
15.5.2. Accessing the local security database editor................................................. 197
15.5.3. Managing the list of user groups....................................................................197
15.5.4. Granting privileges to a user group................................................................ 198
15.5.5. Managing the list of user accounts.................................................................198
15.5.6. Setting the password of a user account.........................................................198
15.5.7. Assigning a user account to groups............................................................... 199
15.5.8. Validating the local security database............................................................ 199
15.5.9. The SMP Device security database status.....................................................200
15.5.10. Uploading the local security database on SMP Devices.............................. 200
15.5.11. Retrieving an existing security database from an SMP Device.................... 201
15.5.12. Exporting the local security database...........................................................201
15.5.13. Uploading a previously saved security database......................................... 201
15.5.14. Deactivating local authentication on SMP Devices.......................................202
15.6. The SMP Gateway Security log................................................................................203
15.6.1. Viewing the Security log................................................................................. 203
15.7. Configuring the integrated firewall............................................................................ 203
15.7.1. Specifying firewall rules.................................................................................. 203
15.7.2. Restricting access to other services...............................................................205
15.7.3. Deactivating the integrated firewall.................................................................205
15.7.4. Disabling the Firewall log............................................................................... 206
15.8. Device account password management...................................................................206
15.8.1. The SMP Gateway password secure store.................................................... 206
Contents | viii

15.8.2. Updating an account password in the SMP Gateway secure store................ 207
15.8.3. Deleting an account password from the SMP Gateway secure store.............208
15.9. Secure authentication using X.509 certificates.........................................................208
15.9.1. Importing X.509 certificate information in the SMP Gateway configuration.... 209
15.9.2. Associating X.509 Certificates to a TCP/IP master connection...................... 209
15.9.3. Associating X.509 certificates to a TCP/IP slave connection......................... 210
15.9.4. Uploading X.509 certificate files on the SMP Gateway.................................. 211
15.9.5. X.509 authentication at the application layer level......................................... 211
15.10. File certification and integrity checking...................................................................211
15.10.1. Detecting an integrity check failure.............................................................. 212
15.10.2. Recovering from an integrity failure..............................................................212
15.11. Locking passthrough and incoming RAS connections............................................213
15.11.1. Locking or unlocking a passthrough connection...........................................213
15.11.2. Locking or unlocking all incoming RAS dial up connections......................... 214
15.12. Security-related system data points........................................................................214
15.13. Using VPN connections.......................................................................................... 215
16. Using Passthrough connections..................................................................................... 216
16.1. The Passthrough feature.......................................................................................... 216
16.1.1. Principles of operation.................................................................................... 216
16.1.2. Setting up passthrough connections.............................................................. 219
16.1.3. Connecting to the device................................................................................225
16.1.4. Testing the passthrough connection............................................................... 226
16.1.5. Deactivating the passthrough connection.......................................................227
16.1.6. Using the trace of passthrough connection events........................................ 227
16.1.7. Changing how time information is displayed in SMP Connect....................... 228
16.2. The Proxy Passthrough feature................................................................................229
16.2.1. Principle of operation......................................................................................229
16.2.2. Setting up a Proxy Passthrough connection.................................................. 230
17. Recording Sequence of Events.......................................................................................232
17.1. Events....................................................................................................................... 232
17.1.1. Supported data point types............................................................................ 232
17.1.2. Trigger conditions........................................................................................... 232
17.1.3. Quality flags.................................................................................................... 233
17.2. Sequence-of-Events log entries................................................................................233
17.2.1. Additional entries............................................................................................ 233
17.2.2. Syslog entries................................................................................................. 233
Contents | ix

17.3. Configuring the Sequence of Events recorders (SER)............................................. 233


17.3.1. Activating the SER..........................................................................................234
17.3.2. Customizing the format of the different Event log entries...............................234
17.3.3. Selecting event-generating data points.......................................................... 236
17.3.4. Defining point-specific labels for Log entries..................................................237
17.3.5. Modifying triggering events conditions........................................................... 237
17.3.6. Changing how time information is displayed in log entries.............................237
17.4. Activating Syslog reporting of events....................................................................... 238
18. Automation.........................................................................................................................239
18.1. The SMP Gateway Automation Functions module................................................... 239
18.2. The SoftPLC module................................................................................................ 239
18.2.1. The CODESYS development environment.....................................................240
19. Using Syslog with an SMP Gateway............................................................................... 241
19.1. Setting up Syslog......................................................................................................241
20. Redundancy....................................................................................................................... 244
20.1. Redundant group operation...................................................................................... 244
20.1.1. SMP Device A and B designation.................................................................. 245
20.1.2. Redundant IEDs............................................................................................. 245
20.2. Grouping 2 SMP Gateways for redundancy............................................................. 246
20.2.1. Prerequisites................................................................................................... 247
20.2.2. SMP Manager Redundancy column...............................................................247
20.3. Managing redundancy.............................................................................................. 249
20.3.1. Forcing an active SMP Gateway to fall on standby........................................249
20.3.2. Additional failover conditions.......................................................................... 249
20.3.3. Modifying the redundancy settings of an existing group.................................249
20.3.4. Ungrouping SMP Gateways............................................................................250
20.3.5. Testing and validating the configuration......................................................... 250
20.3.6. Monitoring redundancy status.........................................................................250
20.3.7. Testing a redundant network.......................................................................... 250
20.4. Hot Standby.............................................................................................................. 252
20.4.1. Setting the master protocol components for hot standby............................... 252
20.4.2. Setting the slave protocol components for hot standby..................................252
20.4.3. Behavior of the active SMP Gateway.............................................................254
20.4.4. Behavior of the standby SMP Gateway......................................................... 254
20.4.5. Specific behavior or configuration related to a redundancy configuration.......257
20.5. Teaming network adapters (NICs)............................................................................ 258
Contents | x

21. Setting up the SNMP Server............................................................................................ 259


21.1. SNMP Traps..............................................................................................................259
21.2. Configuring the SNMP server...................................................................................260
22. Time adjustment................................................................................................................262
22.1. Monitoring time information...................................................................................... 262
22.2. Setting the SMP Gateway internal clock.................................................................. 263
22.3. Automatic clock adjustment...................................................................................... 264
22.3.1. About GNSS, IRIG-B, SNTP and PTP........................................................... 265
22.3.2. Configuring the satellite-synchronized (GNSS) clock option.......................... 266
22.3.3. Using IRIG-B for internal clock adjustment.................................................... 266
22.3.4. Setting up the SMP Gateway as an SNTP client........................................... 267
22.3.5. Setting up the SMP Gateway as a PTP client................................................267
22.3.6. Using the time adjustment feature of a SCADA protocol............................... 268
22.4. Using the SMP Gateway as a time synchronization source..................................... 269
22.4.1. Configuring IRIG-B time distribution............................................................... 270
22.4.2. Setting up the SMP Gateway to act as an SNTP server................................ 271
22.4.3. Adjusting devices clocks using master protocols........................................... 271
23. The SMP REST API...........................................................................................................272
23.1. REST architecture, the basics.................................................................................. 272
23.2. The SMP REST API interface.................................................................................. 273
23.3. Getting started with the REST API...........................................................................274
23.4. Getting started with the SDK.................................................................................... 274
23.4.1. Application examples through sample files.................................................... 274
24. SMP Tools remote access to the SMP Gateway............................................................ 276
24.1. Setting up a dial-up (Modem) connection.................................................................276
25. Updating SMP Gateway Software and Tools..................................................................279
25.1. Software architecture of the SMP Gateway..............................................................279
25.2. Version Packs........................................................................................................... 280
25.3. Updating the SMP Tools on the PC......................................................................... 280
25.4. Updating the SMP Gateway software.......................................................................281
25.4.1. Updating the SMP Gateway firmware............................................................ 281
25.4.2. Updating the SMP Gateway application......................................................... 283
25.4.3. Updating the configuration file........................................................................ 283
26. Activating a new license.................................................................................................. 285
26.1. Updating the license of an SMP Gateway................................................................285
26.1.1. Protocol classes..............................................................................................286
Contents | xi

27. Miscellaneous SMP Tool features................................................................................... 287


27.1. SMP Manager features.............................................................................................287
27.1.1. Modifying SMP Manager Settings.................................................................. 287
27.2. SMP Loader.............................................................................................................. 288
27.2.1. Setting up SMP Loader.................................................................................. 289
27.2.2. Main window................................................................................................... 290
27.2.3. Transferring files to the SMP Gateway...........................................................290
27.2.4. Viewing the log file......................................................................................... 292
27.2.5. Updating bootstraps under unusual circumstances........................................292
28. SMP Console functions.................................................................................................... 293
28.1. Starting SMP Console.............................................................................................. 293
28.2. Firewall Manager...................................................................................................... 293
28.2.1. R Command....................................................................................................294
28.2.2. S Command....................................................................................................294
28.2.3. H Command....................................................................................................294
28.2.4. Q Command................................................................................................... 294
28.3. Time and date...........................................................................................................295
28.4. Clock Manager..........................................................................................................295
28.4.1. D Command....................................................................................................296
28.4.2. H Command....................................................................................................296
28.4.3. Q Command................................................................................................... 296
29. Troubleshooting................................................................................................................ 297
29.1. Creating an SMP Gateway report file....................................................................... 297
29.1.1. Viewing an SMP Device report file................................................................. 299
29.2. Restoring the factory settings of the SMP Device.................................................... 299
29.3. Startup problems.......................................................................................................300
29.3.1. No configuration file........................................................................................300
29.3.2. Protocols failed............................................................................................... 300
29.3.3. Critical components missing........................................................................... 301
29.4. Communication problems......................................................................................... 301
29.4.1. Physical layer..................................................................................................302
29.4.2. Link layer........................................................................................................ 302
29.4.3. Protocol layer..................................................................................................302
29.5. Problems with data validity....................................................................................... 303
29.6. Problems executing a control operation................................................................... 303
29.7. Firewall-related problems..........................................................................................304
Contents | xii

29.7.1. Recovering from a firewall lockout on an SMP 4/DP..................................... 304


29.7.2. Recovering from a firewall lockout with an SMP SG-42xx platform................305
29.8. Diagrams problems................................................................................................... 305
29.8.1. Missing Operand (dark red question mark).................................................... 306
29.8.2. Invalid Operand Value (light red question mark)............................................ 306
30. Appendices........................................................................................................................ 307
30.1. System data points................................................................................................... 307
30.2. RTDX status flags.....................................................................................................315
Eaton User Manual | page 13
1. Welcome
Congratulations on acquiring your new automation platform from Eaton, the SMP Gateway! You
now have unlimited connectivity for all the equipment in your substation or field devices.
In this manual, we will show you how to use the SMP Gateway to integrate existing and new
RTUs, IEDs, PLCs and control centers into a single modern, homogeneous utility automation
system.
You will learn how to set up your SMP Gateway as a:
• Protocol Translator: The SMP Gateway translates standard or proprietary device protocols
to control center protocols such as DNP3, TEJAS, IEC-60870-5-101/103/104 or IEC-61850.
• Data Concentrator: The SMP Gateway collects the data from all connected devices,
regardless of protocol, and makes it available to control centers using LAN, WAN, modem or
serial connections.
• Terminal Server: The SMP Gateway supports centralized maintenance, monitoring and
control of all devices by using the passthrough communication mode.
• Substation Communications Gateway: The advanced capabilities of the SMP Gateway
make it the ideal choice for any substation automation project.

1.1. SMP Gateway automation platforms


There are currently 3 types of SMP Gateway automation platforms:
• The SMP SG-42xx platform is the fourth generation of substation-grade SMP Gateways
designed for today's substations and distribution automation and part of Eaton's SMP
family of products. It comes in two models, both of which share most of the platform’s basic
characteristics and can be mounted in a 19-inch rack:
◦ The SMP SG-4250, which is equipped with a high-performance Intel Atom Dual Core
1.8 GHz processor, 2 GB of DDR2 RAM, and 1 GB of non-volatile CompactFlash disk
storage.
◦ The SMP SG-4260, which is equipped with a high-performance Intel Atom E3845 Quad-
core 1.91 GHz processor, 2 GB of DDR3 RAM, and 1 GB of non-volatile CompactFlash
disk storage.
Both models come with 2 built-in Ethernet ports, and can be equipped with up to 4 optional
communication modules, which provides additional ports for Ethernet and serial (RS-232/
RS-485) communications. We are referring to the SMP SG-42xx platform throughout this
manual when the described feature applies to both models; otherwise, the specific model is
specified.

• The SMP 4/DP platform provides 2 Ethernet ports, 4 serial links and a real-time clock that
can be synchronized to an IRIG-B time synchronization source. An optional internal modem
is also available.
• The SMP 16 platform, which can be mounted in a 19-inch rack, comes in two models, both
of which have the same basic characteristics:

User Manual | page 14 Eaton


1 - Welcome

Important: Starting at version 8.1, we stopped the support of the SMP 16 platform
in SMP Config, meaning that the Software and Tools 8.1R1 and later cannot be installed
on an SMP 16 platform. However, SMP Manager can still manage SMP 16 platforms
running versions 8.0 or older. For this reason, if you have an SMP 16 platform, refer to
the Software and Tools version pack 8.0, which includes a documentation package which
supports the SMP 16 platform.

◦ The SMP 16/CP is a gateway that offers 16 RS-232/485 universal serial ports, 2 Ethernet
ports and an integrated modem.
◦ The SMP 16/SG has, in addition, expansion slots where accessories and options can be
added to make it an ideal communications gateway for all your automation projects.

Note: Both SMP 16 models can also be equipped with 2 different CPU option. The
entry level 600 Mhz Celeron processor (CM model) or the high end 1.4 GHz Pentium-
M processor (PM model).

All models share the same software capabilities, limited only by the hardware characteristics,
providing reduced learning time and a simplified migration path between models. The manual
applies to all platforms and models, and differences are indicated where applicable. Refer to
your SMP Gateway installation guide for a detailed description of your particular SMP Gateway
platform.

1.2. Related documentation and software


This manual provides you with the basic information you need to get started with your
SMP Gateway.
To reduce paper use, we have included the following related documentation on the CD-ROM
you received with the product. Should you want printed documents, you can order them from
Eaton using reference number P-DPRN-0102. Reference to other software applications is
included.
The Documentation folder contains the following related manuals from Eaton:
Table 1 - Related documentation and software
SMP 4/DP Installation Guide MN912013EN This document gives you detailed instructions on
installing and setting up the SMP 4/DP.

SMP SG-42xx Platform MN912022EN This document gives you basic installation instructions
Installation Guide for the SMP SG4250 and SMP SG-4260.

SMP SG-42xx Platform User MN912026EN This document provides detailed installation and
Manual configuration instructions for the SMP SG4250 and
SMP SG4260.

SMP SG-42xx Platform Clock MN912135EN This document provides detailed explanations of the
Technical Specifications clock function for the SMP SG-42XX Platform

Eaton User Manual | page 15


1 - Welcome

Satellite-synchronized clock MN912163EN This document describes the principles of operation of


(GNSS) option - Installation the satellite-synchronized clock (GNSS), which allows
Guide the use of the GPS and/or GLONASS constellation.
( Available on the SMP SG-4260 The document also presents the installation procedure
platform only) of the GNSS antenna, the necessary configuration and
the GNSS specifications.

Protocol Common Concepts MN912003EN This document describes the concepts and settings
Reference Manual common to the protocols used by most substation
devices. Separate documents describe the protocol-
specific settings.

SMP Products Communication MN912162EN This document provides information related to all
and Expansion Modules User shared communication and expansion modules
Guide between the SMP automation platforms and the SMP
computing platform; modules installation instructions
are included in the document.

Embedded configurations, SMP MN912194EN This document describes the concepts and steps to
Devices into an SMP Gateway - configure SMP Devices (SMP IO-2000 series only for
User Manual now) included into the SMP Gateway configuration file,
thus using a single configuration file for all devices.

Visual T&D Diagram Editor User MN914002EN This document presents the Diagram Editor, a Visual
Guide T&D application allowing the creation of interactive
diagrams used to monitor and operate a substation
or an electric grid. This document is also used with
SMP Diagram Editor for the creation of Diagrams and
Device's Front Panels.

Visual T&D Basic Shapes MN914004EN This document presents the different shapes that are
Libraries Reference Manual available in the Library Manager, along with additional
implementation and usage details.

User Manual | page 16 Eaton


1 - Welcome

Eaton SMP Configuration Version 1.1 or later The Eaton SMP Configuration Comparison Tool is an
Comparison Tool application that is independent from the SMP Gateway
Software and Tools package; it is used to compare two
configuration files (.par, .old and .tpl). The application
is quite intuitive and easy to use.
Once installed, the application works in synergy
with SMP Manager's tools and allows to compare
configuration files when a user is sending a
configuration file to the SMP Device, to be able to
visualize the differences between the current and
new files. It is also integrated to File Explorer to allow
configuration file comparison outside of SMP Manager.
This application can be downloaded from the
Substation Automation customer portal, which is
available at the following URL:
https://www.cybectec.com/customers/
You must have appropriate credentials to access the
customer portal’s files. Customer support can provide
such credentials.

In the same folder, you will also find useful documentation about the protocols implemented for
the SMP Gateway, technical notes that give additional information about the most advanced
features of the SMP Gateway, and application notes that will help you use the SMP Gateway in
your projects.

1.3. Getting assistance


If you have any question regarding the performance, application or testing of any component of
the product, please do not hesitate to contact us.

Technical Support
Eaton
Energy Automation Solutions
Email for technical assistance: [email protected]

Phone: 1.800.815.2258 (English support only)

Phone: 1.877.834.0009 (English and French support)

Business hours are from 8 a.m. and 5 p.m. CST, Monday to Friday.

Eaton User Manual | page 17


1 - Welcome

1.4. Getting started


When you receive your SMP Gateway, you have to go through several steps before you can
perform the tasks described in this document. Namely, you have to do the following:
• Unpack the SMP Gateway
• Install the SMP Gateway
• Set-up the SMP Gateway
• Install the PC software
• Make the SMP Tools aware of your new SMP Gateway
• Load the SMP Gateway firmware

All of these steps are explained in detail in the present document and specific devices
installation instructions in the following documents:
• SMP 4/DP Installation Guide
• SMP SG-42xx platform Installation Guide and User Manual

Make sure you have performed all the steps described in those documents before
proceeding with the material explained in the present document.

1.5. Overview
Once you have performed all the steps related to the hardware and software installation, you
are ready to perform the following tasks, as described in this user manual:
• Configure your SMP Gateway so that it can communicate with your devices:
• Define the hardware.
• Configure the master protocol instances that will communicate with your devices.
• Configure the data points.
• Set-up the communications links between the SMP Gateway and the devices.
• Associate master protocol instances with communications links.
• Validate, activate and test your configuration.
• View the following information in real time:
• The SMP Gateway log, statistic and archive files (SMP Gateway HMI)
• Protocol exchanges.
• Communications statistics.
• Data points, using the SMP Gateway HMI.
• Configure your SMP Gateway so that it can communicate with one or more control centers:
• Configure a slave protocol instance for each control center.
• Have each control center subscribe to the data points.
• Associate slave protocol instances with communications links.
• You will also become familiar with the following SMP Gateway features:
• Dual power-supplies redundancy operation modes (option on the SMP SG-4260 model)

User Manual | page 18 Eaton


1 - Welcome

• Security
• Passthrough connections
• DFR and event file processing
• Automation functions
• SMP Gateway HMI
• Redundancy
• SNMP exporting
• Time synchronization
• SMP Gateway access through a direct or dial-up connection
• SMP Gateway access through a dial-up connection for DNP3 and IEC 60870-5-101 protocols

You will also learn how to update the SMP Gateway software and tools, and to troubleshoot any
problems you may encounter with your SMP Gateway.

Eaton User Manual | page 19


2. Principles of operation
Electrical power utilities face a number of challenges when attempting to automate their
substations and distribution systems. They have legacy devices that they want to continue
using.
They want to integrate new devices. They may want to add one or more control centers. They
may want to use a local and remote HMI in order to keep a close watch on all events that occur
in the substation or in the field.
There are a number of problems to contend with: connectivity, protocol incompatibilities,
interoperability problems, security considerations, logistics for migration, downtime, and not the
least of which, total project cost.
The SMP Gateway automation platform has been specifically designed to address all these
issues. It is the ideal product to ensure a smooth, safe and cost-effective approach to substation
and distribution modernization. Indeed, you can use a step-by-step approach. You decide which
steps to take, in which order, and when.

2.1. Logical architecture


The SMP Gateway is designed to meet all the requirements for power substation automation.
It has an open architecture that allows you to easily add new protocols, devices, local area
networks, wide area networks, and control centers.
In this section, we will describe the logical architecture of the SMP Gateway and we will see how
it implements all the functions required of a modern automation system for substations as well
as for advanced distribution systems.

2.1.1. Masters and slaves


A typical automation system consists of a SCADA system, located in a control center, which is
connected to devices located in the substation or in the field. The SCADA regularly polls the
devices in order to retrieve device readings and statuses. The operator uses the SCADA system
to perform control operations on selected devices.
Since it is the control system that initiates data acquisition and control, it is considered to be the
master system. Since the substation or field device responds to data acquisition and control
requests, it is considered the slave system.

User Manual | page 20 Eaton


2 - Principles of operation

Figure 1 - A simple SCADA-device master-slave configuration

2.1.2. Introducing the SMP Gateway in the automation system


When an SMP Gateway is introduced in the automation system, it has to act as both a slave
and a master. The SCADA system interrogates the gateway as if it were a substation device or
a distribution cabinet. The gateway is thus a slave to the SCADA. However, since the gateway
is connected to the substation or field devices, it must also be able to perform the functions of a
master, such as polling for data and sending control requests.

Figure 2 - The SMP Gateway as a Master-and-Slave system

2.1.3. SMP Gateway internals


The SMP Gateway internal architecture is based on a series of software components called
protocol components. Slave protocol components implement all the functions necessary to
process requests received from a SCADA or control center. Master protocol components
implement the functions necessary to poll devices and send control requests. Eaton provides
components for most standard protocols, such as DNP3, MODBUS, IEC-60870-5-101/103/104
and IEC 61850, as well as a large number of proprietary protocols such as SEL, ABB TEN
BYTE, Motorola MDAC, and more.

Eaton User Manual | page 21


2 - Principles of operation

The master protocol component polls the device and stores the data that it retrieves in an
internal database, called Real-Time Data Exchange (RTDX). RTDX is much more than a simple
data store. Besides storing the current value of all the device data points, it also stores the
different types of information than can be provided by a substation device, such as the quality
and timestamp of the data. It also stores information such as device tags used for control
functions.

Figure 3 - SMP Gateway internals: master and slave protocols with RTDX

2.1.4. Communications components


SMP Gateway protocol components process the messages exchanged among the control
centers and the devices. However, these messages can be transmitted using various
communications methods. For instance, the MODBUS protocol can be used on a TCP/IP
network or on an RS-232 serial link.
SMP Gateway communications components implement all the functions required to
communicate with a device or control center using a variety of communications technologies.
Eaton provides communication components for asynchronous serial ports, RS-232, RS-485,
TCP/IP radios and modems.

User Manual | page 22 Eaton


2 - Principles of operation

Figure 4 - SMP Gateway communication components

2.2. Configuring the SMP Gateway


The SMP Gateway configuration process consists of establishing the relationships among
the internal components, and providing the specific settings for each of these components.
This task is greatly simplified by the SMP Tools family of software programs. These Microsoft
Windows-based programs help you configure your SMP Gateway and identify and correct any
problems.
The configuration process consists of the following steps:
• Identifying the SMP Gateway model and the installed options.
• Creating a master protocol component for each device that is connected to the
SMP Gateway.
• Defining all the data points in the device.
• Defining the communications link to be used to connect the device to the SMP Gateway.
• Creating a slave protocol component for each SCADA or control center.
• Defining the data points that the SMP Gateway will report to the SCADA.

Eaton User Manual | page 23


2 - Principles of operation

• Defining the communications link to be used to connect to the SCADA.


• Adding a firewall and optionally a security server that supports corporate network users.
• Defining Management and Web servers secure protocol versions
• Enabling/Disabling the Remote and Local SMP Gateway HMI access features

Thus, the configuration settings define the functions that the SMP Gateway performs. These
settings are stored in a file that you load onto the gateway. The flexibility of the SMP Gateway
architecture is the basis of Eaton’s step-by-step automation platform strategy.
In the following sections, we will show you how you can configure the SMP Gateway to perform
all the functions required of a substation gateway.

2.2.1. The transparent SMP Gateway


As a first step in a substation automation project, you can easily set up the SMP Gateway to act
as a transparent interface between the SCADA and a substation device. The following diagram
illustrates how you can do this using the MODBUS protocol.

Figure 5 - The transparent SMP Gateway

In this configuration, the master component polls the device and stores the values in the RTDX.
The slave component processes the SCADA polling requests and sends the values provided by
the device.

User Manual | page 24 Eaton


2 - Principles of operation

There is not much use for a transparent gateway. However, it contains much more than
the components that we described previously. Simply by adding the SMP Gateway to the
substation, you now have access to the following advanced functions:
• Centralized automation functions, using the integrated Automation functions or the IEC
61131-3 Soft PLC logic processor.
• Real-time data display, using the integrated Web server (SMP Gateway HMI).
• Communication, System and Redundancy dashboards, Diagrams, access to archive, log and
statistic files with the SMP Gateway HMI.
• The SMP Gateway HMI Commissioning Tool, together with the SMP Gateway Add-In for
Microsoft Excel that creates a commissioning test plan and automatically keep track of tested
connections and data points ensure a fast and easy commissioning.
• Transparent access to devices, using the passthrough server, for local or remote IED
maintenance.
• SNMP support to monitor communication statuses.
• Sophisticated HMI, interactive diagrams, data logging and reporting, using Eaton’s SMP
Diagram Editor software, which is integrated in SMP Config and also in SMP Manager.
• Sophisticated Windows tools for remote or local maintenance.
• A sophisticated security server to support corporate network users.

Even more important, the transparent SMP Gateway is the first step in integrating new
substation devices to your existing SCADA and automation system.

Figure 6 - Additional SMP Gateway functions

Eaton User Manual | page 25


2 - Principles of operation

2.2.2. Using the SMP Gateway as a protocol translator


As we saw in the last section, the SMP Gateway is transparent when the master and slave
protocols are the same. When you configure different master and slave protocols, the
SMP Gateway becomes a protocol translator.
Since you can independently configure the communications links for the master and slave
components, you can easily use the SMP Gateway to integrate legacy serial devices in a
modern network environment. Similarly, you can connect modern IEDs to a legacy control
center.

Figure 7 - The SMP Gateway as a protocol translator

User Manual | page 26 Eaton


2 - Principles of operation

2.2.3. Using the SMP Gateway as a data concentrator


The SMP Gateway architecture is designed to simultaneously support any number of master
components. Each component has its own communications link and its own protocol. All
the data retrieved from the devices is stored in the RTDX, where it becomes available to the
SCADA. Using the SMP Gateway as a data concentrator is a simple matter of configuration, and
it provides a highly efficient means of adding new devices to an existing automation system. The
SCADA system has no knowledge of the new devices; it only sees new data points.

Figure 8 - The SMP Gateway as a data concentrator

Eaton User Manual | page 27


2 - Principles of operation

2.2.4. Using the SMP Gateway as a communication processor


The SMP Gateway architecture supports any number of slave components. Each component
has its own communications link, and all the device data can be sent to any number of SCADA
and control centers, each with its own protocol. Using the SMP Gateway, sending data to a new
control center is a simple matter of configuration.

Figure 9 - The SMP Gateway as a communication processor

User Manual | page 28 Eaton


2 - Principles of operation

2.2.5. Putting it all together


The sophisticated architecture of the SMP Gateway allows it to integrate existing and new
RTUs, IEDs, PLCs and control centers into a single homogeneous substation automation
system. It provides you with a complete solution for automating new substations and
modernizing legacy systems.

Figure 10 - The substation SMP Gateway

Eaton User Manual | page 29


2 - Principles of operation

2.2.6. Securing the substation


Widespread data access within the SMP Gateway can become an important security risk if it is
compromised, but it can also become a security asset. The gateway provides a single point of
access to all substation data. The security features of the SMP Gateway allow you to protect the
substation devices (see Security (page 188)).
If you activate the security features within your substation SMP Gateway, you will be able to:
• comply with authentication and authorization policies;
• set up a firewall to protect from substation LAN security breaches;
• monitor and lock out remote connections.

Communications between maintenance tools and the SMP Gateway are now performed through
TLS-encrypted links. File integrity check is also periodically performed on the SMP Gateway
files.
The access inside the firewall protection has additional layers of protection, so that only a few
users of your choice will have the possibility to modify parameters inside the substation.

Figure 11 - The SMP Gateway integrated firewall

In the following chapters, we will learn how to configure the SMP Gateway to perform these
functions.

User Manual | page 30 Eaton


3. SMP Tools overview
To assist you with the tasks you will want to perform with the SMP Gateways in your
organization, we have provided you with our suite of SMP Tools.
The SMP Tools are Microsoft Windows-based programs that make it easy for you to configure
the SMP Gateway and perform maintenance functions. They run on a PC, are simple to
use, and provide advanced features that allow you to rapidly configure all the devices and
communications links in your substation. They can be used locally or remotely through a LAN,
WAN or VPN. When authentication is activated, users must log in before they can use any
function.
The SMP Tools include the following applications.
SMP Manager
Manages all the SMP Gateways in your organization. It displays the state of each gateway,
manages their configuration files and local security database, allows you to group two gateways
together to achieve redundancy, and is used to invoke the configuration and maintenance tools
for any gateway to which it is connected. From SMP Manager, you can also start your default
Web browser to view the data points, logs and traces in real time, and you can start a console
session in order to set-up certain advanced features such as dial-up access.
SMP Config
Used to configure the SMP Gateway. It has a spreadsheet-like grid that you use to specify the
devices and control centers connected to the gateway, their protocols, their communications
links and their data points. Advanced editing functions make it easy for you to enter the data
points. Copying and pasting specific device components or importing components from an
SMP Config file to another configuration file allows to quickly setup an SMP Gateway using an
existing similar configuration. Also, Template editing allows you to predefine standard devices
with standard data points, thereby reducing labor intensity and the possibility of errors.
61850 Config
Used to configure the IEC 61850 protocol on the SMP Gateway.
SMP Log
Used to browse through and manage the log files maintained by the SMP Gateway. All
significant events are logged, including local and remote control events, system failures, special
protocol events, and so on. Log files are also available on the SMP Gateway HMI.
SMP Stats
Used to browse through and manage a large variety of dynamically updated statistics, ranging
from full communications statistics for each link to the processor load for each protocol
component. Statistics are also available on the SMP Gateway HMI.
SMP Trace
Used to browse through the real-time traces generated by the SMP Gateway. SMP Trace can
display detailed traces of all protocol and communications link activity. Traces are displayed
in both hexadecimal and application protocol format. The tracing functions are similar to those
usually provided by protocol analyzers, with the notable exception that they can be used
remotely at any time on any SMP Gateway and that they decode information at the application
level. As such, they constitute an excellent commissioning or debugging tool.

Eaton User Manual | page 31


3 - SMP Tools overview

SMP Connect
Used to establish passthrough connections with any IED connected to an SMP Gateway, for the
purpose of doing remote configuration and maintenance of IEDs using manufacturer-provided
software.
SMP Loader
Used to load the secondary bootstrap program. Refer to Appendix A and of your SMP Gateway
Installation Guide for details on using SMP Loader.
Event Translator
Used to convert event files to the COMTRADE format.
The next chapter will discuss how to create a list of SMP Gateways with SMP Manager, and will
then explain how to do a complete configuration of your SMP Gateway using SMP Config.

User Manual | page 32 Eaton


4. SMP Manager
SMP Manager is the doorway to your SMP Gateways and other SMP Devices.

The term SMP Device includes the SMP Gateways as well as other supported SMP platforms. It
runs on your PC, as do all the tools you launch through SMP Manager. You are already familiar
with the application, since you added your new gateway to the list of SMP Gateways managed
by SMP Manager when you installed your SMP Gateway. This section goes over a few of the
points that were covered in your SMP Gateway installation guide, and provides additional
information.

4.1. Starting SMP Manager


SMP Manager is the doorway to your SMP device. It runs on your PC, as do all the tools you
launch through SMP Manager.

Detailed information about SMP Manager tools and functionality are included in the SMP
Gateway User Manual.
To start SMP Manager:

1. Select Windows > All Programs > Eaton SMP Tools > SMP Manager.
2. The Logon Information window may appear. If it is the case, enter valid credentials and click
OK to login.
Result:

3. SMP Manager starts up and lists all SMP devices it currently monitors.

Eaton User Manual | page 33


4 - SMP Manager

4.2. Main Window of SMP Manager


The following figure shows a typical SMP Manager window.

Figure 12 - SMP Manager main window

As illustrated, the main window displays information such as (some columns are not shown):
• The list of SMP devices and the tools that are currently running for each SMP device in the
list.
• The current status of each SMP device in the list (started, failed, safe mode, max safe mode,
on standby, and various intermediate states), along with the license expiration date, if any.
• The Local Configuration displays the status of the local configuration file (configured in
the SMP Device Properties, Configuration file) compared to the one on the SMP device
(Synchronized, Newer, Older, Unknown, Not Found or empty). Refer to section The statuses
of the Local Configuration column explained (page 48) for details.
• The SMP device model/platform (e.g., SMP 4/DP, SMP SG-4250, SMP SG-4260, SMP
IO-2230)
• The version number of the application that is installed on the SMP device
• The primary IP address of the SMP device: [via <SMP Gateway IP address>] for device
access via Proxy Passthrough
• Whether the SMP device integrated firewall is active or not
• The type of security (global or local) and the security status (enabled, disabled, local: older...)
• The unit’s serial number

You can choose which columns you want to display and their order of appearance, by right-
clicking on the column header.

4.3. Adding an SMP Device


Creating a list of the SMP device you want to monitor is easy.
Before you begin:
The following procedure applies when you want to add an SMP device directly to the list of
devices monitored by SMP Manager. The use case of embedded SMP device configurations
into an SMP Gateway configuration file is not covered in this section.
Please refer to section The Proxy Passthrough feature (page 229) for child SMP devices
added behind a parent SMP Gateway using a Proxy Passthrough connection.
Also, refer to the Embedded configurations, SMP Devices into an SMP Gateway - User Manual
for details about embedded configurations, where the complete configuration of SMP devices
are embedded into the SMP Gateway configuration.

User Manual | page 34 Eaton


4 - SMP Manager

1. From the File menu of SMP Manager, choose Add SMP Device to add your SMP Gateway
to the list.

2. Type the name by which you want to identify your SMP Gateway in the Name box. Refer
to section Tree view display (page 39) for instructions on how to enter the name of an
SMP device for tree view display with groups.
Result:
The Configuration file box is automatically filled with a default configuration file name.
This is the file that will be created and opened by default in SMP Config. If you change this
file name afterwards, through the File menu, you must come back to this dialog box and
change the name in the Configuration File text box, so it opens the right file at startup.
3. In the Description box, type a short description of the SMP Gateway’s role and functions;
this property can be displayed in SMP Manager’s main window, as explained in Customizing
the display (page 38)
4. In the First IP Address box, type the IP address of the first Ethernet port. You can also type
the address of the second Ethernet port in the Second IP Address box, although it is not
necessary to do so.
5. If the SMP Gateway cannot be directly accessed through the network, but requires a dialup
connection, clear the Automatically poll SMP Gateway’s status at startup check box to
prevent SMP Manager from polling the gateway for its status.
6. To use a version of the SMP Tools that is different from the version of the software installed
on this specific SMP Gateway:
a. Select Use specific version.
b. Select the desired version in the corresponding box. This option should be used in specific
situations only. For example, if you need to prepare a .PAR file for a specific version and
the SMP Gateway is not available, or if you want to upgrade a .PAR file before the SMP
firmware is updated.

Note: Only versions for which a version pack is installed on the computer will be
available. To learn more about version packs, see Version Packs (page 280).

c. Otherwise, select Use same version as SMP Device.

Eaton User Manual | page 35


4 - SMP Manager

d. Click Add.
Result:
The SMP device gets added to the list, and SMP Manager automatically detects the
SMP device model and whether an internal modem is installed ( for the SMP 4/DP only).

4.4. SMP Manager polling mechanisms


SMP Manager offers two polling mechanisms for listed SMP devices, automatic and manual
polling.
Manual polling requires that the user specifically request a polling action via menu start/stop
polling SMP device; the polling action is maintained until stopped by the user.
Automatic polling is triggered by an action taken by SMP Manager or starting one of the SMP
Tools on an SMP device.

Note: These polling mechanisms are totally independent from the option Automatically
poll SMP device status at startup in the SMP Device Properties window. When selected,
the option only specifies to start polling the SMP device when you start SMP Manager; you
can stop and restart polling using the menu at all times once SMP Manager is started.

Here are the specific details:

Important: The Start Polling and Stop Polling commands are available if you right-
click on a selected SMP device or on a group in a tree view. The commands are also
available in the SMP Manager's top menu SMP Device > Start Polling or SMP Device >
Stop Polling. When it is mentioned to start or stop polling in the present section, you can
use both methods.

The manual polling mechanism:


• When you use Start Polling or Stop Polling on a selected SMP device, the polling action
will become permanent on the SMP device until the user takes action to start/stop polling
again.
• If the user starts the polling manually on an SMP device that was in an automatic polling
mode, the polling will become permanent until it is stopped by the user.
• When the SMP devices are displayed in tree view:
◦ When starting the polling on an SMP Gateway acting as the parent (Proxy Passthrough)
or on the Virtual Gateway in a redundancy setup, the polling will start only on the selected
SMP Gateway. If the polling is started again on the same SMP Gateway, which is already
polling, the polling is started on the children SMP devices.
◦ When starting the polling on a group of SMP devices organized together, the polling will
start on all SMP devices of the group. You can start the polling on a single SMP device of
the group when you select it and use the Start Polling command.
◦ Stopping the polling on the parent SMP Gateway will affect all SMP devices involved
(parent and children) in the tree.
◦ Stopping the polling on a selected group, will affect the whole group. You can stop the
polling of a single SMP device of the group when you select it and use the Stop Polling
command.

User Manual | page 36 Eaton


4 - SMP Manager

The automatic polling mechanism:


For all the following scenarios, unless specified otherwise, following an automatic polling start,
the polling will stop automatically five (5) minutes after the last action from SMP Manager on the
selected SMP device or five (5) minutes after the SMP Tools on that SMP device are closed.
• In all situations, when the automatic polling is activated on an SMP device, the Status of the
SMP device is displayed between square parentheses [<status of the SMP device>].
• When an SMP device is not polled and an action is taken by SMP Manager or one of the
Tools is launch on a an SMP device, the polling is automatically started on the SMP device.

Note: Starting the Web HMI on an SMP device is considered an action, not a Tool so,
the polling will stop 5 minutes after the Web HMI started, if no other action is taken on the
SMP device. However, the link to IED Manager Suite (IMS) that is normally accessible
from Tools > IED Manager Suite will be ignored.

• When the polling is disabled on an SMP Gateway acting as parent, all the children
SMP devices are grayed out even if the polling is activated. Those children SMP devices
behave normally.

• If the user starts the polling manually on an SMP device that was in an automatic polling
mode, the polling will become permanent until it is stopped by the user.

4.5. Information provided by the SMP Gateway icon


The SMP Gateway icon, which is displayed beside each gateway name, provides additional
information about the SMP Gateway.
The following table gives the meaning of each icon.
Table 2 - Status icons in SMP Manager
Icon Description

A device with two red LEDs. SMP Manager is unable to establish a connection with the gateway.

A device with flashing yellow and green LEDs. SMP Manager is connected to the gateway.

A blank page. A file (configuration file, new software, etc.) has been modified and will be
activated when the gateway is restarted.

A lined page and a pencil. A report is currently in progress. The report file provides detailed
information about the gateway. You should, therefore, send an SMP Gateway report file with any
request for technical support.

A device, flashing yellow and green LEDs and a yellow telephone. SMP Manager is connected
to the gateway via remote dial up.

A device and a telephone, grayed. The gateway is configured for remote dial up but not currently
connected to SMP Manager.

Eaton User Manual | page 37


4 - SMP Manager

Icon Description

A device with 2 red LEDs, and a yellow telephone. SMP Manager is unable to establish a
connection with the gateway over the remote dial up connection.

4.6. Customizing the display


You can customize the display in the SMP Manager window to suit your needs. You can choose
which columns you want to display, and the order in which you want them to appear.
Table 3 - Columns description in SMP Manager
Column Description

SMP Device The list of SMP Devices, including the SMP Gateways as well as, if you
request it, the Tools that are currently running for each SMP device in the list.

IP Address The IP address of any SMP Device you have displayed in SMP Manager. This
column is not available by default.

Status The current status of each SMP Device in the list (started, failed, safe mode,
max safe mode, on standby, and various intermediate states). Refer to section
The statuses of the SMP Gateway explained (page 44) for details on the
different statuses.

Platform The SMP Device model (ex. SMP 4/DP, SMP SG-4250, SMP SG-4260, etc.)

Version This column displays the SMP Device application version.

Firewall Whether the SMP Device integrated firewall is active. This information is
available only if your version of the SMP Device software supports security
features. This column is not available by default.

VPN Indicates if the SMP Device is connected to SMP Manager using VPN or
not. Please note that the SMP SG-42xx platform does not support VPN
connections.

Group This column shows a number which is assigned to a redundancy group; this
number is unique. This column is not available by default.

Redundancy This column indicates the current state of each SMP Device within a
redundancy group. This column is not available by default. Refer to section
SMP Manager Redundancy column (page 247) for details on the possible
states.

Security This column shows whether authentication is activated or not, locally or


through IED Manager Suite (Global), and how recent is the security database
stored on the SMP Device. This column is not available by default.

Description This column shows the Description property of the SMP Device, as
specified when the unit was added to the list of SMP Devices monitored in
SMP Manager.

User Manual | page 38 Eaton


4 - SMP Manager

Column Description

Serial Number This column shows, for each SMP Devices on the list, the unit’s serial number.
This column is not available by default.

IMS Description This column shows the description of the SMP Gateway in IMS when the
option IED Manager Suite is selected in SMP Manager (Tool > Options) and
the option Add IMS-integrated SMP devices to the list is also checked.

Note: The IMS Server's IP address must be properly configured and


the IMS server's certificate must be added to the Trusted Root certificate
of the computer hosting SMP Manager.

When it is configured to do so, you will be asked for the credentials of the IED
Manager Suite (IMS) server when starting SMP Manager. The information will
be displayed in the IMS Description column after a successful synchronization
with the IMS server.

4.6.1. Adding or removing a column


To toggle between displaying a column and removing it from the display:
• Right-click any column heading.
• From the shortcut menu, locate the column you are interested in. Put or remove a check
mark to add or remove the column to or from the display.

OR
• From the View menu, choose Columns, and then click the name of a column you want to
add or remove.

4.6.2. Changing the position of a column


To change the order of a column in the display:
• Click the column heading of the column you want to relocate.
• Drag the heading to the target location.

4.6.3. Tree view display


The list of SMP devices can be displayed in tree view in SMP Manager.
When SMP Manager contains a large number of SMP devices, it can be beneficial to use some
visual sorting to optimize device management. SMP manager provides a tree view option
allowing to group SMP devices depending on given group names which are added to the name
of an SMP device.
The number of levels of the tree view depends on the number of groups included in the Name
field of the SMP device; theses groups are separated by a "\" character.
The name of the SMP device, entered in the Name field of the SMP Device Properties window,
should be written the following way:
<group1>\<subgroup2>\...\<Name of the SMP Device>

Eaton User Manual | page 39


4 - SMP Manager

In the following example the name of the SMP Gateway documentation device, was written:
My office\SMP Gateway documentation in the Name field.

To activate the tree view in SMP Manager, select View > SMP Devices organized in a tree
view (you can also click directly on the tree view icon located in the toolbar, on the left side of
the filter icon). When selected, the icon is highlighted in pale blue; if you select it again, you will
return to a normal view. In the normal view, the name of the devices will however contain the
groups that are configured as levels, exactly as written in the Name field.
The tree view is also displayed in a parent/child situation, which happens when:
• A Proxy Passthrough communication is added in the configuration file of an SMP Gateway to
allow a child SMP device to be added behind a parent SMP Gateway, thus providing direct
access to the child SMP device in SMP Manager. Refer to section The Proxy Passthrough
feature (page 229).
• The complete configuration of an SMP device is embedded into the configuration file
of an SMP Gateway (only available for the SMP IO-2000 series for now). Refer to the
Embedded configurations, SMP Devices into an SMP Gateway - User Manual for details
about embedded configurations.

4.6.4. Searching for an SMP Device


SMP Manager provides a search function to help find an SMP Device among a large number of
managed devices. This search function works on text fields and makes no distinction between
lowercase and uppercase. The search function applies to all visible columns in SMP Manager
and on expanded/unexpanded branches of the tree view.
To search for one or several SMP Devices:

1. In SMP Manager, from the View menu, select Find an SMP Device (you can also click
directly on the magnifying glass icon located in the toolbar).
2. Enter the text string associated to the targeted SMP Device in the search field. The search
function applies to all visible columns.
3. Click OK.
4. If the text string matches with one of the managed SMP Devices, the first one on the list will
be highlighted in blue.

User Manual | page 40 Eaton


4 - SMP Manager

5. Press the F3 key to find the next one, and so forth; Shift + F3 will search in the opposite
direction. When no more matching string is found, it will start over, to the first SMP Device of
the list that was found.

4.6.5. Filtering SMP Devices displayed on SMP Manager

SMP Manager provides a filter function to limit the number of displayed SMP Devices in SMP
Manager. This function is very useful when SMP Manager displays a large number of managed
devices; it works on text fields and makes no distinction between lowercase and uppercase.
The filter function applies to all visible columns in SMP Manager and on expanded/unexpanded
branches of the tree view.
To apply a filter in SMP Manager:

1. In SMP Manager, from the View menu, select Filter SMP Devices (you can also click
directly on the filter icon located in the toolbar).
2. Enter the text string in the field to display only SMP Devices that match with this text string.
The search function applies to all visible columns.
3. Click OK.
4. The SMP Devices that match with the text string of the filter are then the only ones displayed
in SMP Manager.
5. When the filter function is applied in SMP Manager, the icon is highlighted in pale blue in the
toolbar. If you click on the Filter icon or select View > Filter SMP Devices again, the filter
function is deactivated (icon is not highlighted) and all SMP Devices are displayed.

Note: The text from the latest filtering operation stays in the field of the filter option,
even when the filter function is deactivated.

4.7. Connecting with IED Manager Suite


SMP Manager allows to retrieve a list of SMP devices from IED Manager Suite (IMS). It also
allows to launch a Web browser and connect to an SMP device's General page in IMS - IED
Manager. These functions provide an easy access to SMP devices managed by IMS, directly
from SMP Manager.

To use these functions, you must have an IED Manager Suite (IMS) license. If you do not have
such a license and would be interested to know more about the product, consult our Eaton
Web site at Eaton's IED Manager Suite or contact Eaton's technical support. If you have an IED
Manager Suite (IMS) license, refer to the IMS documentation for details (especially the following
documents: Supporting Devices with IMS - Reference Guide and IMS - Installation Guide).
The following icon in SMP Manager's toolbar allows to open a selected SMP device that
is managed in IED Manager Suite (IMS) directly in IED Manager. To be able to do that, some
configuration settings must be changed (to be configured only once) and an SMP Device
managed by IMS must be selected, otherwise the icon is grayed out and non-operational.

Eaton User Manual | page 41


4 - SMP Manager

Note: When SMP Manager is all setup to connect with IMS, you will see the list of
SMP devices managed by the IMS server. This list is organized in tree view, according to the
IMS nomenclature. If you select an SMP device that is part of this list and you click on the
IED Manager Suite icon in the tool bar, you launch the Web browser which is setup to reach
the selected SMP device via IED Manager.

To setup SMP Manager to connect to IMS and launch IED Manager:

1. You must first setup SMP Manager to connect to IMS (if your SMP Manager is already setup,
skip this step):
a. Make sure that the certificate used by IMS are thrusted by computer hosting SMP
Manager.

Note: This procedure is documented in the document IMS - Installation Guide,


section Installing IMS certificate authority on computers hosting client applications.

b. In SMP Manager, select Tools and then select Options.


c. In the Options window, put a check mark next to Use IED Manager Suite.
d. Enter the IMS server IP address in the Server box.
e. Configure the option Use current Windows user's credential according to the chosen
authentication method.
f. Check the option Add IMS-integrated SMP Devices to the list.
g. Click OK.
h. In SMP Manager, select an SMP device and then select Change Current Login.
i. Specify the login you use to access IMS (User name and Password) and select IED
Manager Suite in the Authentication drop-down menu.
j. Click OK.
Result:
The list of SMP devices managed by the configured IMS server will be displayed on
SMP Manager. The IMS Description column will be populated for these devices.
2. To launch the IMS - IED Manager application for a selected SMP device:
a. Select the SMP device that you want to open in IED Manager. The SMP device must
belong to the list of devices managed by IMS.
b. The IED Manager Suite icon should not be grayed out and appear like this icon , click
on the icon (or use the menu: Tools > IED Manager Suite).
c. IED Manager's login page will be displayed, enter your credentials if necessary (it
depends of your authentication setup).

Note: Refer to the IED Manager Suite documentation for details about
authentication.

d. You will then land directly on the General page of the SMP device that you selected in
SMP Manager.

User Manual | page 42 Eaton


4 - SMP Manager

Eaton User Manual | page 43


4 - SMP Manager

4.8. The statuses of the SMP Gateway explained


The following table explains the different statuses of the SMP Gateway, the possible reasons the SMP device could display a certain status and
finally, the actions that the user can take to remedy the situation if the SMP device has an unwanted status. All these modes are stable modes.
Table 4 - Description of SMP Gateway statuses
Required action to remedy the situation and additional
Status Possible reason information

Started This is the default mode, normal operating mode of the No problems were detected; normal operation.
SMP device.

Protocol(s) failed To find the cause, look in the Startup log to identify the component • If you have a missing component, ensure that your license
causing the problem. includes the problematic component.
• If your configuration file has the wrong version, convert it to the
SMP device's version (open the configuration file (.par), validate
and save it, send it to the SMP device).
• For other causes, it depend of the information provided by the
logs. If you don't know what to do, generate an SMP device report
and contact Eaton's technical assistance for further instructions.

User Manual | page 44 Eaton


4 - SMP Manager

Required action to remedy the situation and additional


Status Possible reason information

Safe Mode When expected: • If you previously requested a Safe Mode restart and you now
When the SMP device is in Safe • Restart command: From SMP Manager: SMP device > Restart want to start normally, restart the SMP device (remove the check
Mode, all communication with (with the Force a safe mode restart option checked). mark for the Force a safe mode restart option), Refer to section
the control centers and IEDs are Restarting the SMP Gateway (page 50) for details.
interrupted. Maintenance access
remain possible to diagnose the
problem and restore functionality. When not expected: • If its a license problem, load a valid license to the SMP device.
To find the cause, look first in the Reset log. Refer to section Activating a new license (page 285) for details.
Possible causes: • If the Security log indicates that there is a problem with a DLL
of EXE file (integrity check), refer to section Recovering from an
• The license is expired or not loaded.
integrity failure (page 212).
• Integrity check, problem with a DLL or EXE file.
• Verify the configuration file and send it again to the SMP device.
• Could be triggered automatically following several consecutive
• For other causes, generate an SMP device report and contact
crashes happening when the settings are loaded (configuration
Eaton's technical assistance for further instructions.
file).
• In a redundant setup, if there is a constant switch over between
the active and standby gateways, to prevent the switch over and
allow problem investigation.

Eaton User Manual | page 45


4 - SMP Manager

Required action to remedy the situation and additional


Status Possible reason information

When expected: • The user must update the firmware after a factory reset. From
• After a factory reset SMP Manager: Update > Update Firmware.
• Exceptionally, when requested by the user:
Note: Following a firmware update, it is normal that the
◦ Restart command (this procedure is not documented,it is
versions of the bootstrap programs and rescue operating
provided by an Eaton's support representative, if needed).
system components remain unchanged. These components
◦ Using the front panel button while the SMP device is starting are factory installed and do not change over the lifespan of the
(firewall-related problems). SMP device.

• If an Eaton's support representative guided you in restarting the


SMP device in Max Safe Mode, you will be guided to bring your
device in an operational mode when the problem is resolved.
• If you used the front panel button because of a firewall-related
problem, follow instructions in section Firewall-related problems
(page 304).
Max Safe Mode
When the SMP device is in Max
When not expected: From SMP Manager, restart in Safe Mode. Refer to section Restarting
Safe Mode, it is still accessible
• No application was found on the SMP device. the SMP Gateway (page 50) for details. After that:
from SMP Manager with partial
• Following several consecutive crashes happening right after • If the SMP device starts in Max Safe mode again, this means that
access to maintenance, file
startup. no application is present in the SMP device or that the file system
transfer and SMP Console.
is corrupted.
• File system corruption.
Resend the firmware to the SMP device: from SMP Manager:
Update > Update Firmware. If the SMP device starts again in Max
Safe mode after the firmware update, contact Eaton's technical
assistance.

Note: Following a firmware update, it is normal that the


versions of the bootstrap programs and rescue operating
system components remain unchanged. These components
are factory installed and do not change over the lifespan of the
SMP device.

• If the SMP device starts in Safe Mode, this means that several
crashes occurred after startup. Generate an SMP device Report
and contact Eaton's technical assistance for further instructions.

User Manual | page 46 Eaton


4 - SMP Manager

Required action to remedy the situation and additional


Status Possible reason information

When expected: This mode is used only in rare situations and the user is guided by an
• In exceptional circumstances, this mode is induced by the user Eaton's support representative.
at the request of Eaton's technical support (the procedure is
provided by the support representative).

When not expected: When in this mode, the first thing to be done is to resend the firmware
Rescue • When the Max Safe Mode can't be reached. The firmware can (from SMP Manager: Update > Update Firmware).
When the SMP device is in be corrupted or missing.
Rescue Mode, it is still accessible Note: Following a firmware update, it is normal that the
• File system corruption.
from SMP Manager with partial versions of the bootstrap programs and rescue operating system
access to maintenance, file components remain unchanged. These components are factory
transfer and SMP Console. installed and do not change over the lifespan of the SMP device.

After that, when SMP Manager suggest a Restart, select no. Instead,
launch SMP Console and type the following command: pkgmgr. This
command will start the processing of the newly uploaded firmware.
If after that procedure the SMP device is still starting in Rescue mode,
please generate an SMP Device Report and contact Eaton's technical
assistance for further instructions.

Standby When two SMP devices are grouped for redundancy and the Refer to section Redundancy (page 244) for details.
The standby gateway initializes SMP device is in standby. The active and standby gateways are communicating with each other
itself, places its serial links in a so that when the active gateway fails, the standby one becomes
high-impedance state and waits to active.
become active.

Note: Refer to the technical note System integrity checking mechanisms, MN912132EN (available also in French) for additional details on
the relation of some system check and the status of the SMP device.

Eaton User Manual | page 47


4 - SMP Manager

4.9. The statuses of the Local Configuration column


explained
The Local Configuration column displays the status of the local configuration file compared to
the one loaded on the SMP Device. The local configuration file is the file that is configured in the
SMP Device Properties window, in the Configuration file field.

Note: The comparison applies only to the configuration file (.par), other file types like
a .hmi or a SoftPLC application (CODESYS project) that is not embedded into the .par file,
are excluded from the comparison process.

The comparison process is not binary; the mechanism takes into account only the settings
applicable to the SMP device, not the specifics associated to the configuration tool used to
create the file (SMP Config, 61850 Config, etc.), the date and name of the file in the file system.
From the retrieved information, SMP Manager matches the local file against the file on the SMP
Gateway. The Local Configuration column can display the following status:
• Synchronized: The two files contain equivalent settings.
• Newer: The two files are different; the local configuration file is more recent than the one on
the SMP device.
• Older: The two files are different; the local configuration file is older than the one on the
SMP device.
• Unknown: All scenarios where a file comparison is not possible, for example, unknown
version, invalid files, etc.
• Not Found: The local file specified in the SMP Device Properties window cannot be found.
• Empty (no status):
◦ The function is not supported by the SMP Device (version of the SMP Gateway older than
8.1R2 and older than 1.6R1 for the SMP IO-2000).
◦ There is no file specified in the Configuration file field of the SMP Device Properties
window.
◦ The function is not supported when the SMP device is in Rescue mode.

Note: A suffix is added to the Synchronized, Newer and Older statuses if the local file
contains errors; for example, Newer (Errors).

The information last obtained from the configuration file on the SMP device is persisted like the
platform, the version, etc. It allows to update the Local Configuration column when there is a
change in the local configuration file even when the polling to the SMP device is not activated or
after restarting SMP Manager.
If the configuration file of an SMP Gateway includes one or several embedded configurations of
SMP devices of the SMP IO-2000 series, the comparison will apply only to the corresponding
SMP device. This means that only the configuration part corresponding to the SMP Gateway
will be taken into account for the SMP Gateway and only the configuration part corresponding

User Manual | page 48 Eaton


4 - SMP Manager

to a specific SMP device of the SMP IO-2000 series will be taken into account for the specific
SMP device that have its configuration included in the SMP Gateway configuration file. Refer
to the Embedded configurations, SMP Devices into an SMP Gateway - User Manual for details
about embedded configurations.

4.10. Selecting the Web browser used by SMP


Manager
The Web browser used by SMP Manager is configurable.

By default, SMP Manager will use the default Web browser that is configured on the computer
hosting SMP Manager. It is however configurable.

Note: Some exceptions apply: for SMP Gateways running the SMP Gateway Software
and Tools version 7 and earlier, Internet Explorer is always used and it is not configurable.
Also, for versions 7.1 and later, if the default Web browser is Internet Explorer and Chrome
is installed on the computer, Chrome will be used as the Web browser for SMP Manager,
unless the user changes the configuration.

To configure the Web browser used by SMP Manager:

1. Open SMP Manager.


2. Select Options from the Tools menu.
3. Click on the Tools Location button.
4. Select Web HMI in the list of Tools.
5. Click on the Browse button and navigate to select the execution file (.exe) of the Web
browser you want to use with SMP Manager.

Eaton User Manual | page 49


4 - SMP Manager

4.11. Changing the current login in SMP Manager


If the Login Information window is not displayed upon startup, here is how you can access it:
• From the Security menu, choose Change Current Login.

• Enter the credentials of the SMP Device local account you want to use, for this
SMP Manager session, to authenticate with all SMP Devices, and then click OK.

4.12. Restarting the SMP Gateway


Users can restart the SMP Gateway by first selecting the SMP Gateway and then using the
SMP Device > Restart option from the SMP Manager’s menu.
When the user clicks on the Apply button, the SMP Gateway or SMP device chooses the type
of restart to perform depending on the system conditions and on the changes introduced by the
user.

Note: If the configuration file transfer to the SMP device is unsuccessful, the SMP device
will not be restarted. Also, in the situation where only a .par file is sent to the SMP Gateway,
the transferred file (.par) will be copied to the SMP Gateway if the file is seen as equivalent to
the file already in use, regardless of the status displayed in the Local Configuration column,
no restart will be initiated.

The SMP Gateway will either restart using a Soft (default), Full or Safe Mode Restart. The
chosen restart type will allow the shortest possible boot process and have the lowest possible
impact on the connections with the SCADA and other devices.

User Manual | page 50 Eaton


4 - SMP Manager

All restarts are automatically logged in the SMP Gateway Reset log file. If you want to, you can
type a comment in order to indicate why you restarted the SMP Gateway . This comment will
be included in the log entry. The SMP Gateway HMI’s System Dashboard displays the SMP
Gateway startup time.

Note: When the only change is related to the SMP Gateway HMI (upload of a .hmi file to
the SMP Gateway), a Soft Restart is performed and the communication with the SCADA
is unaffected. Moreover, the SMP Gateway HMI connection is automatically reconnected in
the case of a non-secure connection. However, in a redundancy configuration, a full restart is
always performed on the SMP Gateway units that are part of the group, independently of the
modifications brought to the system.

4.12.1. Forcing a safe mode restart


When an SMP Gateway is in safe mode, there is no communication between the devices and
the SMP Gateway. The SMP Gateway can go into Safe Mode without the user asking for a
Restart in case of an integrity check failure; this situation is discussed in another section of this
manual.
A user may want a restart in Safe Mode for exceptional situations such as:
• After consecutive SMP Gateway crashes, to maximize the chances to get a gateway report
for crash investigation.
• If the user does not want the SMP Gateway to connect to its IEDs, for various reasons like
maintenance or problem investigation on the IEDs.
• In a redundant setup, if there is a constant switch over between the active and standby
gateways, to prevent the switch over and allow problem investigation.
• For any SMP Gateway stability problem, to allow problem analysis.

To force a safe mode restart:


• In SMP Manager, select the SMP Gateway that need to be restarted in Safe mode.
• Click on SMP Device, from the top menu and select Restart.
• In the Restart SMP Device window, put a check mark in the Force a safe mode restart box.
• Click on the Restart button.

Eaton User Manual | page 51


5. Configuring the SMP Gateway
Configuring the SMP Gateway using SMP Config tool.
As we saw in the section Principles of operation (page 20) the user must configure the
SMP Gateway before using it. For this, the SMP Config tool is used to define the characteristics
of the SMP Gateway and the functions it has to perform. The configuration is stored in a file that
is then loaded onto the SMP Gateway, where it is stored in non-volatile flash memory.
Using SMP Config, you will perform the following configuration steps:
• For the SMP SG-42xx automation platform models, define the hardware options installed.

Note: To facilitate device migration within the SMP SG-42xx platform, an SMP SG-4260
can run an existing configuration file that was configured for an SMP SG-4250 model. On
the other hand, it is not possible for the SMP SG-4250 to accept a configuration file that
was defined for an SMP SG-4260 model, the hardware type must be modified to match the
specific model.

• Create a master protocol instance for each device to be supported.


• Define each data point on each device.
• Configure the communications link to be used to connect to each device.
• Create a slave protocol instance for each SCADA or control center.
• Configure the communications link to be used to connect to the SCADA.
• Map the device data points to SCADA data points.

You will then use SMP Manager to send the configuration file to the SMP Gateway.

5.1. Creating a configuration file


To create a configuration file for your SMP Gateway:

1. Start SMP Manager.


2. Select the SMP Gateway.
3. From the Tools menu, choose SMP Config to start the application.

User Manual | page 52 Eaton


5 - Configuring the SMP Gateway

The SMP Config display includes 3 panes. The left pane is a tree structure of all the
configuration topics. The top right pane displays the settings for the topic you have selected
in the left pane. The bottom right pane appears when your request that the configuration be
validated; it displays error and warning messages.
The gateway name is the name you assigned when you added the SMP Gateway in
SMP Manager. The configuration file name on the title bar was also assigned when you added
the SMP Gateway in SMP Manager.
If you open the Master Protocols and Slave Protocols branches, you will see that the tree
structure offers you a fixed set of protocols. These are the protocols currently supported by your
product license.

5.2. Saving a configuration file with errors


Saving a configuration file containing errors is allowed, however you end up with an invalid
configuration file.
This section provides information regarding the behavior of SMP Manager and the SMP Device
as well as the content of the logs when an invalid configuration file is sent to the SMP Device,
for different SMP Software and Tools versions running on SMP Manager and on an SMP
Device.
SMP Manager and SMP Device running version 8.1R1:
When saving the configuration file, a message will display a warning. If you send this file to the
SMP Device without correcting it, you will get another message warning informing you that the
file is not valid and the SMP Device will display the Invalid configuration file status at startup.
The logs will indicate : Configuration File Contains Errors.
SMP Manager running 8.1R1 and SMP Device running a version earlier than 8.1R1:
The behavior is the same as when both SMP Manager and the SMP Device are running version
8.1R1 except the logs will indicate that a version number of a component is not up to date.
SMP Manager is running version earlier 8.1R1:
When sending the configuration file, no message will be displayed but the startup sequence will
be interrupted.

Eaton User Manual | page 53


5 - Configuring the SMP Gateway

Important: When you get an error when saving a configuration file, you must correct the
error using the same editor that detected the error and issued the warning message (SMP
Config or 61850 Config).

5.3. Opening configuration files


SMP Software and Tools, version 8.0R1 or later, allows the user to open multiple configuration
files simultaneously (SMP Config or 61850 Config).
This feature is very useful to copy and paste protocol components from one configuration file to
another one or to compare files. When opening multiple configuration files windows of the same
file, the first file opened, will have read/write capabilities; the others will be read only.
It is possible to open configuration files:
• From SMP Manager, the SMP Gateway must be selected and attached to an SMP
configuration file (SMP Device Properties)
◦ Using the menu: Tools → SMP Config or 61850 Config
◦ Using the SMP Config or 61850 Config icon in SMP Manager’s Toolbar
• From Windows’ File Explorer application (SMP Software and Tools version 8.0 or later must
be installed on the computer)
◦ Right-click on an SMP Config (.par) or Template file (.tpl) and select Open to open the
configuration file using the same SMP Config version pack used to create the file.
◦ For additional options, an add-in named SMP Configuration Launcher is available when
right-clicking on a SMP Config (.par) or Template (.tpl) file. The contextual menu offers the
following options:
■ Show Version: Displays the configuration (.par) or template (.tpl) version pack number
under which the file was saved.
■ Open with: Opens a window allowing the user to select the version pack number under
which the user wants to open the configuration or template file.
The version number shown by default is associated to the SMP device type (Gateway
or IO) under which the configuration file was created. For example if you open a
configuration file for an SMP Gateway, the first box displays Gateway and the second
box displays the actual version pack number under which the configuration file was
create; it allows the user to select a another version pack number to open the file.
Once the version pack number is selected, the user chooses to open the file with SMP
Config or 61850 Config.
■ Open with 61850 Config: used to open the configuration file with the 61850 Config
version pack number under which the file was saved.

Note: SMP Manager, version 7.2 or earlier, allows only one SMP Config file to be
open at once.

User Manual | page 54 Eaton


5 - Configuring the SMP Gateway

5.4. Creating master protocol instances


You need to add a master protocol instance for each device (IED) you want to access with your
SMP Gateway.

Note: Refer to Introducing the SMP Gateway in the automation system (page 21)

Even if a number of IED share a multidrop link, each of them requires its own master protocol
instance. Each IED is a slave, so the gateway acts as a master when communicating with the
IED, which is why it requires a master protocol instance.
There are many ways to add the master protocol instance:
• You can import or simply copy and paste a master protocol instance form another
configuration file (.par) which contains a similar master protocol instance (same IED). This
is the easiest way; you can use the same point list as the protocol instance you selected to
create the new instance.
• You can use a template, which eases the task of configuring the master protocol instance,
by automatically entering the points list for the device. SMP Config provides templates for a
number of commonly used substation devices.
• If no template or configuration file with a similar protocol instance is available, you will need
to enter the points list. If you are configuring a number of IED of the same type, you can save
the first device configuration as a template or simply save the configuration file and use it to
configure other devices.
• Some protocol components allow to be configured using the autoconfiguration function. To
use this function, you may need to connect to the device at configuration time, in order to
extract the information directly from the IED while some other protocols will use an existing
file to do so. (Example of protocol components allowing the autoconfiguration function: SEL
Fast Meter relays, Interconnections, DNP3, Areva (Courrier) and IEEE C37.118)

Once you have added a master protocol instance and entered its data points (manually, via a
file, a configuration or a template file, or using the autoconfiguration function), you can click a
particular data point type in the left pane and see the list of data points and their settings in the
right pane, as shown next.

Eaton User Manual | page 55


5 - Configuring the SMP Gateway

5.4.1. Creating a master protocol instance by importing it from


another configuration file
To create a master protocol instance by importing it from another configuration file:

1. In the left pane of SMP Config, expand the Master Protocols branch, and then select the
branch of the protocol for which you want to create an instance based on an available
protocol.
2. From the Tools menu, choose Import from File.
3. The Open File window opens in the SMP Config directory, select the desired configuration
file, and then click Open.
4. The Import Instance form File window opens and the master protocol components using
the same protocol as the selected one are available for selection in the Source selector box.
Select the master protocol component you want to use to create a master protocol instance.
Result:

5. In the New Instance Name box, type the name of the master protocol instance to create.
6. In the New Prefix box, type the device prefix that will be added to the name of this instance’s
data points.
7. Put a check mark in the Duplicate alarms box if you want the alarms that belong to the
actual file (if applicable) to be duplicated for the new master protocol instance.
8. Put a check mark in the Duplicate sequence of events box if you want the sequence
of events that belong to the actual file (if applicable) to be duplicated for the new master
protocol instance.
9. Click OK.

What to do next:
Another way to achieve the same result is to copy and paste the protocol component from
another SMP Config file. Because SMP Manager Version 8.0R1 and later supports many SMP
Config files opened simultaneously, you can simply open the SMP Config file containing a
similar master protocol instance.

User Manual | page 56 Eaton


5 - Configuring the SMP Gateway

5.4.2. Creating a master protocol instance by copying it from


another SMP Config file
To create a master protocol instance by copying it from another SMP Config file :

Note: A single SMP Config file can be open at once if you are using SMP Manager
version 7.2 and earlier.

1. Open the SMP Config file in which you want to add a master protocol instance (SMP Config
1 in the example).
2. In the left pane of SMP Config, expand the Master Protocols branch, and then select the
branch of the protocol for which you want to create an instance based on an available
protocol (SMP Config 1 in the example).
3. Open the SMP Config file from which you want to copy the master protocol instance (SMP
Config 2 in the example).
4. In the left pane of SMP Config, expand the Master Protocols branch, and then select the
branch of the protocol from which you want to copy an instance (SMP Config 2 in the
example).
5. Select the master protocol instance to copy and right-click on it; select Copy (SMP Config 2
in the example).
6. In the SMP Config file in which you want to copy the protocol instance, simply click in the left
panel, right-click and select Paste. The protocol instance will be placed in the corresponding
protocol branch (SMP Config 1 in the example).
7. The protocol instance is copied with the same name (with an incrementing number if the
name already exists in the destination file); associated alarms, SOE, Automation Functions
are replicated in the destination file, if applicable.

5.4.3. Creating a master protocol instance from a template


To create a master protocol instance from a template:

1. In the left pane, open the Master Protocols branch, to display the list of master protocols
provided under your product license.
2. In the left pane, click the protocol for which you want to add an instance. The list of all
defined master protocol instances appears in the right pane.
3. From the Tools menu, choose Import from File.
4. Navigate through the directory corresponding to the selected protocol and click on it. The
templates corresponding to this protocol, if any, are listed as .tpl files.
5. Choose the appropriate template, and click Open.
Result:

Eaton User Manual | page 57


5 - Configuring the SMP Gateway

6. In the dialog box, enter:


a. Some templates include configurations for different device types (e.g., SEL Fast
Meter protocol). Select the right device in the Source selection box.
b. The name of the new instance. The following characters cannot be used as part of an
instance name: the comma (,), the quotation mark (") and the slash (/).
c. The device prefix. The device prefix is a string that identifies the device and is used as
a prefix for all of its data point names. The prefix ensures that every name in the system
is unique. An explanation of the usage of prefixes is provided under section Device prefix
and naming conventions for data points (page 60).
d. Put a check mark in the Duplicate alarms box if you want the alarms that belong to the
template (if applicable) to be duplicated for the new master protocol instance.
e. Put a check mark in the Duplicate sequence of events box if you want the sequence
of events that belong to the template (if applicable) to be duplicated for the new master
protocol instance.
f. Click OK.

The new instance appears in the left pane. If you open its tree structure and click the various
physical data point types, all the data points supported by the device will be displayed in the
right pane.

Note: The following reserved words and characters cannot be used as part of a device
prefix: the word “_smp” (which is the device prefix of system data points), the comma (,), the
quotation mark ("), the semicolon (;) and the grave accent (`).

5.4.4. Creating a master protocol instance manually


To create a master protocol instance manually:

1. In the left pane, open the Master Protocols branch, to display the list of master protocols
provided under your product license.
2. In the left pane, click the protocol for which you want to add an instance. The list of all
defined master protocol instances appears in the right pane.

User Manual | page 58 Eaton


5 - Configuring the SMP Gateway

3. In the right pane, type the name of the new instance at the end of the list of names, and click
on a free space on the left pane.
Result:

Note: The following characters cannot be used as part of an instance name: the
comma (,), the quotation mark (") and the slash (/).

The new protocol instance is added in the left pane, under the protocol type you had
selected. If you expand its tree branch and click an item, the corresponding protocol
settings will be displayed in the right pane. Note that if you click a physical data point type
in the left pane, the right pane will display an empty row since you will have to add the
physical data points manually.

5.4.5. Creating a master protocol instance using the


autoconfiguration function
To create a master protocol instance using the autoconfiguration function (for the protocol
instances that support the autoconfiguration function):

1. In the left pane, open the Master Protocols branch, to display the list of master protocols
provided under your product license.
2. In the left pane, click the protocol for which you want to add an instance. The list of all
defined master protocol instances appears in the right pane.
3. In the right pane, type the Name of the new instance at the end of the list of names, and
click on a free space on the left pane. The following characters cannot be used as part of an
instance name: the comma (,), the quotation mark (") and the slash (/).
4. The new instance appears in the left pane. Open its tree structure and click on General.
5. Type the Device Prefix in the appropriate cell on the right page.
6. In the left pane, right-click on the instance name and select Import Points.
7. The Auto Configuration Windows opens and, depending on the protocol using the
autoconfiguration, you must either :
a. Enter the Communication settings to retrieve information from the device (e.g., SEL
Fast Meter, Areva (Courrier), IEEE C37.118). When applicable, select the required
configuration data.
b. Select a file (e.g., .xml for DNP3 and .par for Interconnections).
Result:

Note: Refer to the selected protocol reference manual for details about the
specificity of the autoconfiguration feature.

c. Click Connect.
8. The Import Points window opens to show the progression of the points extraction operation.
9. Close the window when the Finish – No More Data!! Success message is displayed.
10. The Update Data Points window opens to activate the reconciliation process between the
IED and the protocol instance configuration. Go through the Reconciliation process and click
Update.

Eaton User Manual | page 59


5 - Configuring the SMP Gateway

The master protocol instance is created.

5.4.6. Device prefix and naming conventions for data points


A typical substation automation project requires the configuration of thousands of data points.
You can significantly reduce the effort by carefully planning how to name devices and data
points. Eaton tools provide additional functionality if the names of data points are based on
some type of convention. For our engineering projects, we use a naming convention such as the
following:
• A data source name, such as the substation name: MAPLE, CEDAR.
• A voltage level: 220 or 25.
• A device name: L1 to indicate a line, T1 to indicate a transformer, F1 to indicate a feeder,
BUS for a bus bar.
• A signal name: V_phsA_mag to indicate the phase A voltage magnitude, A_phsA_mag to
indicate the phase A current magnitude, Pos_st to indicate the status of a breaker or a line
switch.

With such a convention, a data point called CEDAR_220_BUS_V_phsA_mag clearly indicates


the voltage magnitude of phase A on the 220 kV bus of the CEDAR substation. A data point
called MAPLE_025_F1_Pos_st indicates the status of the breaker switch of feeder 1 at the
Maple substation.

5.4.7. Data point name’s length and alternate names


To comply with the IEC 61850 standard and to accommodate any complicated facility topology,
which can result in a complex user defined naming convention; a data point name can contain
up to 131 characters, including a prefix of a maximum of 67 characters.
For compatibility purposes, in case data point names longer than 39 characters are not
supported by third party systems, SMP Config allows the user to select an operating mode to
permit the use, or not, of the maximum data point length, which is set to 131 characters.
The operating modes related to the data points length can be selected in the SMP Config tree
structure under:
System > Point Dictionary
Select the Point Directory branch and, in the middle pane select the appropriate Mode from
the drop-down menu.
• Compatibility mode: This mode allows using data point names with a maximum of 39
characters only, for compatibility reasons (The prefix can be as long as 38 characters).
• Standard mode: This is the default mode (IEC 61850 compliant); it allows the use of data
point names with the maximum length only (131 characters); this means that when using this
mode, all client tools and third party systems exchanging data points with the SMP Gateway
must support data point names with 131 characters. The newest versions of these tools must
be installed.

User Manual | page 60 Eaton


5 - Configuring the SMP Gateway

• Standard mode, with compatibility support: This mode allow the use of data point names
with the maximum length (131 characters), but also provides the possibility of defining an
Alternate name with a maximum of 39 characters in order to remain compatible with older
client tools and third party systems. Both names can be used within the SMP Software and
Tools applications but Alternate names will be used if the longer ones are not supported
externally.

When the system is setup using the Standard mode, with compatibility support, SMP Config
allows the use of Alternate names, which must be defined by the user, and shall not exceed 39
characters.
The user may, at any time, disable, create or modify an Alternate name to fit its own naming
convention, as long as the name remains unique within the configuration file and does not
contain more than 39 characters. The user can also create an alternate name for a shorter data
point name that does not exceed 39 characters.
Alternate names, for the whole configuration file, are defined in SMP Config in the Point
Dictionary's Alternate Points Names table which can be found in the SMP Config tree structure
under:
System > Point Dictionary > Point Alternate name
To ease data points search among a large number of points, the user can select predefined
filters (independently from the operating mode). To use these filters, expand the Filters branch
and select the filter you need among the following filters:
• System: displays system data point names only
• Long: displays data point names that exceed 39 characters only; with or without an Alternate
name associated.
• Long (Incomplete): displays data point names that exceed 39 characters only, which do not
have an Alternate name associated.
• Custom: displays specific user defined searches; the user must simply enter the character-
string in the Tags Name Filter cell and click anywhere on the SMP Config windows to
confirm the entry. Data point names containing this specific string will be displayed in the
results pane.

5.4.7.1. Automatic generation of IEC 61850 compliant point names in IEC 61850
master instances
SMP Config can generate IEC 61850 compliant point names (up to 131 characters) for an IEC
61850 master instances that still contain shorter point names (up to 40 characters).
The function can generate IEC 61850 compliant point names without having to delete and
recreate the master instance.
To generate IEC 61850 compliant point names for an IEC 61850 master protocol instance:
• In SMP Config, make sure that the selected mode in the Point Dictionary Setting window
(System/Point Dictionary branch) is set to either:
◦ Standard Mode
◦ Standard mode with Compatibility support
• Select the IEC 61850 master protocol and use the menu Tools > Regenerate 61850 point
names.
◦ The current point names (short point names) that are activated are added to the Alternate
Point Names (System/Point Dictionary/Alternate Point Names branch). The point names
that are disabled are not converted to speed up the process.

Eaton User Manual | page 61


5 - Configuring the SMP Gateway

◦ The new generated point names replacing the shorter ones follow this naming convention
(up to 131 characters):<master instance prefix>_<name of the IEC 61850 master
logical device>/<current point name>
◦ The slaves protocol instances subscribing to theses points have their point names
updated as well, except for the IEC61850 slaves which can still use the alternate names.
◦ Alarms, Diagrams and Sequence of Events also have their point names updated.

• SoftPLC functions are not updated; if you are using a SoftPLC instance, you must define
aliases and adjust the logic to use the aliases before executing it.

Note: If a large quantity of points are involved, the operation can take a while.

5.4.8. Configuring the master protocol general settings


All master protocol components share common settings that define how they interact with a
device.

If you created the protocol instance from a configuration file or from a template, the general
settings have been defined for you. However, you should verify the settings to make sure
they match your device configuration, and you should familiarize yourself with the naming
conventions discussed in this section.
To specify general settings for a master protocol:

1. In the left pane, click General to display the list of general settings for the selected protocol.
2. In the right pane, type a Device Prefix. The string you enter will be used as a prefix for all
the I/O point names of the device. It is mandatory for each instance of a protocol. It is used
to distinguish data point names that are on the same device type, but on multiple physical
devices. The device prefix ensures that every data point name in the system is unique.
Device prefixes are described in the Device prefix and naming conventions for data points
(page 60).

Note: The following reserved words and characters cannot be used as part of a
device prefix: the word “_smp” (which is the device prefix of system data points), the
comma (,), the quotation mark ("), the semicolon (;) and the grave accent (`).

3. Still in the General settings, enter the scanning settings. For instance, to configure a
MODBUS master protocol, you would provide settings such as the following:
a. A Device Address, typically 1
b. A MODBUS Type, typically RTU Serial
c. A Scan Interval, typically 1000 milliseconds
Result:
A complete description of the most common settings is provided in the document entitled
SMP Gateway Protocol Common Concepts Reference Manual. Protocol-specific settings
are described in individual documents, such as the DNP3 Master Protocol Reference
Manual.

User Manual | page 62 Eaton


5 - Configuring the SMP Gateway

Note: The following characters cannot be used as part of a data point name: the
comma (,), the quotation mark ("), the semicolon (;) and the grave accent (`).

5.4.9. Accessing protocol-specific documentation


There are Eaton documents available, to which you can refer for details on the settings of the
currently supported protocols.

To access the documents:

1. From Windows’ Start menu, select All Programs > Eaton SMP Gateway Documentation >
Version pack number > Documentation > Protocols.
Result:
The list of protocol reference manuals available for that specific version of the
SMP Gateway Software and Tools is displayed in an explorer window.
2. Double-click the document you want to read.

Note: Adobe Reader is required to open these documents.

5.5. Configuring the data points


Once you have provided the general settings of the protocol component, you then enter all the
data points on the device. If you created the protocol instance from an existing configuration file
or a template file, all the data points have already been added; however, we suggest you read
this section for your information.
A physical data point (Physical Inputs or Outputs) represents a real-life value, implemented on
an external device. You need to identify all the device data points, either manually or using a
device template or using a protocol instance in an existing configuration file.

Note: the SEL Fast Meter protocol instances use the terms Meter, Demand, Peak,
Breaker Bits and Remote Bits inputs instead of Physical inputs for the Analog Inputs.

A system (logical) data point (Logical Inputs or Outputs) is a value managed by the
SMP Gateway. These data points are available by default on the system and cannot be
modified, but they can be deactivated.
Protocol components typically support physical and logical data points of the following types:
• Analog inputs
• Binary inputs
• Analog outputs
• Binary outputs

Eaton User Manual | page 63


5 - Configuring the SMP Gateway

Analog inputs
Analog inputs are measured values. The system keeps 2 values for each analog measurement
obtained: a raw value, which is usually the value retrieved from the device, and a calculated
value expressed in engineering units, obtained using the following standard formula:
Engineering value = (Raw Value X Scaling Factor) + Offset
Binary inputs
Binary inputs represent the state of a data point. The state is either ON or OFF.
Analog and binary outputs
Analog and binary outputs are typically initiated by a slave component, which sends a control
request originating from a control center, to the master component involved.
When you create a data point, you specify the type of data and indicate how the SMP Gateway
will retrieve it. General properties such as name, type and units, are independent of the type of
device or protocol used. Protocol-specific properties indicate how the SMP Gateway will retrieve
the data from the device. Each protocol uses its particular form of addressing, such as index
values or data offsets.
For example, to add a data point for a MODBUS device:
• Click the appropriate branch under the protocol instance.
• In the right pane, type the name of the data point and fill in all the appropriate settings. For
instance, to define an analog input you would provide the following settings:
• The name of the data point, such as BUS_VA. SMP Config will automatically add the device
prefix to this name, thereby generating the full name of the data point.
• The input source, such as Input Registers.
• The input format, such as Unsigned Integer.
• The input size, such as 16 or 32 bits.
• The word offset in the MODBUS device memory.
• The scaling information required to convert the raw value to engineering units.
• The Units and Description strings used to provide meaningful data displays.

A complete description of all settings is provided in the document entitled Master Protocol
Common Concepts. Protocol-specific settings are described in individual documents, such as
the MODICON MODBUS Master Protocol Reference Manual. A complete description of system
data points can be found in the section System data points (page 307).
To access the various protocol documents:
• From Windows’ Start menu, select All Programs > Eaton SMP Gateway Documentation >
Version pack number > Documentation > Protocols.

5.5.1. Adding data points from a protocol instance of a


configuration file
Protocol instances in a configuration file can also be used to add points to a protocol
component. For instance, you could use a configuration file to add the data points provided by
an optional device feature. You can do this by retrieving the data points from a protocol instance
in the configuration file you selected which has a protocol instance of the same type as the one
you are configuring.

User Manual | page 64 Eaton


5 - Configuring the SMP Gateway

To add data points from a protocol instance in a configuration file:

1. In the left pane, click the protocol instance to which you want to add the data points.
2. From the Tools menu, choose Import Points from File. A standard Windows “Open File”
dialog box appears.
3. In the Config Files folder, choose the configuration file you want to use that contains the
protocol type you selected, and click Open. A dialog box appears, prompting you to select
the protocol instance from which you will copy the points and for the optional prefix and suffix
to be added to every new data point name. The upper portion of the dialog box provides
information about the open configuration file, while the lower portion shows warning and error
messages.
4. Select the protocol instance from which you will copy the data points in the Source drop
down menu.
5. Specify a prefix and a suffix, if applicable.

5.5.2. Adding data points from a protocol template file


Protocol template files can also be used to add points to a protocol component. For instance,
you could use a template file to add the data points provided by an optional device feature. You
can do this by retrieving the data points from a protocol template file.

To add data points from a protocol template:

1. In the left pane, click the protocol instance to which you want to add the data points.
2. From the Tools menu, choose Import Points from File . A standard Windows “Open File”
dialog box appears. Navigate through the template directory corresponding to the selected
protocol and click on it. The templates corresponding to this protocol, if any, are listed as .tpl
files.
3. In the Templates folder for the protocol type you selected, choose the TPL file you want to
use, and click Open. A dialog box appears, prompting you for the optional prefix and suffix
to be added to every new data point name. The upper portion of the dialog box provides
information about the open template file, while the lower portion shows warning and error
messages.
4. Specify a prefix and a suffix, if applicable.

The new data points now appear in their respective categories under the selected protocol
instance, and their names contain the specified prefix and suffix.

Note: The prefix and suffix are not applied to logical data points, and the logical data
points are reset every time you add data points from a protocol template. You should,
therefore, configure these data points once you have completed the list of physical data
points.

Eaton User Manual | page 65


5 - Configuring the SMP Gateway

5.6. Creating a template from a master protocol


instance
You can create a template file of a master protocol instance, which you can retrieve later in
order to quickly generate new protocol instances.

To create a template from a master protocol instance:

1. From the File menu, choose Save As Template.


2. Choose the Templates folder in which you want to store the template, type a significant name
for the template file, and click Save.

5.7. Duplicating a master protocol instance


Once you have created a master protocol instance and configured its data points, you may want
to generate one or more additional instances with the same general and data point settings. A
quick way to accomplish this is by duplicating the master protocol instance.

To duplicate a master protocol instance:

1. In the left pane, click the protocol instance you want to duplicate.
2. From the Tools menu, choose Duplicate.
Result:

3. Type the Name and Device Prefix of the protocol instance.


4. Put a check mark in the Duplicate alarms box if you want the alarms that belong to the
master protocol instance to be duplicated for the new master protocol instance.
5. Put a check mark in the Duplicate sequence of events box if you want the sequence of
events that belong to the master protocol instance to be duplicated for the new master
protocol instance.
6. Click OK.

The new protocol instance now appears in the left pane.

User Manual | page 66 Eaton


5 - Configuring the SMP Gateway

5.8. Configuring communications links


A protocol component communicates with a device or control center using a communication
link, which can be a serial connection or an IP-based connection.
The configuration of a communications component is completely independent of the protocol
used. Before you connect a device to the SMP Gateway, you have to choose and configure its
communications links.

5.8.1. Serial port naming conventions


In SMP Config, the various serial ports are named differently based on the SMP Gateway
model. The following naming conventions apply:
• The SMP SG-42xx platform has one built-in serial port, identified COM1. If the SMP Gateway
is equipped with serial communication modules or universal communication modules, the
additional ports are numbered from 1 to 8, and preceded by a letter that designates the
communication module slot.
• The SMP 4/DP provides 4 serial ports, identified as COM1 through COM4. If the SMP 4/DP
is equipped with an internal modem, the modem port is labeled Modem, and the RAS usage
is assigned to it.

5.8.2. Serial ports access


To protect the SMP Gateways against the use of unnecessary physical input and output ports,
all SMP Gateway’s serial ports are disabled by default.
Ports are activated if the system needs to use them; for example, if a serial port:
• is configured by being associated with a master or slave connection
• is associated to a passthrough connection
• is configured to be used by a touchscreen
• is configured to be used in a redundancy setup
• is configured for IRIG-B distribution

The current status of all serial ports is shown in the System/Internals/Vital System
Information statistics page. A serial port status can be Active, Enabled or Disabled.

Note: The Console port will always appear as Enabled.

5.8.3. Serial port usages


SMP Gateway serial ports can be used for different usages. The specific usage of each port
must be specified at configuration time.
The following table lists the various serial port usages:

Eaton User Manual | page 67


5 - Configuring the SMP Gateway

Table 5 - Serial port usages


Usage Description

Asynchronous Use this value to indicate that the serial port is dedicated to establishing a standard
asynchronous RS-232 or RS-485 connection.

Elo Touchscreen Use this value to indicate that the touch input information of an Elo Touchscreen will
be transmitted to the SMP Gateway using a serial cable, through this serial port.
This interface is not available on the SMP 4/DP, and is only available through the
COM1 built-in port on SMP Gateways of the SMP SG-4000 series.

Hydro-Québec (1-PPS) Use this value to distribute a 1-PPS signal to a substation device, in order to
synchronize its clock with the SMP Gateway clock.
This usage can only be assigned to serial ports of an SMP SG-4000 universal
communication module.

Hydro-Québec Use this value to indicate that the serial port is dedicated to establish a synchronous
RS-232 or RS-485 connection.
(Synchronous)

K-BUS Use this value to indicate that the serial port is used to communicate with MiCOM
relays from AREVA that provide a K-BUS interface.
This interface can only be assigned to serial ports of an SMP SG-4000 series
universal communication module.
For an SMP 4/DP, connect a KITZ 101 interface unit between the serial port of the
gateway and the K-BUS interface of the relay.

Radio – Custom Use this value to indicate that a custom radio will be connected to this serial port.

Radio – Licensed Use this value to indicate that a licensed-frequency radio will be connected to this
Frequency serial port.

Radio – Spread Spectrum Use this value to indicate that a spread spectrum radio will be connected to this serial
port.

RAS Use this value to indicate that the serial port is configured to accept incoming direct
(remote access server) serial connections. This type of connection allows you to use the SMP Tools as if you
were connected to the SMP Gateway via a normal network connection.
Refer to the SMP 4/DP Installation Guide for instructions on setting up a RAS IP
address pool. Then refer to section SMP Tools remote access to the SMP Gateway
(page 276), in the present manual, for the step-by-step installation procedure.

Note: RAS is not supported on the SMP SG-42xx platform.

Redundancy Use this value to indicate that the serial port is reserved for connecting two
SMP Gateways together as a redundancy group.
For SMP SG-42xx platforms, only the COM1 built-in port can be used for this
purpose.

Note: Redundancy is not supported on the SMP 4/DP.

User Manual | page 68 Eaton


5 - Configuring the SMP Gateway

Usage Description

Reserved Use this value to indicate that the serial port is reserved for purposes other than
those stated previously.

5.8.4. Configuring a serial port for asynchronous


communications
When a serial port is required by a master or slave protocol component for standard
asynchronous communications, use the following procedure to configure the corresponding
serial port.

To specify serial port settings:

1. In the left pane, expand the Connections branch and then select the Serial Ports branch.
2. In the right pane, in the Usage cell of the given serial port, select Asynchronous.
3. Expand the Serial Ports branch, and then select the Asynchronous branch.
4. In the right pane, specify the serial communication settings to use for this serial port. The
required settings are usually provided in the device manufacturer’s reference manual:
a. In the Link Type cell:
• For RS-232 communications, select RS-232 (DTE).
• For RS-485 2-wire communication, select RS-485 (2 wires).
• For RS-485 4-wire communication, select RS-485 (4 wires).
b. Specify the device communications settings: Bit Rate, Byte Size, Parity and number of
Stop Bits, such as 9600 baud, 8 bits, no parity, and 1 stop bit.
c. Choose the device hardware handshaking mode, which depends on the Link Type:
• For RS-232 (DTE), most devices do not use handshaking, so you should keep the
default values: RTS - CTS to RTS On, DTR - DSR to DTR On, and DCD - RI to DCD-
RI.
• For RS-485 (4 wires) and RS-485 (2 wires), set RTS – CTS to Not Connected. You
should also set DTR – DSR to Not Connected (unless you want to distribute IRIG-
B through this port, in which case you should set it to IRIG-B Distribution) and DCD-
RI to Not Connected (unless you want to provide auxiliary power through this port, in
which case you should set it to Auxiliary 5V supply).
d. If software flow control (XON/XOFF) is supported by the device and required:
• Select XON/XOFF (Output). The serial port driver will delay transmission if it receives
the XOFF character, and will start transmitting again if it receives the XON character.
• Select XON/XOFF (Input). The serial port driver will transmit the XOFF character if
it receives more characters than it can handle, and will transmit the XON character
when it will be ready to receive and process more characters.
• In the XON Limit cell, type the number of bytes that must be left in the reception
buffer, following the transmission of the XOFF character, before transmitting the XON
character. For example, if the XOFF character had to be transmitted to the device and
the XON Limit setting value is set to 1, the serial port driver will wait until there is only
1 character left in the reception buffer before transmitting the XON character.

Eaton User Manual | page 69


5 - Configuring the SMP Gateway

• In the XOFF Limit cell, type the minimum amount of free space, in bytes, that must
be left in the reception buffer, before transmitting an XOFF character. For example,
if the reception buffer can hold up to 500 bytes and the XOFF Limit setting value is
set to 5, it means that the XOFF character will be transmitted as soon as there is 495
characters waiting to be processed in the reception buffer.
• If the device supports non-standard values for the XON and XOFF characters, type
these values in the XON Char and XOFF Char cells, using the C-programming
language notation (“0x”).

5.8.5. Configuring a serial port for radio communications


Some devices may only be accessible through radios, requiring the installation of an external
radio on one of the serial port of the SMP Gateway.

To configure a serial port for radio usage:

1. In the left pane, expand the Connections branch, and then select the Serial Ports branch.
2. In the right pane, in the Usage cell of the given serial port, select the type of radio between
the following types:
• Spread Spectrum: Uses a large number of channels to send data from one radio to the
other. The channel hopping is defined in a scheme common to the pair of radios.
• License frequency: Uses a single frequency/channel. It generally requires paying a fee
for the use of the frequency.
• Custom: If the radio used does not correspond to any of the aforementioned type, select
this value.
3. Expand the Serial Ports branch, and then select the Radio branch.
4. In the right pane, specify the serial communication settings to use for this serial port. The
required settings are usually provided in the device manufacturer’s reference manual:
a. Choose the device communications settings: Bit Rate, Byte Size, Parity and number of
Stop Bits, such as 9600 baud, 8 bits, no parity, and 1 stop bit.
b. Default value are proposed for the hardware handshaking settings (RTS – CTS, RTS Pre-
Delay, RTS Post-Delay, DTR – DSR, and DCD), based on the type of radio selected;
adjust these settings if necessary.

5.8.6. Configuring TCP/IP master connections


TCP/IP connections are most often used by slave components to connect to control centers.
However, an increasing number of modern IEDs can be connected to a substation LAN using a
TCP/IP connection.

To configure a TCP/IP connection for a master protocol component:

1. In the left pane, click Connections, and then on TCP/IP Masters, to display the list of defined
connections.
2. In the right pane, enter the basic settings for the new TCP/IP connection in an empty row of
the grid:

User Manual | page 70 Eaton


5 - Configuring the SMP Gateway

a. In the Name cell, type a significant name for the connection; you will reference this
connection by its name when associating it with a master protocol component instance. It
will also appear in traces, logs and statistics.
b. In the IP Address cell, type the IP address of the device.
c. In the Port Number cell, type the TCP port number used by the device for TCP/IP
communications.
3. If you need to force the SMP Gateway to bind the connection socket to a specific IP address,
type this address in the Socket Bind Address cell.
Result:

Note: If the SMP Gateway is used in a redundancy context, you can specify a virtual
IP address as the Socket Bind Address; when a failover occurs, this will ensure that
the standby SMP Gateway will use that address to reestablish the connection with the
device.

4. If the device supports SSL or TLS encryption:


a. In the SSL/TLS cell, select the supported version of the Transport Layer Security protocol
(formerly known as the Secure Sockets Layer protocol).
b. In the Cipher Suite Profiles cell, select the set of cryptographic algorithms that will be
used for this connection. The list of ciphers available in each profile can be found in the
Security\SSL/TLS\Cipher Suite Profiles branch.
5. If the device does not support SSL or TLS encryption:
a. In the SSL/TLS cell, select Disabled.
b. In the Cipher Suite Profiles cell, select All Cipher Suites.

Note: To learn how to set up secure authentication at the TCP/IP level using X.509
certificates, see Secure authentication using X.509 certificates (page 208).

5.8.7. Configuring UDP/IP master connections


Some IEDs are accessible using the UDP protocol, rather than TCP. The UDP protocol allows
the broadcast of messages to several units simultaneously. It may also allow faster message
transmission, although it may be achieved to the expense of reliability.

Although UDP is a “connection-less” protocol, the word “connection” is used in SMP Config
to describe a communication link that is configured between a master protocol instance of an
SMP Gateway and IED(s) that support this UDP-based protocol.
To configure a UDP/IP connection for a master protocol component:

1. In the left pane, click Connections, and then on UDP/IP Masters, to display the list of
defined connections.
2. In the right pane, enter the settings for the new UDP/IP connection in an empty row of the
grid:
a. Provide a significant name for the connection.
b. In the Destination IP Address cell, type the IP address of the device.
c. In the Destination Port cell, type the UDP port number of the device. This information is
provided by the device manufacturer.

Eaton User Manual | page 71


5 - Configuring the SMP Gateway

d. (Optional) In the Source Port cell, type the local source UDP port number that will be
used on the SMP Gateway for transmission and reception. To use a random port number,
type 0.
e. (Optional) If you need to force the SMP Gateway to bind the source port to a specific
IP address, type this address in the Socket Bind Address cell. For example, if the
SMP Gateway is used in a redundancy context, you can specify a virtual IP address;
when a failover occurs, this will ensure that the standby SMP Gateway will use that
address to reestablish the connection with the IED.
f. (Optional) For the connection to receive data addressed to a multicast group, type the IP
address of this group in the Multicast Group IP cell.
g. (Optional) If the SMP Gateway has several network adapters, you need to force the
SMP Gateway to bind the Multicast Group to a specific IP address, type this address in
the Multicast Group Bind Address cell.

5.9. Associating a master protocol instance with a


communications link
In the preceding steps, you configured a master protocol component and a communications
component. Now, you have to associate the protocol component with the communications
component.

To associate a master protocol instance with a communications link:

1. In the left pane, click Connection Usage.


2. In the right pane, for each master protocol instance under Master Connection Usage, select
the check box under the appropriate connection instance.
Result:

3. If you have several devices sharing a multidrop link, each device must have a
different device address; the same communication port must be assigned to these devices. A
maximum of 128 connections is allowed in a serial multidrop link.
Result:

User Manual | page 72 Eaton


5 - Configuring the SMP Gateway

5.10. Validating and saving the configuration


Since the configuration of an SMP Gateway offers so many features, SMP Config tests and
validates the configuration files before you load it onto the gateway. Before going any further,
you should make sure your configuration is error-free. Then, you will send it to the gateway in
order to test it in a real-life situation.

You can save a configuration file that contains errors, however the file will be invalid if sent to
an SMP device. The validation feature is intended to prevent you from inadvertently loading an
invalid configuration file onto an SMP Gateway. Note that you can save and use a configuration
file on an SMP device if the message pane displays warnings only.
To validate and save the configuration:

1. From the Validate menu, choose Validate All. If your configuration contains any errors/
warnings, messages will appear in the Messages pane, as shown in step 3.
2. If you have an error or warning, double-click on it to open the page where the error/warning is
located; this will help you troubleshoot the problem.
3. Correct any errors and repeat the process until the configuration is error-free.
Result:

4. From the File menu, choose Save.

5.10.1. Sending the configuration to the SMP device


Once the configuration file is valid, you can send it to the SMP device.

When transferring a configuration on the SMP device (.par), the configuration file already on the
SMP device will be erased, even if the file has a different name.
To upload the configuration to the SMP device:

1. In SMP Manager, select your SMP device.


2. From the Update menu, choose Send Configuration File and choose your configuration
file, which has been saved in the location you specified in the SMP Device Properties dialog
box. After having sent the file to the SMP device, SMP Manager informs you that you have to
restart your SMP device for the new application to go into effect.

Eaton User Manual | page 73


5 - Configuring the SMP Gateway

Note: If the Eaton SMP Configuration Comparison Tool is installed on the computer
hosting SMP Manager, an option to compare the local configuration file (the one you
want to send to the SMP device) with the configuration file which is currently on the
SMP device is offered. If you choose to do so, click on the Compare button and wait
for the result of the comparison. You will be asked again if you still want to send the
configuration file to the SMP device.

3. Restart the SMP device.

Note: If the configuration file transfer to the SMP device is unsuccessful, the
SMP device will not be restarted. Also, in the situation where only a .par file is sent to
the SMP Gateway, the transferred file (.par) will be copied to the SMP Gateway if the file
is seen as equivalent to the file already in use, regardless of the status displayed in the
Local Configuration column, no restart will be initiated.

4. All restarts are automatically logged in the device's internal log file. You can type a comment
to indicate why you restarted the SMP device. This comment will be added to the event log.

The SMP device will go through a series of startup steps, which will be displayed in the Status
column of your SMP device. When startup is complete, if your configuration file is correct, the
Status column will show Started, to indicate that the device has started normally.
If your configuration file is incorrect, the Status column will indicate that there is a problem.
There are a number of conditions that can prevent the SMP device from activating a
configuration. For instance, the hardware settings may not match the actual physical
configuration of the SMP device. If the gateway does not start up normally, turn to
Troubleshooting (page 297).

What to do next:
Now that you have a working configuration file with all the master data points, you can use the
other SMP Tools and your default Web Browser to see what is going on with the SMP device
and with the connected device.

5.10.2. Retrieving a configuration file


When you are about to send a configuration file to an SMP device, as described previously, you
should first retrieve the old configuration file from the SMP device and store it on your PC. This
will not be necessary when you first configure your SMP device, but on subsequent updates, it
becomes an important precaution to take.

To retrieve a configuration file from an SMP device:

1. Select the SMP device in the list.


2. From the Update menu, choose Get Configuration File. In the Configuration Download
dialog box, SMP Manager displays the available configuration files. The current configuration
file is identified by the “.PAR” extension, while the previous configuration file is identified by
“.OLD”. You might also see files with the “.TXT”, “.AIT”, “.HMI” or .SHM extension.
3. Choose the “.OLD” file, and click the OK button.

User Manual | page 74 Eaton


5 - Configuring the SMP Gateway

4. In the Save As dialog box, specify the name and path where the configuration file is to be
stored. The name of the configuration file on the SMP device is used as the default name.

5.11. Configuration file import/export capabilities


It is possible, from SMP Config, to export your configuration file (.par) to a CSV or XML
format and, inversely to import a configuration file from a CSV or XML format and save it as a
configuration file for the SMP Gateway (.par).
These two (2) file formats are useful for users to modify configuration files in batch; to copy or
modify configuration settings for a large number of devices. Also, the use of a standard editor
like Notepad++ or Microsoft Excel allows for advanced searching/replacing capabilities.
To export a configuration file to a CSV or XML format:

1. Open SMP Config.


2. Verify that the file contains no errors using Validate > Validate All, warnings do not prevent
from exporting the file, you will only get a message. However, if the file contains errors, you
will not be able to export it.
3. Select File > Export.
4. Enter a name for the file in the File name field
5. Select the file format to export in the Save as type field, you can select the following type:
• Coma Separated Values (*.csv)
• Extensible Markup Language File (*.xml)
6. Click Save.

To import a configuration file from a CSV or XML format:

1. Open SMP Config.


2. Select File > Import.
3. Browse to the location of the file.
4. Select the file format of the file to import in the bottom right corner of the window, you can
select the following type:
• Coma Separated Values (*.csv)
• Extensible Markup Language File (*.xml)
5. Select the file.
6. Click Open. The imported file converts to a SMP Config compatible format (.par) and is ready
to be modified and save using SMP Config.

Eaton User Manual | page 75


5 - Configuring the SMP Gateway

5.12. Working with SMP Config


There are many time-saving features you can use to enter data in an SMP Config grid. These
features are presented next.

5.12.1. Copy a protocol instance form another SMP Config file


It is possible to copy and then paste a protocol component from an SMP Config file to another
one.
SMP Manager Version 8.0R1 and later supports many SMP Config files opened simultaneously,
you can simply open the SMP Config file containing a similar master protocol instance, copy the
protocol instance and then paste it into the other SMP Config file.

Note: A single SMP Config file can be open at once if you are using SMP Manager
version 7.2 and earlier.

5.12.2. Selecting cells and rows

1. To select one or several cells:


a. Click the single cell you wish to select.
b. To select several cells, hold down the CTRL key while clicking the cells.
c. To select part of a column or part of a row, click the first cell, hold down SHIFT and click
the last cell you wish to select.
2. To select a column or a row:
a. Click the header of the row you want to select.
b. To select several rows or columns, hold down the CTRL key while clicking their header.
c. To select a group of rows or columns in a sequential order, select the header of the first
one, hold down the SHIFT key and select the last one.

User Manual | page 76 Eaton


5 - Configuring the SMP Gateway

5.12.3. Duplicating a row

To duplicate a row:

1. Click the header of the row you want to duplicate.


2. From the Edit menu, choose Duplicate Line. The row is duplicated after the last row in the
display.

In the following example, we clicked on a row and clicked the Duplicate Line command twice, so
the row appears twice at the bottom of the list.

5.12.4. Copying a value to a group of cells


The Change Selection command of the Edit menu allows you to copy a value from a particular
cell, to one or more rows selected within the same column.

To copy a value to one or more selected cells:

1. Click the cell to which you want to copy a value. If you are selecting more than one cell, use
the CTRL key or the SHIFT key on your keyboard, as per standard Windows procedure.
2. From the Edit menu, choose Select Cells. This makes the cells turn gray, as shown next.
Result:

3. Click in the cell that contains the value you want to copy. In the example, we clicked in the
CI_01 Scale cell.
Result:

4. From the Edit menu, choose Change Selection. The value is copied to the selected cells.
Result:

Eaton User Manual | page 77


5 - Configuring the SMP Gateway

5. To deselect the cells, click Clear Selection in the Edit menu.


6. To add cells to the selection afterwards:
a. Select the desired cells using the CTRL key or the SHIFT key on your keyboard, per the
standard Windows procedure.
b. From the Edit menu, choose Add to selection.

5.12.5. Re-sequencing a group of rows


Some settings are sequenced, within a given column. You may decide to remove data points,
in which case you will need to remove gaps in the numbering sequence. While re-sequencing
all the entries manually would be quite tedious, the Resequence Selection command of the Edit
menu makes it easy.

While re-sequencing all the entries manually would be quite tedious, the Resequence Selection
command of the Edit menu makes it easy.
In the following example, the row with Index 7 has been deleted. All subsequent index numbers
are now incorrect.

To re-sequence these rows (based on the example) :

1. Click the cell with Index 8.


2. Hold down the SHIFT key of your keyboard and click the last cell in the column.
3. From the Edit menu, choose Select Cells. The cells turn gray.
4. From the Edit menu, choose Resequence Selection.
Result:
A window appears, in which you must specify the starting sequence number (7) and the
increment (1).

User Manual | page 78 Eaton


5 - Configuring the SMP Gateway

Note: If the cells contain text, the Resequence window is a bit different: in addition
to the starting sequence number and the increment, you must enter the desired prefix
and suffix. The complete cell content will be replaced.

5. To deselect the cells, click Clear Selection in the Edit menu.

5.12.6. Deleting an item

1. To delete a row in a grid:


a. In the right pane, click the header of the row you want to delete.
b. Press the DEL key on your keyboard, and confirm your intention of deleting the row. The
item disappears from the grid.
2. To delete a protocol instance:
a. In the left pane, click the protocol type. The list of instances of this protocol type appears
in the right pane.
b. In the right pane, click the protocol instance you want to delete.
c. Press the DEL key on your keyboard, and confirm your intention of deleting the row. The
protocol instance disappears from both panes.
3. By their very nature, serial port connections cannot be deleted in the same way. To delete a
serial port connection, you have to reserve the corresponding serial port for another usage.
To delete a serial port connection:
a. In the left pane, expand the Connections branch and then select the Serial Ports
branch.
b. In the right pane, choose Reserved in the Usage cell of the serial port.

5.12.7. Using tooltips


SMP Config provides context tooltips. These tooltips are not displayed on the status bar but
rather appear when you point with the mouse to a cell in any grid.

This type of tooltip normally displays the editing criteria for the field. For example, it may tell you
that a given timeout setting value must fall between 10 and 1000 milliseconds, that the default
value is 500 milliseconds, that the field is mandatory if a certain other field is selected, and so
on. So they will assist you in editing grids.

Eaton User Manual | page 79


5 - Configuring the SMP Gateway

To see a tooltip:

Point the mouse to a cell in any grid


Result:

This feature is a great time and effort saver, as it spares you from having to wait until you try to
validate or save your SMP Gateway configuration before finding out that you have a number of
errors.

5.12.8. Searching and replacing points in a configuration


To help you find all the references to a point in a configuration, a search function is available in
SMP Config.

To access the search function:

1. From the Edit menu, choose Find Points. OR Press CTRL-F.


2. In the Find Points dialog box, type the point name you are looking for and click the Find
button. The results appear in the list below.
3. Select the point in the list, the application will bring you to the configuration zone of the point.
Result:

Note: As shown in the following screenshot, one point can be used in several
situations. If you need to change the naming scheme in your configuration, rename the
point and the other points created from it will automatically bear the new name.

User Manual | page 80 Eaton


6. Configuring alarms
Using SMP Config, you can set up alarms based on the analog and binary data points of your
SMP Gateway. These alarms can be displayed on the SMP Gateway HMI pages, sent to the
control center or recorded on different log files.

6.1. Configuring alarms based on analog and binary


inputs
The SMP Gateway HMI supports alarms defined from analog inputs and binary inputs.

First, you must configure the conditions that will trigger alarms.
For an analog input:
• an alarm is triggered when its value goes beyond a given threshold (including the dead band,
if any).
• the alarm returns to normal when the analog input value reaches the threshold (including the
dead band, if any).

For a binary input:


• an alarm is triggered when its state change.
• The alarm returns to normal when the input state returns to normal.

1. To define an alarm based on the value of an analog input:


a. In SMP Config, from the tree view, expand the System branch and then the Alarms
branch to reveal the Analog Inputs branch.
b. Select the Analog Inputs branch.
c. In the right pane grid, in the Name cell, type the name of an analog input for which you
want to define the alarm conditions.

Note: The same subscription feature that is available to configure slave protocols
can be used instead of typing names. This is explained a bit further in this section.

d. In the Alarm Level cell, select a severity level for this input alarms.
e. In the Low Threshold cell, specify the value under which an alarm will be triggered for
this input. For example, if you specify a low threshold value of -13.1, an alarm will be
triggered if the input value becomes smaller than -13.1.
f. In the High Threshold cell, specify the value over which an alarm will be triggered for
this input. For example, if you specify a high threshold value of 125.7, an alarm will be
triggered if the input value becomes larger than 125.7.
g. In the Deadband cell, specify how much the value must go beyond the low or high
threshold to trigger an alarm. For example, if you set the dead band to a value of 5.0
and the high threshold to a value of 125.5, an alarm will be triggered if the input value
becomes larger than 130.5.

Eaton User Manual | page 81


6 - Configuring alarms

h. If you want to temporarily disable the triggering of alarms for this data point, select the
Disabled check box. The alarm settings will be preserved in your configuration file but will
not be used by the system.
i. In the Low Threshold Description cell, you can type a description for low threshold
alarms on this analog input. This description will be displayed in the various SMP
Gateway HMI pages when such an alarm condition is met, or when an operation (ex.
acknowledge) is performed on such an alarm. The High Threshold Description setting
works similarly, for high threshold alarms on this input.

Note: If the Low or High Threshold Description field is left empty, the description
of the data point in the protocol instance will be used in the SMP Gateway HMI
alarms pages.

j. In the Category cell, select the category of indicators to use to display the alarm state. To
use the default indicators (A, Ax, R and Rx), select Default.
2. To define an alarm based on the state of a binary input:
a. In the right pane grid, in the Name cell, type the name of an analog input for which you
want to define the alarm conditions, or use the subscription feature as described below for
analog inputs.
b. In the Alarm Level cell, select a severity level for this input alarms.
c. In the Appearance Filter cell, specify how long, in milliseconds, the binary input must
keep the active state (TRUE or 1) before triggering an alarm. This setting filters “false”
alarms.
d. In the Disappearance Filter cell, specify how long, in milliseconds, the binary input must
keep the inactive state (FALSE or 0) before considering that the alarm is no longer active.
This setting filters “false” returns to normal.
e. If you wish to trigger the alarm upon a 0 instead of a 1, select the Inverted check box.
f. If you want to temporarily disable alarms for this data point, select the Disabled check
box.
g. In the Category cell, select the category of indicators to use to display the alarm state. To
use the default indicators (A, Ax, R and Rx), select Default.
h. In the Description cell, you can type a description for the alarms on this binary input. This
description will be displayed in the various SMP Gateway HMI pages when such an alarm
condition is met, or when an operation (ex. acknowledge) is performed on such an alarm.

Note: If the Description field is left empty, the description of the data point in the
protocol instance will be used in the SMP Gateway HMI alarms pages.

3. Typing each point name can be a tedious task, especially if you have a lot of alarms to
define. Instead, you can use the same subscription mechanism you used to configure your
slave protocols. To subscribe the Alarms’ Analog inputs to master data points:
a. Select the Analog Inputs branch.
b. From the SMP Manager’s Tools menu, choose Subscribe To. The Subscribe to Master
I/O window appears. You can then select the master points for which you want to define
alarm conditions. To learn how to use this window, see Subscribing to the master data
points (page 102). Once you click OK, the window closes and a row is created in the
Analog Inputs pane for each data points.
c. All that is left is to specify the conditions and descriptions for these alarms.

User Manual | page 82 Eaton


6 - Configuring alarms

Note: A description is proposed by default for each alarm based on the


description of the subscribed point. If the Include Point Name in Description setting
is selected (in SMP Config under the System/Alarms/General branches), the point
name is also added to the description of the alarm.

6.2. Defining alarms categories


Alarm categorization is a concept that allows users to change the indicators used to tell the
current state of a given alarm. The Default category provides the following indicators:

The Default category provides the following indicators:


• A: This is the default indicator for the appearance of an alarm, which is when the alarm
condition is met for the first time.
• R: This is the default indicator for an alarm that returns to its normal state before it can be
acknowledged.
• Ax: This is the default indicator for multiple appearances of an alarm, which is when the
alarm condition is met again following its return to normal state, before being acknowledged.
• Rx: This is the default indicator for multiple appearance and return-to-normal occurrences
that ended with the alarm having returned to its normal state, all before being acknowledged.

By defining additional categories, you can provide different indicators for these specific alarm
states, which can be specified on a per-alarm basis.
To define an alarm category:

1. In SMP Config, from the tree view, expand the System branch and then the Alarms branch.
Select the Categories branch.
2. In the first empty row, click in the Name cell.
3. Type a name for the new category.
4. In the Appearance Symbol cell, type the character(s) to display instead of the A indicator for
alarms of this category.
5. In the Multiple Appearance Symbol cell, type the character(s) to display instead of the Ax
indicator for alarms of this category.
6. In the Return-to-Normal Symbol cell, type the character(s) to display instead of the R
indicator for alarms of this category.
7. In the Multiple Return-to-Normal Symbol cell, type the character(s) to display instead of
the Rx indicator for alarms of this category.
8. (Optional) In the Description cell, type a short description that explains the role and purpose
of this category. This information is only specified for configuration purposes, as it will not be
written anywhere when the alarm is triggered.
Result:
The Alarm categories you defined will then be available for configuring alarms based on
analog and binary input points.

Eaton User Manual | page 83


6 - Configuring alarms

6.3. Setting up an alarm buzzer


The SMP Gateway has a normally open relay that can be used to trigger an output. If you install
a buzzer on this relay output, you can configure the SMP Gateway to trigger the buzzer upon
alarm.

Note: To locate the relay output on the SMP Gateway rear panel, refer to the
corresponding specific installation guide or user manual (ex. SMP SG42xx Platform User
Manual).

To activate the alarm buzzer feature:

1. In SMP Config, from the tree view, expand the System branch, then expand the Alarms
branch.
2. Select the General branch.
3. Select the Activate Relay on Alarm check box.

User Manual | page 84 Eaton


7. Archives
The Archives function allows a user to download IED files stored in an Archive folder which is
defined in SMP Config.
Therefore, the Archives are only available when an archive folder is configured on the SMP
Gateway. The Archive Folder is part of the SMP Gateway system folders which is explained in
details in the Protocol Common Concepts Reference Manual, MN912003EN.
The Archive Folder files are displayed on the SMP Gateway HMI pages only with the remote
access, refer to the section Archives files from the HMI (page 133) for more information on the
subject.

7.1. Configuring the archive folder


The Archive folder is defined, in the SMP Gateway configuration file. Only one (1) Archive folder
can be defined in a SMP Gateway configuration.

Only one (1) Archive folder can be defined in a SMP Gateway configuration.
To define an archive folder in a SMP Gateway configuration:

1. In the left pane of SMP Config, expand the System branch, the Folders branch, and then
select the Local branch.
2. In the Archive Folder section, click in the Archive ID cell and then type the numerical
identifier of the system folder, which must be unique in a given SMP Gateway configuration
file.
3. In the Name cell, type a name for that system folder. This name will appear in traces, logs
and statistics.
4. In the Size cell, type the maximum size of the folder, in megabytes.

Note: Unlike for standard local folders, you cannot specify how files will be
processed when an archive folder gets full: old files are automatically deleted to free
space when the folder is full.

5. Optionally, you can provide a Description of the folder content or purpose.

Note: It is common practice to assign the Archive folder to a Copy folder. This way, a
copy of the file can stay on the archive of the SMP Gateway, even after being sent to another
system. When the Archive folder is assigned directly to a master component, the files could
be retrieved via the SMP Gateway HMI interface.

Eaton User Manual | page 85


8. Log files
The SMP Gateway maintains an internal log of all significant events.
Using SMP Log or the SMP Gateway HMI, you can select and view the various log files in real
time. You can view, print, search and save all or any information in the SMP Log application.

8.1. Viewing log files


To start SMP Log and view the SMP log files:

Note: To view Log files using the SMP Gateway HMI, Refer to the chapter Maintenance
and commissioning with the SMP Gateway HMI (page 109).

1. In SMP Manager, select your SMP Gateway.


2. From the Tools menu, choose SMP Log.
Result:
SMP Log starts up and displays the list of available logs.

3. Click a log in the left pane, to view its contents in the right pane.

8.2. Information provided by the log files


The following log files contain information that you will find useful for the configuration and
maintenance of your SMP Gateway:
• The Startup log records all the steps that the SMP Gateway performed when it last started.
The log indicates which configuration file was loaded and which protocol components were
configured and started. You should consult the startup log each time you change the SMP
configuration, in order make sure it is a success.

User Manual | page 86 Eaton


8 - Log files

• The Reset log records the time and reason for each SMP Gateway restart. It indicates
whether the reset occurred because of a power failure, a request from the front panel button,
a remote request, a watchdog trip, or a fatal hardware or software problem.
• The Control log records the steps that the SMP Gateway performed in response to a local or
remote control request.
• The Security log records all events that concern the security options such as authentication
failures, file integrity check and much more.

The other SMP log files contain information that can help you and our technical support team in
identifying problems.

Note: When the SMP Gateway HMI is accessed locally, the Security and Firewall log
files are not available.

8.2.1. Maximum number of entries per log file


The maximum size of each log file is hard-coded. When a given log file is full, oldest entries are
deleted to make room for the new ones.
As each entry varies in size and several entries depend on the configuration file, the maximum
number of entries that can be stored in each file can only be approximated using the average
size for an entry of the corresponding log file. However, keep in mind that the maximum number
of entries depends of the length of each entry.
The following table presents these approximated maximum number of entries, for each log file:
Table 6 - Maximum number of entries per log (approximated)
Average entry size, in
Maximum number of entries
Log file number of characters
(approximated) (approximated)

Alarm 20,000 40

Application 1000 60

Communication 500 140

Control 1000 100

File 1000 80

Firewall 500 150

Protocol 500 90

Redundancy 1000 (N/A for the SMP 4/DP) 70

Reset 1500 70

Security 20,000 40

Sequence Of Event 20,000 65

Startup 2000 55

Eaton User Manual | page 87


8 - Log files

8.3. SMP Log features


SMP Log offers you several handy features: searching, printing and saving log file, and having
the information displayed in UTC or local time.

8.3.1. Searching in SMP Log

To search in SMP Log:

1. From the menu View, choose Search. You can also press CTRL-F, or click the binoculars
button in the toolbar.
2. Type a keyword in the text box and click the Search button.
Result:
All the results will become highlighted; the first one will be lighter.
3. To go to the next result, choose Search Next from the View menu, or press F3.
4. To go to the previous result, choose Search Previous from the View menu, or press SHIFT-
F3.
5. Once you have found, choose Cancel Search from the View menu and only the selected
result will remain highlighted.

8.3.2. Printing a Log

To print a log:

1. Select a folder.
2. From the menu View, choose Print. You can also press CTRL-P or click the printer button in
the toolbar.

8.3.3. Saving a Log file

To save a log file:

1. Select a folder.
2. From the menu View, choose Save As.
3. Type a name for the file; you can use a different extension such as “.CSV” or “.TXT”.

User Manual | page 88 Eaton


8 - Log files

8.3.4. Viewing multiple Log folders at once

To view multiple log folders at once:

1. Select folders, using the SHIFT or the CTRL key.


2. The contents of all folders will be displayed altogether in the right pane, in chronological
order.

8.3.5. Changing how time information is displayed

To change how time information is displayed:

1. From the View menu, choose Time Display Options.


2. In the Time Display Format box, select the display type: you can choose between the
local time (using the time zone settings of the PC) and UTC. Normally, the clock of the
SMP device is set in UTC, but you can display the information using the time format you like.

8.3.6. Deactivating the auto scroll feature


By default, when a new entry is added to the selected folder, the display pane automatically
scrolls down to that new entry.

To prevent the display pane from scrolling when a new entry is added:

1. From the View menu, choose Auto Scroll to remove the checkmark beside this command.
2. Repeat the previous step to bring the checkmark back and reactivate automatic scrolling.

8.3.7. Log retrieval by scripting


As opposed to real-time traces, log entries are intended to be stored permanently on the
SMP Gateway, as long as there is enough space on disk.
Actually, each log folder can store a maximum number of log entries; when this maximum is
exceeded, the oldest entries are deleted.
To ensure that no log entries are lost, you can retrieve them on a periodic basis and save them
to files in a location where disk space is not a concern, by invoking SMP Log from the command
line in a script.
SMPLog.exe Syntax
SMPLog.exe /ip <address> /nosplash /rpc [/combinedlog] /logmode { complete
| diffonly | append} /logdir <directory> /local /user "<username>" /pass
"<password>"

Eaton User Manual | page 89


8 - Log files

Table 7 - SMP Log command line arguments


Argument Description

/ip <ip> Provide the IP address of the SMP Gateway from which to retrieve the log
entries.

/nosplash Optional setting.


If specified, it prevents the display of the SMP Log splash screen at startup.

/rpc Mandatory setting.


Forces SMP Log to communicate with the SMP Gateway using RPC.

/combinedlog Optional setting.


If specified, all log entries will be merged in a single file; otherwise,
separate files are used for each log folder.

/logmode { complete | diffonly | Indicates which log entries should be retrieved and saved:
append}
• complete: Create a new file containing the entire log contents.
• diffonly: Create a new file containing only the new log entries that were
recorded since last execution.
• append: Appends new entries to the most recent file; file will be created
if it does not exist.

/logdir <directory> Indicate the destination path of the saved log files.

Note: This setting is mandatory, as it triggers the log retrieval


feature; it if it is missing, SMP Log will start normally, if other provided
settings are valid (IP address, account credentials, etc.)

/local Mandatory setting.


Forces SMP Log to use SMP Gateway local authentication.

/user "<username>" Provide the username, surrounded by quotes, of an SMP Gateway local
account that has sufficient privileges (see Note below).

/pass "<password>" Provide the corresponding password, surrounded by quotes, of the


SMP Gateway local account that has sufficient privileges (see Note below).

Note:
• To retrieve standard log entries, the specified user account must have the “Diagnostic”
privilege; to retrieve entries from the “Firewall” and “Security” logs, the account must have
the “Security Management” privilege.
• By default, log entries are stored in files named using the corresponding log folder
name and current date and time (ex. Security_20100324_211946_UTC.log). If
you specify the /combinedlog switch, all log entries are saved in a single file (ex.
All_20100324_211946_UTC.log)

User Manual | page 90 Eaton


8 - Log files

Example:
The following command line will retrieve only new log entries from the SMP Gateway at the IP
address provided by the first command line argument (%1):
Smplog.exe /NOSPLASH /RPC /LOCAL /IP %1 /LOGDIR c:\logs\%1 /LOGMODE DIFFONLY /
USER “Alice” /PASS “A8bCk67P”

Eaton User Manual | page 91


9. Viewing protocol exchanges in real time
Using SMP Trace, you can view a continuous stream of protocol exchanges between the SMP
Gateway and the substation devices, or between the SMP Gateway and the control center.
At this stage, however, since you have only configured master protocol instances, you will only
see the protocol exchanges that take place between the SMP Gateway and the substation
devices.
You can have the information displayed in UTC or local time, highlight the rows that contain
specific keywords, and you can clear the current display. SMP Trace can generate a continuous
log of all the events you are tracing, to a text file on your PC. It can also print or save to a text
file, a snapshot of the traced events that occurred since the last time you cleared the display.
To start SMP Trace and view the protocol exchanges:
• In SMP Manager, select your SMP Gateway.
• From the Tools menu, choose SMP Trace.

9.1. Information provided by SMP Trace


SMP Trace starts up and displays the list of available traces.
Using SMP Trace, you can view detailed traces of all the system activity. The following traces
provide information that you will find useful during the configuration and maintenance of your
SMP Gateway.
• Master and Slave Protocol traces display the high-level information exchanges that occur
between the SMP Gateway and the other system components to which it is connected.
These application-level traces are similar to those provided by a protocol analyzer. They
describe the requests sent to a device and the values retrieved. The Slave Protocols folder
appears only if slave protocol instances are configured on the SMP Gateway.
• Connection traces display the data being exchanged between the SMP Gateway and a
device. These low-level traces describe, in hexadecimal format, the byte stream sent and
received to and from a device.

To customize the display and select specific traces:


• In the left pane, select the item for which you want to view the protocol exchanges.
• If you click a folder, everything within the folder is automatically selected.

User Manual | page 92 Eaton


9 - Viewing protocol exchanges in real time

9.2. SMP Trace features


SMP Trace offers you several handy features: recording traces, searching, printing and saving
trace records, and having the information displayed in UTC or local time.

9.2.1. Searching in SMP Trace


When a large amount of traces are currently displayed, it may be hard for the user to find the
information he is looking for.

SMP Trace provides a search feature that highlights all traces that contain a specific keyword.
To search displayed traces for a specific keyword:

1. From the menu View, choose Search. You can also press CTRL-F, or click the binoculars
button in the toolbar.
2. Type a keyword in the text box and click the Search button. All the results will become
highlighted, and the first one will be lighter. You can click the Pause/Resume button in the
toolbar to stop the screen from scrolling; this command is also available from the View menu.
3. To go to the next result, click Search Next in the View menu, or press F3.
4. To go to the previous result, click Search Previous in the View menu, or press SHIFT-F3.
5. Once you have found, choose Cancel Search from the View menu and only the selected
result will remain highlighted.

Note: SMP Trace will keep highlighting matching results as long as you have not
canceled the search. You can either deselect the binoculars in the toolbar or stop the search
from the View menu.

Eaton User Manual | page 93


9 - Viewing protocol exchanges in real time

9.2.2. Using the Load traces selections feature for debugging


purposes
When a problem occurs and help from Eaton’s technical support team is required, the Load
traces selections feature provides an efficient way for the support representative to isolate the
problem without having a large amount of traces displayed.

To use the Load traces selections feature:

1. Contact Eaton’s technical support and explain the problem.


2. The support representative will ask to provide the SMP Gateway configuration file. Using the
provided configuration file, in SMP Trace, he will select specific traces, related to the problem
that was described and then use the Save trace selections features to create an .xml file
with the required traces that will help solve the problem.
3. The .xml file will then be sent to you.
4. Open SMP Trace and, from the File menu, select Load trace selections.
5. Browse to select the .xml file that was provided by the support representative. Click Open.
6. Selected traces will be displayed in the middle pane.
7. Follow the instructions given by the support representative to try to replicate the problematic
situation and record the traces (See Recording Live Traces section below).

Note: If selected traces present in the .xml file are not there when the file is loaded at the
customer site, an error message will be displayed in the status bar. However, valid selected
traces will still be displayed. This situation may happen if there is a discrepancy between
your configuration file and the one used by the support representative.

9.2.3. Printing Traces

To print currently displayed traces:

1. From the File menu, choose Print.


2. You can also press CTRL-P or click the printer button in the toolbar.

User Manual | page 94 Eaton


9 - Viewing protocol exchanges in real time

9.2.4. Recording live traces

To record live traces to a file for further analysis:

1. From the Record menu, choose Start or click the red button in the toolbar.
Result:

2. You can also choose to save it on the SMP Gateway by selecting Record to SMP Gateway.
Example:
If you have an SMP 4/DP with a modem on a pole outdoors and you need to save 24-hour
worth of activities, long distance costs are most of the time prohibitive. Use this option and
connect again 24 hours later to pick up your data.
3. When you wish to stop the recording, click the red button again or click Stop in the Record
menu.

9.2.5. Saving all the scrolled information

To save all the information in SMP Trace that scrolled since opening it:

1. Select a folder.
2. From the File menu, choose Save As. You can also press CTRL-S or click the disk button in
the toolbar.
3. Type a name for the file; it will be saved in text format (TXT).

Eaton User Manual | page 95


9 - Viewing protocol exchanges in real time

9.2.6. Changing how time information is displayed

To change how time information is displayed:

1. From the View menu, choose Time Display Options.


2. In the Time Display Format box, select the display type: you can choose between the
local time (using the time zone settings of the PC) and UTC. Normally, the clock of the
SMP Gateway is set in UTC, but you can display the information using the time format you
like.

9.2.7. Deactivating the auto scroll feature


By default, when a new entry is added to the selected folder, the display pane automatically
scrolls down to that new entry.

To prevent the display pane from scrolling when a new entry is added:

1. From the View menu, choose Auto Scroll to remove the checkmark beside this command.
2. Repeat the previous step to bring the checkmark back and reactivate automatic scrolling.

User Manual | page 96 Eaton


10. Statistics
The SMP Gateway stores a large number of real-time statistics and internal counters to help
you analyze the performance of your SMP Gateway and assist you in troubleshooting your
configuration.
Using SMP Stats or the SMP Gateway HMI, you can view, in real time, various statistics about
the communications ports status, links and about the protocol exchanges that take place
between the SMP Gateway and the devices or control centers.
With the SMP Stats tool, you can have the information displayed in UTC or local time. You can
also print the statistics, reset them, or save them to a text file for subsequent analysis.

10.1. Viewing communications statistics in real time


To start SMP Stats and view the statistics:

1. In SMP Manager, select your SMP Gateway.


2. From the Tools menu, choose SMP Stats.
3. In the left pane, click the item for which you want to view the statistics.

The statistics are displayed in the right pane and you can see them change dynamically.

What to do next:
To view the statistics using the SMP Gateway HMI, refer to Statistics files from the HMI (page
134).

Eaton User Manual | page 97


10 - Statistics

Note: When the SMP Gateway HMI is accessed locally, only the following statistics are
available: General Information, Performance (General) and Vital System Information.

10.2. Information provided by SMP Stats


Statistics provide information on the SMP Gateway activity, which can be useful for the
configuration and maintenance of the gateway itself.
This information is organized as pages and folders. A folder does not contain any statistics: it is
a place holder for statistics pages.
When you open SMP Stats or Statistics (on the SMP Gateway HMI), its displays the following
folders:
• The Connections folder regroups counters and statistics pages about the performance of the
SMP Gateway communications components:
• The Network (TCPIP) folder contains the list of all the network connections you defined under
Connections, in SMP Config. Each connection has its own statistics page.
• The Serial (Asynchronous) folder contains the list of all the serial connections. As in the
Network folder, there is a statistics page for each connection.
• The Master Protocols and Slave Protocols folders contain counters and statistics about
each instance of a protocol component. Each protocol component contains protocol-specific
items that describe the messages exchanged with a device or control center. (The Slave
Protocols folder is missing, in the previous example, because we have to define slave
protocol components first.)
• The System folder contains counters and statistics about the operation of the SMP Gateway
hardware and software. The page Internals\Vital System Information contains information
about the status of the Serial, Ethernet and USB ports. The user can clearly know if a
communication port is enabled or disabled.

The following image shows an example of some Ethernet and serial port statuses (Vital System
Information page partially shown).

User Manual | page 98 Eaton


10 - Statistics

The modem port status is not shown on the statistics page. The _smp___dialupEnabled
system point can be used to learn about the modem’s activation status. Other modem related
system points are available, refer to System data points (page 307)for details.

10.3. SMP Stats features


SMP Stats offers you several handy features: resetting statistics, printing them, refreshing them,
and changing how time is displayed.

10.3.1. Resetting statistics

You can reset certain statistics, such as global RTDX or Web server statistics:

1. From the menu View, choose Reset


2. You can also click the 'X' button; or press CTRL+X.

Note: The reset statistics you apply from SMP Stats, affects also the corresponding
Stats displayed on the SMP Gateway HMI.

Eaton User Manual | page 99


10 - Statistics

10.3.2. Printing statistics

To print a statistics page:

1. Select a folder.
2. From the File menu, choose Print.
3. You can also press CTRL-P or click the printer button in the toolbar.

10.3.3. Changing how time information is displayed

To change the display format of time-specific statistics:

1. From the View menu, choose Time Display Options.


2. In the Time Display Format box, select the display type: you can choose between the
local time (using the time zone settings of the PC) and UTC. Normally, the clock of the
SMP Gateway is set in UTC, but you can display the information using the time format you
like.

User Manual | page 100 Eaton


11. Connecting the SMP Gateway to a
control center
Configuring a slave protocol component to connect to a control center.
Now that we have seen how to configure master protocol instances, tested the SMP Gateway
configuration and viewed the collected data, we will see how to configure, using SMP Config, a
slave protocol instance in order to forward the device data to a SCADA or a control center.

11.1. Creating slave protocol instances


When the SMP Gateway communicates with a control center, it acts as a slave and as such,
needs to use a slave protocol.

One slave protocol instance is required per control center.


To create a slave protocol instance:

1. In the left pane of SMP Config, under Slave Protocols, click the protocol for which you want
to add an instance.
2. In the right pane, type the name of the new instance at the end of the list of names, and
press the TAB key.

The new protocol instance is added to the left pane, under the protocol branch you had
selected. If you expand the protocol branch, SMP Config displays default settings of the protocol
instance.

11.2. Configuring slave protocol instances


The configuration of a slave protocol component is similar to that of a master protocol
component. You choose the protocol, enter the protocol settings, and specify the data points
you want forwarded to the SCADA.

To configure a slave protocol instance:

1. In the left pane, click General, to display the list of general settings for the selected slave
protocol instance.
2. In the right pane, enter the protocol settings. For instance, to configure a DNP3 slave
component, you would provide settings such as:
a. The Link Address, which identifies the logical slave device. The address has to match
the address used by the control center to communicate with the SMP Gateway.
b. The Master Link Address, which identifies the control center.
c. Whether or not you want to support Unsolicited Reporting.
3. In the left pane, click Group Default Variations.

Eaton User Manual | page 101


11 - Connecting the SMP Gateway to a control center

4. In the right pane, specify how you want the data points to be reported. For example, you may
want to specify that when there is a change to an analog input point, you want the change
reported as a 32-bit value, with the time at which the event took place.

Note:
• A complete description of the protocol-specific settings is available in individual
documents, such as the DNP3 Slave Protocol Reference Manual, for example.
• To access the various protocol documents: From Windows’ Start menu, select
All Programs > Eaton SMP Gateway Documentation > Version pack number >
Documentation > Protocols.

11.3. Subscribing to the master data points


Slave protocol instances subscribe to data points in the real-time database. Whenever a master
protocol instance writes to the database, the slave instance retrieves the data and applies its
own settings to make it compatible with the requirements of the control center protocol.

When you configure a slave protocol component, you select from among all the data points
defined by the master protocol components, those data points to which you want to subscribe.
To subscribe a slave to master data points:

1. In the left pane, click the slave protocol instance.


2. In the Tools menu, click Subscribe To.
Result:

3. Click in the Master I/O list, to display the list of data points defined for each master protocol
instance. A filter field helps for the data points selection. The bottom pane has additional
features related to the filter that the user can select\clear to ease the data points selection in
the Master I/O left pane.
4. Choose the data points you want to forward to the control center. put a checkmark in the box
Expand Tree to Show Points to extend your selection.

User Manual | page 102 Eaton


11 - Connecting the SMP Gateway to a control center

5. Click the right arrow button. The data points you choose are added to the Slave I/O list. If,
for example, you click a binary input point in the Master I/O list, the point is added to Binary
Inputs, in the Slave I/O list.

Note: The added points will be indexed in the order they appear in the Slave I/O
list. For some protocols, additional arrow buttons are available to the right of the Slave
I/O list. Using these buttons, you can sort the points according to your own indexing
requirements.

6. Normally, a data point that has been transferred to the Slave I/O list disappears from the
Master I/O list. However, if you want the transferred data points to continue being displayed
in the Master I/O list:
a. Select the Show all enabled points check box.
7. If you change your mind, you can remove a data point from the Slave I/O list as follows:
a. Click the data point in the Slave I/O list.
b. Click the left arrow button. The data point is removed from the Slave I/O list and reinserted
in the appropriate data point list for the appropriate master.

11.4. Configuring the data points


The slave component automatically converts the subscribed data points to the appropriate
format for the protocol. However, you should make sure the default settings are appropriate and
perform any necessary adjustments.

To configure the data points:

1. In the left pane, click the data point type, to display a list of all the data points and their
settings.
2. There are different settings for each protocol. However, you should at least check the
address or index assigned to each data point. For instance, the following settings are
provided for a DNP3 data point:
a. Each data point is automatically assigned an Index value according to the subscription
order. You should ensure that these index values correspond to those expected by the
control center.
b. The Event Class setting groups data points together for subsequent reporting to the
control center.

11.5. Configuring the communications links


We previously described how to configure a serial communications link for a master protocol
component. The procedure is identical for a slave protocol component that uses a serial
communications link. However, a slave protocol component typically uses a TCP/IP connection
(or an UDP/IP connection, in some cases) over a LAN, to communicate with the control center.
For more information about communications link configuration, see Configuring communications
links (page 67).

Eaton User Manual | page 103


11 - Connecting the SMP Gateway to a control center

11.5.1. Setting up a TCP/IP slave connection

To configure a TCP/IP connection for a slave protocol component:

1. In the left pane of SMP Config, expand the Connections branch, the TCP/IP branch, and
then select the Slaves branch.
2. In the right pane, enter the basic settings for the new TCP/IP connection in an empty row of
the grid:
a. In the Name cell, type a significant name for the connection; you will reference this
connection by its name when associating it with a slave protocol component instance. It
will also appear in traces, logs and statistics.
b. In the Port Number cell, type the TCP port number that will be used by the remote control
center for TCP/IP communications.
c. If you need to force the SMP Gateway to bind the connection socket to a specific IP
address, type this address in the Socket Bind Address cell.

Note: If the SMP Gateway is used in a redundancy context, you can specify
a virtual IP address as the Socket Bind Address; when a failover occurs, this will
ensure that the standby SMP Gateway will use that address waiting for the remote
connection.

d. In the Accessible From cell, select if the connection should be accessible from any
remote control center (Any Computer), specific remote control centers (Specific
Computer or Subnet) or through a VPN (VPN Only (Firewalled)).

Note: VPN is not supported on the SMP SG-42xx platform.

e. If you selected Specific Computer or Subnet for the Accessible From setting, type
the range of IP addresses that will be used by the remote control centers in the Specific
Computer or Subnet cell.

Note: The maximum number of address/subnet allowed is 32. CIDR notation


is supported (Classless Inter-Domain Routing), meaning that you can write
10.106.187.55/24 instead of 10.106.187.55/255.255.255.0. If you wish to specify an
address range (e.g: 10.106.186.128 to 10.106.188.128) you can use the online tool
to convert the range to a CIDR netmask list, to facilitate notation. Refer to https://
www.ipaddressguide.com/cidr for details and examples.

3. If the remote control center supports SSL or TLS encryption:


a. In the SSL/TLS cell, select the supported version of the Transport Layer Security protocol
(formerly known as the Secure Sockets Layer protocol).
b. In the Cipher Suite Profiles cell, select the set of cryptographic algorithms that will be
used for this connection.
Result:
The list of ciphers available in each profile can be found in the following branch:
Security\SSL/TLS\Cipher Suite Profiles

User Manual | page 104 Eaton


11 - Connecting the SMP Gateway to a control center

c. In the Rekeying Delay cell, type the maximum amount of time, in minutes, the ICCP slave
protocol will wait before renegotiating the session key with the remote control center.
d. In the Rekeying TPDUs cell, type the maximum number of Transport Protocol Data Units
that the ICCP slave protocol can receive before renegotiating the session key with the
remote control center.
e. In the Full Renegotiation Delay cell, type the maximum amount of time, in minutes,
the ICCP slave protocol will wait before renegotiating the entire session with the remote
control center.
f. If the remote control center is not compliant with RFC 5746 - Transport Layer Security
(TLS) Renegotiation Indication Extension, select Allow Insecure Renegotiation.
4. If the remote control center does not support SSL or TLS encryption:
a. In the SSL/TLS cell, select Disabled.
b. In the Cipher Suite Profiles cell, select All Cipher Suites.

11.5.2. TCP ports reserved for SMP Gateway core components


or protocols
Some TCP ports cannot be used for TCP/IP slave connections; they are reserved by SMP
Config.
Those ports may be used or not by the SMP Gateway system components; they are presented
in the following table.
Table 8 - TCP ports reserved for core components or specific protocols
Reserved TCP Port Usage

20, 21 FTP

23, 107 Telnet

80, 8080, 8008 HTTP

135 RPC

139 NETBIOS SSN

389 LDAP

443 HTTPS

1234 Replicator

1235 Hot Standby (Redundancy)

1723 PPTP

6650 SMP Gateway management port


Status Server

11740 CODESYS

Eaton User Manual | page 105


11 - Connecting the SMP Gateway to a control center

11.5.3. UDP ports reserved for SMP Gateway core components


or protocols
Some UDP ports cannot be used for UDP slave connections; they are reserved by SMP Config.
Those ports may be used or not by the SMP Gateway system components; they are presented
in the following table.
Table 9 - UDP ports reserved for core components or specific protocols
Reserved UDP Port Usage

23 Reserved

123 SNTP

137 Netbios name service

138 Netbios datagram service

139 Netbios session service

161 SNMP

500 IPSec

4500 NAT-T LSA

4567 SMFRs

6650 SMP Gateway management port

11.5.4. Setting up a UDP/IP slave connection


Although UDP is a “connection-less” protocol, the word “connection” is used in SMP Config
to describe a communication link that is configured between a slave protocol instance of an
SMP Gateway and control centers that support this UDP-based protocol.

Some UDP ports are reserved for the SMP Gateway core components or for specific servers/
protocols. They cannot be used for UDP/IP slave connections. These ports are presented in the
following table.
Table 10 - SMP Gateway icons in SMP Manager
Reserved UDP Port Usage

161-162 SNMP

1723 PPTP

6650 SMP Gateway management port

To configure a UDP/IP connection for a slave protocol component:

User Manual | page 106 Eaton


11 - Connecting the SMP Gateway to a control center

1. In the left pane, under Connections, click UDP/IP Slaves, to display the list of defined
connections.
2. Enter the settings for the new UDP/IP connection in an empty row of the grid:
a. Specify a significant name for the connection.
b. Specify the UDP local source port number to be used.
c. Select from the Accessible From list box whether the connection will be accessible
from any computer (Any Computer), from a specific one through the SMP Gateway
integrated firewall (Specific Computer or Subnet), or via a VPN connection (VPN Only
(Firewalled)).

Note: VPN is not supported on the SMP SG-42xx platform.

d. If you selected Specific computer or subnet, type an address or an address range in the
Specific computer or subnet cell.

Note: The maximum number of address/subnet allowed is 32. CIDR notation


is supported (Classless Inter-Domain Routing), meaning that you can write
10.106.187.55/24 instead of 10.106.187.55/255.255.255.0. If you wish to specify an
address range (e.g: 10.106.186.128 to 10.106.188.128) you can use the online tool
to convert the range to a CIDR netmask list, to facilitate notation. Refer to https://
www.ipaddressguide.com/cidr for details and examples.

e. (Optional) To receive data addressed to a multicast group through this connection, type
the IP address of this group in the Multicast Group IP cell.
f. (Optional) If the SMP Gateway has several network adapters, you need to force the
SMP Gateway to bind the Multicast Group to a specific IP address, type this address in
the Multicast Group Bind Address cell.
g. (Optional) In the Destination IP cell, type the IP address of the device.
h. (Optional) In the Destination Port cell, type the UDP port number of the device. This
information is provided by the device manufacturer.
i. In the Destination Usage cell, select how the optional destination parameters will be
handled:
• If data must always be sent to the configured Destination IP Address and
Destination Port, select Always Use.
• If data must always be sent to the originating address and port of the last received
data, and to use the configured Destination IP Address and Destination Port only
when no data was received yet, select When destination unknown.

11.6. Associating a slave protocol instance with a


communications link
You now have to identify the communications link which will be used by the slave component to
communicate with the control center.

Eaton User Manual | page 107


11 - Connecting the SMP Gateway to a control center

To associate a slave protocol instance with a communications link:

1. In the left pane, click Connection usage.


2. In the right pane, for each slave protocol instance under Slave Connection Usage, select the
check box under the appropriate connection instance.

11.7. Validating and activating the configuration


You can now validate the configuration, save it on your computer, send it to the SMP Gateway,
and restart the gateway in order to activate the configuration.

11.8. Testing the configuration


The SMP Gateway configuration now contains a slave component. Slave components are more
difficult to test than master components, since they only process data in response to a request
from a control center.
You may find the following guidelines useful in determining whether the slave component is
working properly:
• Using SMP Log, check the Startup log, to see whether the slave component was started
correctly.
• Using SMP Stats, open the Slave Protocols folder and check whether the slave component is
processing any data.
• Using SMP Stats, open the Connections folder, and check whether any data is being
exchanged through the slave communications link.
• Using SMP Trace, open the Slave Protocols folder, and check whether the component is
receiving requests from the control center.
• Using SMP Trace, open the Connections folder, and check whether any data is being
exchanged through the slave communications link.

See the following sections for instructions on how to proceed to view the information:
• Viewing log files (page 86)
• Viewing protocol exchanges in real time (page 92)
• Viewing communications statistics in real time (page 97)
• Viewing data in real time (page 130)

A particularly effective way to test a slave protocol instance is to use the SMP Gateway itself to
set up a master protocol instance to poll the slave. Using this approach and the SMP Tools, you
can easily examine the effect of the various protocol features, such as report by exception.
You can also use the SMP Gateway HMI Commissioning Tool, as described in the next chapter.

User Manual | page 108 Eaton


12. Maintenance and commissioning with
the SMP Gateway HMI
In this chapter, the reader will learn the different features offered by the SMP Gateway HMI.
This section also presents information on how to access it, remotely and locally, and to navigate
through its different sections using the toolbar menu, icons and the Favorites Bar. Then, the
different maintenance and utility functions of the SMP Gateway HMI will be explained in details.

12.1. The SMP Gateway HMI


The SMP Gateway HMI provides an easy way to view useful and critical information related
to the setup and operation of the SMP Gateway and to its related IEDs or to perform data
monitoring and control operations as part of an automation platform system.
The SMP Gateway HMI groups together information that can be classified in two different
groups: the maintenance and commissioning applications and the operational applications.
This chapter is dedicated to the sections of the SMP Gateway HMI that provide the user with
useful and accessible information and applications for maintenance and commissioning of
their system. For the operational applications of the SMP Gateway HMI, mainly the Alarms, the
Diagrams and the Device’s Front Panels, refer to Operations with the SMP Gateway HMI (page
146).
Altogether, the SMP Gateway HMI contains various functionalities and applications that can
be activated or deactivated in the configuration file, SMP Config, for both the remote and local
accesses independently or directly on the SMP Gateway HMI via the Application Settings page.

12.2. Accessing the SMP Gateway HMI


The SMP Gateway HMI can be accessed locally, through a touch screen connected directly
to the SMP Gateway video port or remotely using the integrated secure Web server of the
SMP Gateway and your Internet Web browser.
The SMP Gateway HMI provides an easy way to view archives (remote access only), statistics
and logs and also to display the current statuses and values of the analog and binary input and
output points in real time. The SMP Gateway HMI also gives access to operational functions,
used for handling alarms and to perform control operations through the Alarms, Diagrams and
Device's Front Panels pages; it allows also operators to perform control operations from the
Commissioning Tool. Other features present on the SMP Gateway HMI, like the Communication,
System and Redundancy dashboards provide the user with useful information on the system.

Eaton User Manual | page 109


12 - Maintenance and commissioning with the SMP Gateway HMI

Note: SMP Manager uses the computer's default Web browser for the SMP Gateway
HMI. However, some exceptions apply: for SMP Gateways running the SMP Gateway
Software and Tools version 7 and earlier, Internet Explorer is always used. Also, for versions
7.1 and later, if the default Web browser is Internet Explorer and Chrome is installed on the
computer, Chrome will be used as the Web browser for SMP Manager.

In the event that the SMP Gateway HMI is not available, for example when the SMP
Gateway is in safe mode or its status is protocol failed, the SMP Gateway HMI's starting
window indicates the status of the SMP Gateway in a message box.

12.2.1. Remote access


Whether it is to view the SMP Gateway Archives, Statistics or Logs or to access the different
HMI applications like the Diagrams and Device Front Panels, there are two ways to connect
remotely to the SMP Gateway HMI.
You can connect remotely to the SMP Gateway HMI:
• From SMP Manager:
◦ In SMP Manager, select your SMP Gateway.
◦ From the Tools menu, choose Web Browser or click on the corresponding icon ( located
in the SMP Manager Toolbar.
• Directly from your Internet Browser:
◦ Open your preferred Web Browser.
◦ In the dialog box, type the address of the SMP Gateway unit you want to reach using
https. For example: https://10.2.15.1

When the local security database, which includes your authentication policies, users and
groups, is uploaded on the SMP Gateway, local authentication is enabled on the SMP Gateway,
you will have to provide the user name and password of an SMP Gateway local user account
that has the at least the Monitoring privilege in order to access the SMP Gateway HMI.
The account may have been created manually in the SMP Gateway security database (local
security) or set by IED Manager Suite (IMS) (global security).
To perform control operations or access specific applications, other privileges may be required;
refer to section Required privileges for the SMP Gateway HMI (page 117) for details about the
required privileges for each application.
The authenticated user is identified in the authentication logo (blue circle) on the top right corner
of the SMP Gateway Toolbar; the first letter of the user account is displayed inside the circle.
To change the user account, click on the authentication logo and click on the LOGOUT button.
Once the user is disconnected from the server, refreshing the Web browser page will allow the
user to log in using another user account.
The SMP Gateway HMI accessed remotely does not preload the diagram pages; these pages
are loaded when the user clicks on the page link for the first time. The Features Status page
indicates which page is loaded or not.

User Manual | page 110 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

Note: The SMP Gateway HMI Website is accessible using the Hypertext Transfer
Protocol over Secure Socket Layer (HTTPS). By default, the SMP Gateway integrated
firewall allows communications through the HTTPS port (443). Make sure such
communications are also permitted over the substation LAN and through the corporate
firewall.

12.2.2. Local access


Some of the SMP Gateway HMI features are different or not available on the local display
compare to SMP Gateway HMI that is accessed remotely. The differences are described
throughout this chapter and the Operations with the SMP Gateway HMI chapter as they arise.
Some of the features which are specific to the local display:
• The authentication mechanism available for the local display is optional and must be set in
the configuration file in order to enable the local display authentication feature.
• On the local display, a virtual keyboard appears when alphabetical or numerical user input is
required. The virtual keyboard can be deactivated when a physical keyboard is connected to
the SMP Gateway. This is performed on the HMI’s Application Settings page. The display
language can be selected on the HMI’s Application Settings page.
• At startup, all diagram pages are preloaded. A Stop button allows the user to skip the
preloading of these pages in order to shorten the loading time. This feature is very useful
at commissioning when the device is frequently restarted. Once the SMP Gateway HMI
is accessible, clicking on the Diagram link will load the page if it was not preloaded. The
Features Status page indicates which page is loaded or not.
• The local display shows the date and time in the right side of the toolbar.
• The Application Settings page allows keyboard shortcuts configuration for a quicker access
to the SMP Gateway HMI's Diagrams and Device's Front panel pages.

When a touch screen is connected to the SMP Gateway’s video port and the Local display
Enabled option is selected in the configuration file, all SMP Gateway HMI features allowed for
the local display, are available and the HMI is automatically displayed on the screen.
If the local display is configured to use authentication, the Enabled with Authentication option
is selected in the configuration file. In such a case, the SMP Gateway HMI is always accessible
locally for applications that require the Monitoring privilege only; it is however restricted for
applications that require additional privileges.
The Monitoring privilege gives access to the following applications on the SMP Gateway HMI:
• Communication dashboard
• All the alarms, Active and Blocked pages (view and alarm management)
• Real-time data (view only, no commissioning commands)
• Diagrams and Device's Front Panels (view and alarm management, no commands available)
• System – Features Status (disabled applications will be identified as being Unauthorized)
• Parameters – Application settings
• About the SMP Gateway HMI

Eaton User Manual | page 111


12 - Maintenance and commissioning with the SMP Gateway HMI

When a user with the required privileges to access other applications has successfully
authenticated, these application are then made available to this user. Refer to section Required
privileges for the SMP Gateway HMI (page 117) for details about the required privileges for
each application.
To authenticate on the local display:
• The Enable with Authentication setting in the SMP Gateway configuration file, located in
the branch HMI/Access/Display, must have been selected in order to enable authentication
on the local display.
• Make sure the monitor is connected in the SMP Gateway’s video port and powered on.
• Turn on the monitor.
• The authentication logo is a blue circle with a user inside, it is located on the top right corner
of the SMP Gateway Toolbar. Click on the authentication logo and provide local user account
credentials.
• Click on the LOGIN button. A successful authentication will display the first letter of the local
user account inside the circle.

SMP Gateway HMI applications are made available according the privileges granted to the
local user account used to authenticate. To show which applications are available to the
authenticated user, from the HMI menu, in the System section, select the Features Status.
If the user does not have the required privileges for an application, the status related to this
application will be set to Unauthorized.
To change user account, click on the authentication logo and enter the credentials of another
local user account. Click on the LOGIN button. The first letter of the selected local user account
should the displayed inside the blue circle if the authentication was successful.
Logging out will give access to the SMP Gateway HMI applications that requires the Monitoring
privilege only, as it was before user authentication.
Some situations have an effect on an authenticated session, they are:
• Any change to the SMP Gateway security settings, for example password, local account,
password complexity setting…, will immediately terminate an authenticated session; exactly
like logging out.
• A user’s inactivity is determined by the period of time in which no mouse movement,
keyboard input or touch screen input is detected. The Local Display Session Timeout
setting in the HMI/General branch of the configuration file determines the allowed user’s
inactivity period; if this period is exceeded the authentication session will be terminated,
exactly like logging out. The user can authenticate again or stay in the non-authenticated
mode.
The setting’s default value is set to 15 minutes, the maximum value is 60 minutes and a 0
value will disable the feature.

12.3. Navigating through the SMP Gateway HMI


The SMP Gateway HMI menu, located at the left corner of SMP Gateway HMI toolbar, is used to
navigate through the different sections belonging to the SMP Gateway HMI.
The toolbar provides also permanent icons, located at its right corner, to facilitate navigation and
to display relevant information regardless on the current page displayed on the HMI.

User Manual | page 112 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

12.3.1. The HMI menu


The SMP Gateway HMI menu icon is located at the left corner of the HMI toolbar. When the
user clicks on the icon, all enabled SMP Gateway HMI applications are listed.
The menu is divided in a number of sections used for grouping similar HMI applications. Most
applications can be disabled using SMP Config and when disabled, they will not appear on the
HMI menu. Next to the menu icon, there is a short description of the selected application.

Description of the HMI menu:


• The Dashboards section displays the Communications, System and Redundancy
dashboard pages.
◦ The Communication dashboard allows users to get a quick overview, in a single page, of
the communication status of all the substation’s IEDs.
◦ The System dashboard displays basic system information organized on one page, it
includes: the synchronization status, security status, hardware status and firewall status,
the system load gauges, the SMP Gateway time and startup time, settings information,
hardware information, versions information and security information.
◦ The Redundancy dashboard (optional) is displayed only on SMP Gateways belonging to
a redundancy group. It displays information about the communication links between the
two redundant SMP Gateways, the status of each SMP Gateway of the group as well as
the redundancy group’s status and finally, the current SMP Gateway fail over status and
configuration.
• The Alarms section displays the Active, Blocked and History Alarms pages. The Active
Alarms page allows the user to monitor, acknowledge and select some data points to be
blocked and placed on the Blocked Alarms page. The Alarms History page allows the user
to keep track of the most recent alarms that were triggered as well as operations performed
on theses alarms. The Alarms section covers operational data and is discussed in the
chapter Operations with the SMP Gateway HMI (page 146).
• Users can draw application diagrams or single-line representations of their substation,
distribution or transmission grid using SMP Diagram Editor launched directly from SMP
Config. These diagrams are accessed under the Diagrams section. This section covers
operational data and is discussed in the chapter Operations with the SMP Gateway HMI
(page 146).
• Users can create Device's Front Panels for control interactions with the IEDs using SMP
Diagram Editor, launched directly from SMP Config. These diagrams are accessed under the
Device's Front Panel section. This section covers operational data and is discussed in the
chapter Operations with the SMP Gateway HMI (page 146)
• The Real Time Data Points section displays the current value of all SMP Gateway data
points and allows also selecting data points based on specific categories: Pinned only, by
Instance or by Type. The Commissioning Tool application is placed in this section because
the application works closely with Real Time Data point lists. The application provides a
commissioning tool that simplifies the engineering effort required for implementation and
integration of a substation. The HMI accessed locally (local display) does not give access to
the Commissioning Tool application.
• The System section displays the content of the SMP Gateway Archive, Statistic and Log
files. The Features status page is also part of this section.

Eaton User Manual | page 113


12 - Maintenance and commissioning with the SMP Gateway HMI

◦ The Archives application allows the user to download IED files stored in the configured
Archive folder. Archive files are only available when the archive folder is configured in
SMP Config otherwise the page is left empty.
◦ The Statistics application displays the SMP Gateway real-time statistics. The information
provided on the HMI is the same as with the SMP Stats program. The HMI accessed
locally (called local display) gives only access to the system statistic files.
◦ The Logs application allows you to select all SMP Gateway Log files. The files are the
same as provided by the SMP Log program. The HMI accessed locally gives access to all
log files except for the Security and the Firewall log files.
◦ The Features status page shows the HMI major applications and displays, for each of
them, information concerning their license information, their actual configuration in SMP
Config and their status according to the user’s privilege.
• The Parameters section displays utility applications and an information page.
◦ The Application settings page is where the user can adjust different parameters or
enable some options related to the HMI application as well as update or retrieve the SMP
Gateway’s Diagrams. Note that this page is different on the local display.
◦ The About SMP Gateway HMI page is used to give information about the SMP Gateway.
(Terms and conditions, licenses…)
◦ The Disconnect option, allows disconnection from the SMP Gateway HMI. This option is
not available for the Local Display.

12.3.2. The HMI toolbar


The toolbar’s left side displays the SMP Gateway HMI menu icon, which was described in the
previous section. The toolbar’s right side can display up to seven icons, allowing easy access to
specific pages or displaying information related to the current use of the SMP Gateway.
The icons are not always displayed on the toolbar; it depends on the configuration and on the
selected SMP Gateway HMI page.
Icon presentation from left to right:

Note: The local display also shows the date and time in the tooolbar.

• A Utility icon is available for the user to arrange the HMI pages columns configuration and/or
to pin or unpin all data points on specific HMI pages.
• The Commissioning Tool icon gives a direct access to the Commissioning Tool page when
the commissioning session is activated.
• The On standby identifier icon allows the user to know which SMP Gateway of the
redundancy group is accessed. This icon is only shown when the SMP Gateway is
configured as part of a redundancy group. No identifier is displayed for the active SMP
Gateway.
• The Redundancy group icon shows that the SMP Gateway is part of a redundancy group.
This icon is displayed for both the active and the standby SMP Gateways. A red exclamation
mark is placed next to the icon when a problem is detected within the redundancy group.
This icon gives direct access to the Redundancy Dashboard page.
• The Active Alarms icon displays, on a permanent basis, the number of active alarms and
gives a direct access to the Active Alarms page.

User Manual | page 114 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

• The Communication Dashboard icon displays, on a permanent basis, the number of faulty
communication links from the Communication Dashboard and gives a direct access to the
Communication Dashboard page.
• The Authentication icon displays, on a permanent basis, the local user account that was
used to authenticate to the SMP Gateway HMI. The first letter of the local user account used
to authenticate is displayed inside the authentication logo. When a user symbol is inside the
circle, no user is authenticated.

When one of these functions is deactivated in the configuration file, the corresponding icon does
not appear on the toolbar. For the Commissioning Tool, when the session is deactivated by the
user, the icon is not shown on the toolbar. The toolbar’s middle section changes depending on
the page displayed.

12.3.3. The Favorites Bar application (optional)


A Favorites Bar application is available to the user to allow its most utilized applications to stay
on the SMP Gateway HMI pages on a permanent basis. This application is optional.
To activate it:
• From the HMI menu, in the Parameters section, select Application Settings.
• In the Favorites Bar box, select Activate Favorites Bar.

Once activated, a star is displayed on the menu’s left side and stars are also displayed next to
each application on the HMI menu.
To deactivate it:
• From the HMI menu, in the Parameters section, select Application Settings.
• In the Favorites Bar box, deselect Activate Favorites Bar.

Once deactivated, the star is removed from the menu’s left side and all stars are removed from
the menu. The Favorites Bar is removed from the HMI pages left side. If you reactivate it again,
the selected applications you had before the deactivation are still on the Favorites bar.
The star next to the menu is empty when the Favorites bar is not displayed, but activated. Click
on the star to display the bar permanently, in this case, a gray star is displayed.
When an application is selected to be part of the Favorites Bar, the star next to the application
becomes gray and the application page is added to the Favorites Bar.
Following is an example of a user configured Favorite Bar:

Eaton User Manual | page 115


12 - Maintenance and commissioning with the SMP Gateway HMI

Note: When the Favorites bar is displayed, the whole page on the screen shifts to the
right. If you intend to use the Favorites bar, take into account the space needed by the
Favorites bar when you design Diagrams or Device's Front Panel pages. Leave some space
on the right side of the page to avoid the use of a scroll bar in order to be able to view the
whole page.

12.4. SMP Gateway HMI requirements


The latest SMP Gateway HMI feature requires the following Eaton’s products, and software.
For the remote SMP Gateway HMI (through a Web browser):
• An SMP SG-42xx platform or an SMP 4/DP
• SMP Gateway Software and Tools Version 8.0R1 or later
• A Web browser, preferably Google Chrome.

Note: SMP Manager uses the computer's default Web browser for the SMP Gateway
HMI. However, some exceptions apply: for SMP Gateways running the SMP Gateway
Software and Tools version 7 and earlier, Internet Explorer is always used. Also, for
versions 7.1 and later, if the default Web browser is Internet Explorer and Chrome is
installed on the computer, Chrome will be used as the Web browser for SMP Manager.

Note: Remote display is supported on tablet computers, through the Google Chrome
and Safari browsers.

For the local display:


• An SMP SG-42xx platform
• SMP Gateway Software and Tools Version 8.0R1 or later
• A touchscreen (or a “non-touch” screen with a mouse)

User Manual | page 116 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

12.4.1. Required privileges for the SMP Gateway HMI


Table 11 - Required privileges for the SMP Gateway HMI
Access selected Privileges
HMI Application User’s Activity
in SMP Config needed

System Dashboard Enabled Visualization Monitoring


Diagnostics

Redundancy Enabled Visualization Monitoring


Dashboard
Diagnostics

Communication Enabled Visualization Monitoring


Dashboard

Real-Time Data Real-Time Data Only Visualization Monitoring

Real-Time Data and Activate a Commissioning session Monitoring


Commissioning
System
Management

Real-Time Data and Start, Stop and Join a Commissioning Monitoring


Commissioning session, force data points
Operation

Statistics Enabled Visualization Monitoring


Diagnostics

Logs Enabled Visualization all except Security and Monitoring


Firewall
Diagnostics

Visualization all Monitoring


Diagnostics
Security
Management

Archives View only Visualization Monitoring

View and Management Visualization, download and deleting Monitoring


files
Operation

Alarms View Only Visualization Monitoring


Diagnostics
(History page only)

Eaton User Manual | page 117


12 - Maintenance and commissioning with the SMP Gateway HMI

Access selected Privileges


HMI Application User’s Activity
in SMP Config needed

View and Management Visualization and Alarm management Monitoring


Diagnostics
(History page only)

Diagrams View Only Visualization Monitoring


(Single line and View and Control Visualization, Control operations and Monitoring
Device's Front Panels) alarm management
Operation

For more information regarding user privileges, please refer to The SMP Device security
database (page 195).

12.4.2. Specific SMP Gateway requirements for the touchscreen


The SMP Gateway implements the Elo TouchSystems’ driver. Therefore, the selected
touchscreen must support Elo TouchSystems’ drivers for Windows CE 4.2 or later, and can
implement any touchscreen technology except APR, Projected Capacitive, and Multi-Touch.
Contact Eaton's technical support to get the list of tested models.

12.5. Setting up the touch screen for the local


display
To learn how to set up a touch screen for your specific SMP Gateway platform, refer to the SMP
SG-42xx Platform User Manual.

12.5.1. Touch screen calibration for the SMP Gateway HMI


The touch screen calibration process is performed at the SMP Gateway startup (and restarts).
To learn how to calibrate the touch screen, refer to the corresponding SMP SG-42xx platform
User Manual.

12.5.2. SMP Gateway HMI local display mouse support


The SMP Gateway HMI Local Display option supports mouse input, in replacement of touch
input or for use with “non-touch” screens.
Note that touch input always has precedence over mouse input; moreover, input selection
occurs dynamically, which means that if you unplugged the touch input cable of the touch
screen from the SMP Gateway, and connect the mouse to the SMP Gateway, the mouse cursor
will appear on screen within seconds (i.e. you do not have to restart the SMP Gateway for the
change to be effective).

User Manual | page 118 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

12.5.3. The local display screen resolution


The local display screen resolution can be adjusted for the SMP SG-42xx platform models.
The screen resolution is setup using the SMP Manager program and the settings offer is
different on both models. The user can select a specific screen resolution to force a resolution
on the screen(s) connected to the SMP Gateway (VGA or DVI). When automatic detection is
selected the SMP Gateway will detect the connected screen capabilities and find the best suited
resolution for the screen.
To setup the SMP Gateway HMI screen resolution, in SMP Manager, from the menu SMP
Device select Set Screen Resolution.
The resolution change is effective after an SMP Gateway restart.
To learn about the specific screen resolution depending on the platform and model refer to the
Catalog data document of the specific model; the document is available online. To learn how
to adjust the local display screen resolution, refer to the SMP SG-42xx Platform User Manual,
MN912026EN.

12.6. Setting up the SMP Gateway HMI


The SMP Gateway HMI is included in the SMP Gateway configuration file, which is edited using
SMP Config.
Some of the SMP Gateway HMI applications are not configurable by the user; they simply
reflect the status and general configuration of the SMP Gateway unit. For example: the
Communication , System and Redundancy Dashboards, the Real Time Data Points lists, the
System section which includes the Archives, the Statistics, the Logs, the Commissioning Tool
and the Features status. These applications simply need to be enabled or disabled in the SMP
Gateway configuration file.
However, some other SMP Gateway HMI applications require specific HMI configuration using
the SMP Config Tool. The list below is intended to guide the user through the required steps to
follow to setup an SMP Gateway HMI.
To configure the SMP Gateway HMI, you must go through the following steps:
• Enable the SMP Gateway HMI in the configuration file. (Remote and/or Local)
• Select the HMI applications that you want to enable or disable in the SMP Gateway HMI.
• Select the page to display at startup.
• Setup the session timeout values.
• Configure alarms, if not already done (Refer to Configuring alarms (page 81) ).
• Setup the Active Alarms page (Refer to: Setting up the Active Alarms page (page 148)).
◦ Setup the Single Alarm Display feature.
• Setup the Blocked Alarms page (Refer to: Setting up the Setting up the Blocked Alarms
page (page 150)).
• Setup the Alarms History page (Refer to: Setting up the Alarms History page (page 151)).
• Create Diagrams and Device's Front Panels, if you like (Refer to Diagrams for the SMP
Gateway HMI (page 152))
◦ Enable or disable the zoom control on the Diagram pages.
◦ Implement a control interlock software mechanism.

Eaton User Manual | page 119


12 - Maintenance and commissioning with the SMP Gateway HMI

◦ Implement direct page access mechanism for Diagram pages to Device's Front panel
pages.
• Change how time information is displayed, if needed.
• Setup an alarm buzzer, if needed.
• Enable or disable the sound on a new alarm.
• Setup the screen saver.
• Upload the configuration file to the SMP Gateway.
• Change the display language, if needed.
• Enable and setup the Favorites Bar, if needed.

The following sections and the chapter Operations with the SMP Gateway HMI (page 146)
explain all these
steps in details.

12.6.1. Enabling SMP Gateway HMI in the configuration file


To enable the SMP Gateway HMI:
• In SMP Manager, select your SMP Gateway.
• From the Tools menu, choose SMP Config. SMP Config opens, displaying the current
configuration of your SMP Gateway.
• In SMP Config, from the tree view, expand the HMI branch.
• Select the Access/Display branch. The right pane is divided in three sections. In the
General section, The All Features Activation cells allow the user to enable the whole SMP
Gateway HMI for Remote Access and Local Display independently.
• The SMP Gateway HMI is enabled by default, to disable it, select the Disabled option for
Remote Access and/or Local Display. When disabled, the HMI application is not accessible.

Once the alarm conditions are defined (refer to Configuring alarms (page 81)), you may set
up the various application pages. The various pages to setup belong to the Maintenance and
Commissioning HMI or to the Operational HMI (Alarm pages and Diagram pages), refer to this
present chapter for the pages belonging to the Maintenance and Commissioning HMI and for
the general use of the SMP Gateway HMI and refer to the chapter Operations with the SMP
Gateway HMI (page 146) to get information on how to setup and use the Alarms and the
Diagram pages.

12.6.2. Enabling the HMI applications


By default, some HMI applications are enabled and some disabled in the configuration file.
To select the applications you want for the SMP Gateway HMI to fit your needs, you have to
customize the applications’ availability in the configuration file.

To select the HMI applications to be available:

1. In the SMP Config tree view, expand the HMI branch, select the Access/Display branch.

User Manual | page 120 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

2. In the right pane, under the Standard Features and the Optional Features sections, select
the applications you want for both the Remote Access and Local Display (you should verify
first if you have all the licenses and privileges for these applications):
Result:

When an application is set to Disabled, it will not be available on the SMP Gateway HMI menu.

Note: If the All Features Activation parameter is set to Disabled, the SMP Gateway
HMI is not accessible. However, the SMP REST API, which also uses port 443, is still
available. To make the SMP REST API inaccessible, port 443 must be deactivated by
removing the check mark in the Allow cell for the Secure Web Server (SMP Config >
Security > Firewall > Rules).

When all HMI applications are disabled but the SMP Gateway HMI is enabled, the Features
Status page is displayed as startup page and the only other page available is the About SMP
Gateway HMI page.
When authentication is active on an SMP Gateway that runs the SMP Gateway HMI, only users
who are granted the right privileges (e.g., Monitoring and/or Operation) can access the selected
HMI applications.

Note: The Commissioning Tool application and the Archives feature are available for the
Remote Access only.

12.6.3. Selecting the page displayed at startup

In Remote Access, the last page visited is presented to the user at the SMP Gateway HMI
startup. For the Local Display, the user can select which page to display at the SMP Gateway
HMI startup. The application pages that can be selected are the following: Communication or
System Dashboard, Real-Time Data, Logs, Statistics, Alarms and Diagrams.

Eaton User Manual | page 121


12 - Maintenance and commissioning with the SMP Gateway HMI

To select the startup page:

1. From the Tool menu, choose SMP Config to start the application.
2. In the left pane, expand the HMI branch, select the Access / Display branch.
3. In the right pane, under the General section, in the Startup Page cell, select which page
you want to display at startup for the Local display, the Remote Access has only the Last
opened page as option.
4. Save and upload the configuration file to the SMP Gateway.

If the page selected at startup has its application disabled in SMP Config, you will get a warning
when saving the SMP Config file. You can download the configuration file anyway and the page
displayed at startup will be the Features Status page.

12.6.4. Setting up HMI session timeouts

As already mentioned, remote and local accesses to the SMP Gateway HMI are managed
separately. Consequently, a session timeout can be configured for both accesses independently.
The configured settings for the session timeout is in minutes and must be setup in SMP Config,
not at runtime.
The HMI session will expire when the user stops interacting with the application for the time
specified by the configured Session Timeout setting.
To setup HMI session timeouts for the remote access and local display:

1. From the Tool menu, choose SMP Config to start the application.
2. In the left pane, expand the HMI branch, select the Access / Display branch.
3. In the right pane, under the General section, in the Session Timeout cell, enter the time, in
minutes, you want for the session timeout of the Remote Access.

Note: The Session Timeout default value for the Remote Access is 0, meaning it is
disabled.

4. In the right pane, under the General section, in the Session Timeout cell, enter the time, in
minutes, you want for the session timeout of the Local Display.

Note: The Session Timeout default value for the Local Display is 15 minutes.

5. Save and upload the configuration file to the SMP Gateway.

12.6.5. Changing how time information is displayed


Unless it is configured otherwise, time information is stored in the UTC format on the
SMP Gateway. However, UTC is not very convenient for display and operation purposes.
Moreover, date information is not formatted the same way in all countries.

To change the date and time display format:

1. In SMP Config tree view, expand the HMI branch, select the General branch.

User Manual | page 122 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

2. In the Time Zone cell, select the time zone where the SMP Gateway is located.
3. If you want the time to be automatically adjusted for daylight savings, select the Auto Adjust
DST check box.
4. In the Date Format cell, select the format to use to display date information. By default, year
is displayed first (all four digits), followed by the month and day, all separated by dashes
(ex. 2008-07-03).

12.6.6. Setting up and using the screen saver


A screen saver can be configured to replace the SMP Gateway display by a black screen during
periods of inactivity.

Your touch screen may have an energy saving feature, but you can also configure the SMP
Gateway to enter a screen saver mode during periods of inactivity.
To set up the screen saver:

1. In SMP Manager, select your SMP Gateway.


2. From the Tools menu, choose SMP Config.
3. In SMP Config, from the tree view, expand the HMI branch, and then select General branch.
4. In the Screen Saver Wait Time cell, select the inactivity time to wait before the SMP
Gateway HMI enters screen saver mode.
5. You can also turn off this feature by selecting No Screen Saver.

To leave the screen saver mode, just touch the screen (or move the mouse if no touchscreen is
used).
The screen saver also automatically ends its execution when an alarm occurred, or when the
data point that triggered it return to its normal condition.

12.6.7. Uploading the configuration file to the SMP Gateway


Before you can use the SMP Gateway HMI, two steps are still need to be performed. You must:
• upload the configuration file to the SMP Gateway and restart the system
• calibrate the touch screen at runtime

For a little reminder on how to upload the configuration file to the SMP Gateway, Sending the
configuration to the SMP device (page 73). Once the configuration file has been uploaded,
restart the SMP Gateway.
At the beginning of the SMP Gateway startup sequence, you should see some configuration
information displayed on the touch screen, and then the screen should become totally black. It
will remain black during the rest of the startup sequence, which may take a few minutes.
The calibration screen eventually appears. Calibration is not in the scope of this document; it
is explained in details in the corresponding installation guide of your SMP Gateway (ex. SMP
SG-42xx Platform Installation Guide).

Eaton User Manual | page 123


12 - Maintenance and commissioning with the SMP Gateway HMI

12.6.8. Changing the display language


The SMP Gateway HMI is available in English, French and Spanish.

Remote display language can be changed by changing the language settings of your Web
browser.
On the Local display, the English language is the default display language; it can be changed
directly from the SMP Gateway HMI.
To change the SMP Gateway HMI local display language:

1. From the HMI menu, in the Parameters section, select Application Settings.
2. In the Language box, select français to switch to the French language, English to switch to
the English language or español to switch to the Spanish language.
Result:
The SMP Gateway HMI application will restart with the new language setting.

12.6.9. Deactivating the virtual keyboard for the Local HMI


The virtual keyboard can be deactivated to prevent it from appearing on the screen of the local
HMI when a physical keyboard is connected to the SMP Gateway.

To deactivate the Virtual keyboard for the local HMI:

1. From the HMI menu, in the Parameters section, select Application Settings.
2. In the Keyboard section, remove the check mark in the Show the virtual keyboard box.

12.6.10. Creating keyboard shortcuts for the local display


Keyboard shortcuts allow for quick access to the SMP Gateway HMI's Diagrams and Device's
Front panel pages on the local display.

To create keyboard shortcuts for the local display:

1. From the HMI menu, in the Parameters section, select Application Settings.
2. In the Shortcuts section, for each configured Diagram and Device's Front panel page, you
can select a keyboard shortcut in each drop-down box associated to each page.
Result:

3. Then, simply use the configured shortcut to access the configured Diagram and Device's
Front panel page.

User Manual | page 124 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

12.7. Using the SMP Gateway HMI applications

12.7.1. Using the communication dashboard


The Communication dashboard allows users to get a quick overview, in a single page, of the
communication status of all the IEDs of the substation.
The SMP Gateway HMI Communication dashboard is automatically configured by the
SMP Gateway. It can be activated in SMP Config for remote access or local display (or both) to
be accessible to the user.
The dashboard’s main window displays the current status of each IED and control center
connections, and indicates if communication problems occurred since the last verification. The
Summary and Details panes on the right side also provide some connection statistics that are
usually visible through the Statistics or system data points.

The main window:


Each box corresponds to one master or slave protocol instance that is currently running on the
SMP Gateway.

Note: The following slave protocols are supported by the Communication dashboard:
DNP3, Modicon MODBUS, PG&E (Cooper 2179), Landis+Gyr (LG8979) and Valmet
(TEJAS Series V). The following master protocols are not supported by the communication
dashboard: GOOSE, BlueTree, GE (D20 I/O Modules), GE (Ethernet Global Data),
Interconnections… and most customer-proprietary protocols.

The name of the protocol instance appears in the center of the box (ex. F6_EV5_0). The
connection status appears at the lower portion of the box. If the connection status is set to
Communication Failed, the number of communication errors appears in a red circle in the
upper right portion of the box. The protocol instances are displayed in alphabetic order and a
filter at the top of the page allows searching by instance name or communication status.

Eaton User Manual | page 125


12 - Maintenance and commissioning with the SMP Gateway HMI

The following table presents the different connection statuses that can be displayed by the
communication dashboard:
Table 12 - Communication dashboard connection statuses
Status Color Description

Connected Green Indicates that the master or slave protocol is currently connected to the
corresponding IED or control center.

Failed Red Indicates that the master protocol is not currently connected to the
corresponding IED, generally because of a communication failure.

Disconnected Red Indicates that the slave protocol is not currently connected to the
corresponding control center, because of a communication failure or
because the control center is not currently communicating with the
SMP Gateway.

If you click on a box to select it, the corresponding connection details appear in the Details
pane.
The Summary and Details pane:
The statistics that appear in the Summary and Details pane of the communication dashboard
are tied to existing system data points on the SMP Gateway. As a result, if you reset the
statistics of a given protocol using the Reset button of the Details section, the corresponding
system data points of the given protocol will also be reset.
Similarly, if you click the Reset button in the Summary section, the statistics system data points
of all master and slave protocols will be reset.

Note: Unlike the Communication dashboard, a Reset operation performed from the
SMP Stats program has no effect on the corresponding system data points.

If you intend to use the Communication dashboard application, you must first enable it in the
gateway configuration, using SMP Config. Refer to the section Enabling the HMI applications
(page 120).

12.7.2. Using the Redundancy dashboard


The SMP Gateway HMI Redundancy dashboard is used to provide a general overview of a
redundancy group, from a specific SMP Gateway point of view.
The Redundancy Dashboard is automatically configured by the SMP Gateway if the unit is part
of a redundancy group. The page can be activated in SMP Config for remote access or local
display to be accessible to the user.
The dashboard contains two panes; the Status pane, informs the user about basic information
related to the statuses of the redundancy group the units within the group:
• The status of the redundancy group (shown between the two SMP Gateway units)
◦ The hot standby status is displayed in green, it shows that a fail over is possible.
Example of a hot standby status:

User Manual | page 126 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

• The partial hot standby is displayed in red; it shows that there is an issue. Typically, this is
a configuration mismatch that prevents both SMP Gateways to synchronize all configured
information.
Example of a partial hot standby status caused by a configuration mismatch:

• The status of both SMP Gateway of the redundancy group; active or standby, with or without
errors. To get details about errors causes, it is necessary to verify the log as well as the fail
over conditions on both SMP Gateways.
• The health status of both communication links (Link#1 and Link#2) connecting the redundant
devices together in the redundancy configuration. The redundancy is fully operational, even
when a communication link is down. It is however important to fix a communication link issue
quickly; the failure of both links will cause both SMP Gateways to become active at the same
time, thus invalidating the proper operation of both redundant SMP Gateways.
◦ A green communication link indicates no communication failure
◦ A red communication link indicates a communication failure
Example of a hot standby status with a communication link issue:

Eaton User Manual | page 127


12 - Maintenance and commissioning with the SMP Gateway HMI

The Fail over conditions for this SMP Gateway pane informs the user about the current fail
over conditions of the SMP Gateway with reference to the configured fail over conditions.
• The fail over statuses of the current SMP Gateway are displayed in the middle column and
may be shown in different colors:
◦ White: if the specific fail over condition is not specified or disabled in the fail over
configuration. For example, in the shown Redundancy dashboard, the Temperature OK
fail over condition is not set in the configuration, thus the fail over status is shown in white.
This condition is completely ignored by the redundancy feature.
◦ Green: if the specific fail over condition is specified in the fail over configuration and the
condition is met. For example, in the shown Redundancy dashboard, if the Memory OK
fail over condition is set in the configuration and the memory limit is not reached, thus the
fail over status would be shown in green. This condition is monitored by the redundancy
feature and this OK status means that nothing will be triggered based on this condition.
◦ Red: if the specific fail over condition is specified in the fail over configuration and the
condition is not met. For example, in the shown Redundancy dashboard, if the Additional
conditions OK fail over condition is set in the configuration and those conditions are
not met, thus the fail over status would be shown in red. This situation will impact the
redundancy feature; for example, it will cause the active SMP Gateway to resign if the
standby SMP Gateway is error free.
Example of a hot standby status with a fail over condition that is not met:

User Manual | page 128 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

12.7.3. Using the System dashboard


The System Dashboard displays basic system information related to the SMP Gateway
hardware, software and unit configuration. It is used for visualization only and is automatically
configured by the SMP Gateway.
The page can be activated in SMP Config for remote access or local display to be accessible to
the user.
The information is organized on one page, it includes:
• Security data base activation status, Security status
• Firewall status
• Hardware status (Temperature, Battery health)
• Synchronization status
• SMP Gateway current time and startup time (in local time)
• CPU utilization
• Memory utilization
• System load
• Settings Information
• Hardware Information
• Versions Information

The following screenshot shows the System Dashboard page on a SMP SG-4250.

Eaton User Manual | page 129


12 - Maintenance and commissioning with the SMP Gateway HMI

If you intend to use the System dashboard application, you must first enable it in the gateway
configuration, using SMP Config. Refer to the section Enabling the HMI applications (page
120).

12.7.4. Viewing data in real time


The SMP Gateway HMI is the easiest way to view analog and binary input and output data
points in real time.
These is no specific configuration needed on the HMI application for the Real Time Data Point
application other than to enable it for remote access and/or local display in SMP Config. (Refer
to section Enabling the HMI applications (page 120)).
To display a Real Time Data page, the user can choose from different options:
• All: All the SMP Gateway data points are listed, the user may need to navigate through many
pages using the arrows at the bottom of the page. The total number of data points is also
listed at the bottom of each page with the data point range of the actual page.
• Pinned Only: By default, the pinned only page is empty. The user must use the other Real
Time Data pages to pin the data points he wants to be displayed on this page.
◦ To pin a data point, go to a Real Time Data page where the target data point is displayed.

User Manual | page 130 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

■ Select the data point, when selected, the whole line becomes highlighted in medium
blue (the toolbar is dark blue, a data point change value is pale blue).
■ Click on the pin icon on the left side of the line. When unpinned, the icon is in a
diagonal position and when pinned, it is pointing down.
■ The Pin All option from the toolbar Utility icon (3 bullets placed vertically) can be used
to pin all data point on a selected page.
■ The pinned data point(s) is (or are) now displayed on the Pinned Only page.
◦ You can add as much data point as you want in the Pinned Only page. The data points
will then be displayed in the order they were selected.
• By Instance: When the user clicks on the small arrow next to By Instance, all the SMP
Gateway configured instances are listed. The user can then choose for which instance he
wants the data points to be displayed in real time.
• By Type: When the user clicks on the small arrow next to By Type, the four different data
point types are listed and the user can then choose which type he wants to display:
◦ Analog Inputs
◦ Analog Outputs
◦ Binary Inputs
◦ Binary Outputs

The following screenshot shows an example of an All Data Points page:

Description of the real time data points page


The page can display eleven columns; they are all enabled by default. The columns can be
disabled and enabled by the user and their width and order are also configurable directly on the
SMP Gateway HMI. A search utility is available in the toolbar’s middle section to help the user
find specific data points. All these elements are explained below.
Following is a description of all available data points list’s columns:
• Producer: Displays the instance name to which the listed data points belong; more
specifically, the names of the instance that produced the data points. When the “By Instance”
selection of a Real Time Data point list is made in the HMI menu, this column displays the
names of the instances that produced the data points which are produced and consumed by
the selected instance.
• Type: Displays the data point type; AI, BI, AO or BO
• Name: Displays the name of the data point.

Eaton User Manual | page 131


12 - Maintenance and commissioning with the SMP Gateway HMI

• Floating point Value: Displays the value retrieved from the device. For a binary point, the
value is 1.0000 or 0.0000.
• Integer Value: Displays the value retrieved from the device and represented as an integer.
For a binary point, the value is 1 or 0.
• State: Displays the current state of a binary point. The field is left empty for analog values.
• Quality: Displays the data point Quality attribute. The Quality gives additional information
about the precision of the data point value.
• Date/Time: Displays the Date and Time of the last change in the data point state or value if
the change goes beyond the specified deadband, for an analog value.
• Control Status: Displays the Control Status on the data point (selected, free…).
• Description: Displays the description related to the data point.
• Address: Displays the Address assigned to the data point while configuring the instance
component. This is useful for data point identification.

To change the number of data points displayed on the Real-Time Data points page:
• From the HMI menu, in the Parameters section, select Application Settings.
• In the Number of items to display per page box, select a predefined number (from 5
to 50) of data points to display on the Real-Time Data points pages. The selected setting
is immediately effective. If the chosen number is too large for the data points to fit on the
screen, the user must scroll up and down to see all data points.

To deselect or select one or more column(s):


• From the HMI menu, select one of the Real Time Data points page.
• From the Real Time Data point page, select the toolbar utility icon (3 bullets placed
vertically)
• Choose the option Select columns; a Columns Configuration window displays the eleven
possible columns.
• Put a check mark on the column you want to be displayed on the page or remove the check
mark by clicking on the box next to the column that you do not want displayed on the page.
• When your selection is done, click on the Real Time Data point page and the window will
disappear.
• You can use the Reset columns option from the toolbar utility icon to bring the page to the
default configuration which has all columns displayed.

To change the column order:


• From the HMI menu, select one of the Real Time Data points page.
• Click and hold on any column header on the page.
• Drag and drop each column where you want it to appear on the display.

To change the width of a column:


• From the HMI menu, select one of the Real Time Data points page.
• Pass the mouse over the line that separates two column headers. The mouse cursor will
change to a cross shape with arrows on the left and right.
• Click and drag the mouse to enlarge or reduce the width of the column on the left of the
cursor.

User Manual | page 132 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

Data points change in values or states:


The SMP Gateway HMI automatically highlights, in pale blue, any data point that changes in
value or state on the displayed page. The data point line stays highlighted for a few seconds
and then, if the data point does not change, its value or state for about five seconds, the pale
blue highlight is removed. The user as no control over this function, it is all managed by the
SMP Gateway and provides the user with a quick view of value or state changes on the page
displayed on the screen.
Search utility:
It is possible to have a large number of data points displayed on your screen. To help you find a
specific data point, a search utility function is available on the Real Time Data page’s toolbar.
The search applies for static attributes only, meaning that the search does not consider
information contained in the value, quality, state and date/time columns. The search criterion
applies to items contained in the instance, type, name and description columns.
Many search keywords are allowed to help find a specific item. The keywords typed in the
search field are highlighted in gray on the displayed page. Once the user clicks on the search
loop or press the Enter key, all eligible items containing the search keywords (all of them) are
displayed on the page.
For example: If you type the words version and number, all eligible items (instance, type, name,
description) that contain the words “version” and “number” will be displayed, others will be
hidden.

To return to a Real Time Data page, select the page you want from the menu again or delete the
keywords on the search utility and press the loop icon or the Enter key.
If you intend to use the Real-Time Data application, you must first enable it in the gateway
configuration, using SMP Config. Refer to the section Enabling the HMI applications (page
120).

12.7.5. Archives files from the HMI


The Archives application allows users to download IED files that are stored in the Archive
folder.
If the Archive folder is not configured in SMP Config, the Archives page remains empty. Refer
to Archives (page 85) to learn to configure an Archive folder.
A Delete All button, located on the upper left side of the page, allows the user to delete all
archive files at once. To use the Delete All button and access the download function, the View
and Management option must be enable in the SMP Config file and the user must have the
monitoring and Operation privileges.
Search utility:
It is possible to have a large number of files displayed on your screen. To help you find a
specific one, a search utility function is available on the Archives page’s toolbar. The search
criterion applies to items contained in the name and creation date columns only.
Downloading a file:
• From the HMI menu, in the System section, select Archives.

Eaton User Manual | page 133


12 - Maintenance and commissioning with the SMP Gateway HMI

• From the Archives page, click on the Download link corresponding to the file you want to
download.
• Your Internet browser opens a new tab to display the archive’s text file.

If you intend to use the Archives application, you must first enable it in the gateway
configuration, using SMP Config. Refer to the section Enabling SMP Gateway HMI in the
configuration file (page 120).

12.7.6. Statistics files from the HMI


The Statistics application displays the SMP Gateway real-time statistics. The statistic files are
the same as the one provided by the SMP Stats Tool.
To view the Statistics on the SMP Gateway HMI:
• Click on the HMI menu, in the System section, select Statistics. The available statistics files
are displayed.
• Expand the branches of the different statistic folders to access to the statistic files.

Refer to Viewing communications statistics in real time (page 97), to get information on the
different statistic files available.

Note: From the SMP Gateway HMI local display, only the following statistics are
available: General Information, Performance (General) and Vital System Information.

If you intend to use the Statistics application, you must first enable it in the gateway
configuration, using SMP Config. Refer to the section Enabling the HMI applications (page
120).

12.7.7. Log files from the HMI


The SMP Gateway HMI Logs application displays the same log files as provided by the
SMP Log Tool.
The remote SMP Gateway HMI can display a maximum of 10000 logs, the local display is
showing up to 5000 logs.
To view the log files from the SMP Gateway HMI:
• Click on the HMI menu, in the System section, select Logs. The available log files are
displayed under Logs in the HMI menu.

User Manual | page 134 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

• Select the log file you want and it will be displayed on the HMI page. The user may need to
navigate through many pages using the arrows at the bottom of the page. The total number
of entries is also listed at the bottom of each page with the entry range of the actual page.

A filter located in the toolbar is available, for all logs, to ease the search for specific information;
filtering is applied to all text of the selected log page, except for the Date/Time column.
Refer to Viewing log files (page 86), to get information on the different log files available.
If you intend to use the Logs application, you must first enable it in the gateway configuration,
using SMP Config. Refer to the section Enabling the HMI applications (page 120).

Note: From the SMP Gateway HMI local display, the Firewall and Security log files are
not available.

12.7.8. The Commissioning Tool


The SMP Gateway HMI provides a Commissioning Tool that simplifies the engineering
effort required for the implementation and the integration of a substation. It is intended to help
technician(s) and/or engineer(s) testing the SMP Gateway configuration and connectivity with
the substation devices and the SCADA.
The SMP Gateway HMI Commissioning Tool, when enabled in SMP Config, is only accessible
in remote access through the Web browser. The local display does not offer the Commissioning
Tool application.
To enable the Commissioning Tool in the configuration file:
• In SMP Config, expand the HMI branch; select the Access/Display branch.
• Under Standard Features, in the Real-Time Data cell, select the Real-Time Data and
Commissioning option.
• The configuration file must then be saved and sent to the SMP Gateway.

A commissioning session may be activated by users that have the System Management
privilege. The Operation privilege is also required for users that will perform the commissioning
operations, which are essentially the following:
• Forcing an analog/binary input point to a specific value/state. This operation allows
the validation of the configuration of the SMP Gateway’ slave protocol and the SCADA,
by verifying if all the gateway data points are correctly mapped on both sides, if minimum/
maximum values are correctly handled, etc.
• Performing a control operation on an analog/binary output point. This operation allows
the validation of the master protocols’ configuration, by verifying if the IED data points are
correctly configured in their corresponding masters, if scale and offset settings are correctly
specified for each data point, etc.

For example, by forcing each data point of an IED on the SMP Gateway, the technician/engineer
can verify that these points are correctly configured, and that transitions/changes for these are
correctly handled by the SCADA. On the other side, by executing control operation directly
on the SMP Gateway instead of performing them on the SCADA, the technician/engineer can
validate that the masters’ output points are correctly configured.
Activating the commissioning session

Eaton User Manual | page 135


12 - Maintenance and commissioning with the SMP Gateway HMI

Commissioning is not a process that is performed frequently. Done once when the
SMP Gateway is deployed in the field, it may be executed later, during maintenance sessions or
when new devices are added to the substation configuration.
Before letting the user perform commissioning in the field, a user with System Management
privilege must activate the commissioning feature. Usually, this user would first make sure
that all safety precautions have been taken, that the SMP Gateway is really going through
maintenance and that the commissioning process may occur as planned. By activating the
feature, the operator in charge of commissioning can then start a commissioning session, and
do his work.
To activate the commissioning session:
• From the HMI menu (remote access only), in the Real Time Data Points section, select
Commissioning Tool application.
• On the Commissioning Tool page, under Manage the commissioning session, click on the
Activate Commissioning button. The commissioning icon appears on the right side of
the toolbar and the user is ready to start a session.
• Following is a snapshot of the upper left part of the Commissioning Tool page.

The button text will change to Deactivate commissioning, and the Start Session button on its
right will become available. The operator may now start a commissioning session.

Note: Commissioning will remain active until the Deactivate Commissioning button is
clicked to deactivate it. If the SMP Gateway is restarted, the commissioning feature activity
state will be persisted: if it was active prior to the restart, it will be active at startup and vice-
versa. However, sessions in progress will be terminated.

12.7.8.1. Starting a commissioning session


Once the Commissioning Tool has been activated on the SMP Gateway, any user that has the
Operation privilege can start a commissioning session.
To start a commissioning session:
• From the HMI menu (remote access only), in the Real Time Data Points section, select
Commissioning Tool application.
• Activate the commissioning session as described previously.
• Click on the Start Session button.
• The button text will change to Stop Session, the Commissioning Tool toolbar will change
from blue to brown and the Commissioning Tool icon will change to
• The following message will then be displayed under the Stop Session button: “You are
currently logged in a commissioning session”.
• These changes will stay in place until the session is stopped.
• The user can then use the Commissioning Tool.

User Manual | page 136 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

When in commissioning session, the local display’s toolbar will also become brown with the
Commissioning Tool “in session” icon. The following message is displayed on the toolbar:
“Commissioning operations cannot be performed through local display”. The other HMI
applications are still available on the local display.

Note: The commissioning session will remain established as long as the Web browser
will remain connected to the Website, or until the user clicks on the Stop Session button.
The session is also terminated when the SMP Gateway restarts.

12.7.8.2. Instance behaviors


Before starting to perform simulation operations on data points, the user must choose the way
the simulation is to be driven:
• Globally, for all protocol and system component instances at once.
• Individually, for each protocol or system component instances.

For these two options, there is two different ways to achieve the data points simulation, if
allowed. The selection is performed using the Behavior settings of the Commissioning Tool
application, either under the Manage instance behavior globally section or under the Manage
instance behavior individually section, for the selected instance(s).
Following is a description of the three options available, and their effect on the commissioning
session.
• No simulation allowed: Simulation operations are disabled. If you select a data point on the
list of an instance configured with this option, a message is displayed in the commissioning
toolbar reminding you that the selected behavior does not allow commissioning operations.
• Simulation allowed: Simulation operations are enabled, on a point per point basis. This
means that each data point from the instance that is to be simulated shall be selected and
simulated individually. For the selected data point:

Eaton User Manual | page 137


12 - Maintenance and commissioning with the SMP Gateway HMI

◦ The last value read from the real device, if any, is displayed in the commissioning toolbar
field located on the top of the data point list. The user can then replace this value with the
one to be simulated, and then apply the value using the Execute button.
◦ The data point will then be marked as simulated, using the Simulated icon on the leftmost
side column (icon column location can be changed).
◦ The data point quality will be marked as simulated.
◦ For an output data point, the simulated control operation is sent to the device.
• Simulate device: Simulation operations are enabled, and all points of the instance are
initially forced to their actual value/state read from the device, if any. Additional simulation
operations can then be performed on a point per point basis, as described in the Simulation
allowed settings below. With this behavior:
◦ All data points are marked as simulated using, for each of them, the Simulated icon on the
leftmost column (icon column location can be changed).
◦ All data point quality are set to OK.
◦ Output control operations are simulated by the owner of the selected output point, and
thus no control operation is sent to the end device.

Note: After the execution a command operation on an output point, the value or
state of the point will not be modified on the Commissioning Tool’s data point page.
The user will therefore not see the newly force value or state on the page.

The number of simulated points for each instance is displayed on the commissioning tool page,
under Status.

To start or modify commissioning operations using the Manage instance behavior


globally section:
• The user must first select a Behavior under the Manage instance behavior globally
section.
• Then, the user must click on the Apply to All button.
• All instance behaviors located in the section Manage instance behavior individually
display the previously selected behavior and the column Points Quantity displays the total
number of data points included in the protocol instance.
• Then, the user must click on the instance name and the data point list will be displayed and
ready for data simulation.
• To go back to the Commissioning Tool page, simply click on the commissioning icon located
on the right side of the tool bar.
• The Status column displays the number of simulated points for a specific instance, if any.
• Then, the user must click on the instance name and the data point list will be displayed and
ready for data simulation.

Note: When a simulation behavior is selected under the section Manage instance behavior
globally, the instance behaviors under the Manage instance behavior individually are
modified to reflect the selected behavior as soon as the user clicks on the Apply to All button.
After that, the user can still manage the instance behaviors individually without affecting the
selected instance behavior under the Manage instance behavior globally section.
To start or modify commissioning operations using the Manage instance behavior
individually section:

User Manual | page 138 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

• The user must select a Behavior under the Manage instance behavior individually section
for one or more targeted protocol instance(s).
• The user can do the same operation for another instance by simply clicking on the
Commissioning icon to come back to the Commissioning Tool page.
• All instance behaviors located in the section Manage instance behavior individually
display the selected behavior and the column Points Quantity displays the total number of
data points included in the protocol instance.
• Then, the user must click on the instance name and the data point list will be displayed and
ready for data simulation.
• To go back to the Commissioning Tool page, simply click on the commissioning icon located
on the right side of the tool bar.
• The Status column displays the number of simulated points for a specific instance, if any.

12.7.8.3. The data point list used for the commissioning session
The data point list displayed in a commissioning session looks quite similar to other data points
lists. It is divided in two sections:
• The toolbar, which is located at the top. It becomes an extended version of the toolbar
available in the SMP Gateway HMI pages. Additional features are added: a search function,
fields used to perform simulation operations and its content varies in function of the selected
data point type. The following figure shows the toolbar when a binary input point is selected:

• The data points list. Displays the data points belonging to the selected protocol instance of
the SMP Gateway. The user may need to navigate through many pages using the arrows at
the bottom of the page. The total number of data points is also listed at the bottom of each
page with the data point range of the actual page.

The columns descriptions are identical as the ones in the Real Time Data Point page in section
Viewing data in real time (page 130).

12.7.8.4. Forcing data points


The various commissioning operations that can be performed are described in the following
sections. Commissioning operations can either be performed directly from the Commissioning
Tool page or from a Diagram page.
Commissioning operations from a Diagram page are allowed only if a commissioning session
is started, if the instance behavior allows simulation for the related data points and finally, if the
function Allow access to shape animation information as well as to simulation and control
of animation points from the Commissioning Tool page is selected.
Following is a snapshot of the feature in a Single-Line Diagram :

Eaton User Manual | page 139


12 - Maintenance and commissioning with the SMP Gateway HMI

Forcing an input point

The most common commissioning operation is to force an input point to a specific value/state,
and to verify that the forced value is correctly reported to the SCADA.
The following procedures are described using the data point lists from the Commissioning
Tool page; forcing values or states is done in a similar way from a Diagram page, refer to the
previous snapshot for specific instructions, otherwise the procedures are similar to the ones
described below.

Note: You cannot force the value/state of multiple data points simultaneously.

To force an input point to a specific value:

1. In the data points list, select the input point you want to test (the line becomes colored) In the
commissioning toolbar, specify the forced value/state:
a. If it is an analog input point, select whether to change the Integer or Float value of the
point, using the drop-down list on the right side of the data point name, and then type the
forced value in the box on the right.
b. If it is a binary input point, select the desired state using the drop down list on the right
side of the data point name.
2. Still in the commissioning toolbar, click Execute to force the point to the specified value.
3. If the operation was successful, the Value or State column will display the forced value or
state for the data point which will be marked as simulated with an icon on the leftmost side of
the forced data point line. (icon column location can be changed)
4. If the operation was successful and both the SMP Gateway and the SCADA are correctly
configured, the value/state change should be reported correctly to the SCADA.

Reverting an input point to its current value

1. To revert an input point to its current value:


a. In the data points list, select the forced input point.

User Manual | page 140 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

b. In the commissioning toolbar, click Remove Simulation. The point will revert to its current
value/state and the simulation icon is removed from the data point line.
2. To revert multiple input points to their current values:
a. All forced data points are restored at once when the user clicks on Stop Session from the
Commissioning Tool page.
b. You can also revert all forced data points, for a specific instance, to their current values,
by selecting the No simulation allowed instance behavior for the selected instance on
the Commissioning Tool page.

Performing a control operation

When an IED supports control operations, it is important to validate that its related output points
are correctly configured on both the SCADA and the SMP Gateway sides. Such validation is
achieved in two steps, for each output point:
• Perform a control operation using the Commissioning Tool, to make sure that the point is
correctly configured in the SMP Gateway master configuration and that the control result is
correctly reported to the SCADA.
• Perform a control operation from the SCADA standpoint, as a final validation to make sure
that both the SCADA and the SMP Gateway slave configurations are correct.

The Remote SMP Gateway HMI has an option that allows asking the user to confirm the
operation when performing a control operation on a control point via the Commissioning Tool.
This option is useful to avoid operating inadvertently the wrong control point.

Note: You cannot perform control operations on multiple output points simultaneously.

1. To enable the confirmation request window when performing a control operation:


a. From the HMI Menu, in the Parameters section, select Application Settings.
b. Under Commissioning Tool, check the Ask a confirmation before sending a control
operation option.
2. To perform a control operation using the Commissioning Tool, On the Commissioning Tool
page, make sure the commissioning session is started.
3. Select a Behavior either globally or individually for the instance(s) you want to test.
4. Click on the instance name to access its data point list.
5. On the data points list page, select the output point you want to test.
6. On the data points list page’s toolbar:
a. Specify the control type using the Control drop-down list.

Note: If the output point supports select and execute control types, remember to
test both control types.

b. Specify the control value: If it is an analog output point, select the control value type
(Integer or Float) using the appropriate drop-down list, and then type the control value in
the edit box.
c. Specify the control value: If it is a binary output point, select the control state (Pulse,
Open or Close) using the appropriate drop-down list. If you selected Pulse, type the pulse
duration, in milliseconds, in the edit box.
d. Click Execute to perform the control operation.

Eaton User Manual | page 141


12 - Maintenance and commissioning with the SMP Gateway HMI

e. A confirmation request window asks for a confirmation if the option Ask a confirmation
before sending a control operation in the Application Settings is selected. Click OK.
7. If the operation was successful and both the SMP Gateway and the SCADA are correctly
configured, the control operation result should be reported correctly up to the SCADA.

As mentioned earlier in this section, the validation of the output point`s configuration at the
SCADA and in the SMP Gateway is achieved by performing a control operation directly from the
SCADA. Even if it does not involve the Commissioning Tool, the Web browser can still be useful,
since it gives access to the SMP Gateway log files, including the Control log file.
Various entries are added to the Control log when a control operation is executed on the
SMP Gateway, making it an essential resource for this portion of the commissioning task.

What to do next:
To consult the Control log entries from the SMP Gateway HMI (remote access):
• From the HMI menu, under the System section, select Logs to expand the available log
files.
• Select the Control log file.

All the log entries will appear in the right pane, the oldest entry being displayed at the top.

12.7.8.5. Closing the commisssioning session


Even if a commissioning session automatically ends when the Web browser is closed, you
should close the session manually.
To close the commissioning session:

1. From the HMI menu, under the Real Time Data Points section, select the Commissioning
Tool application.
2. On the Commissioning Tool page, under Manage the commissioning session, click Stop
Session.
a. If you still have simulated points, a message will be displayed: Are you sure you want to
stop the commissioning session? There is still at least one simulated point.
b. If you click OK, the remaining simulated data points will restore all forced points to their
acquisition values. If you click Cancel, the commissioning session stays on and you can
revert the simulated data points by selecting the behavior No simulation allowed for
each instance having simulated data points or go on with your simulation session.
3. If you have no simulated points, the session will be stopped.
4. The button text will change to Start Session.

12.7.8.6. Deactivating the commissioning feature


When commissioning has been performed on the SMP Gateway, the user that has System
Management privilege must deactivate the commissioning feature for obvious safety reasons
and to ensure that the system will function as expected.
To deactivate commissioning:

1. From the HMI menu, under the Real Time Data Points section, select the Commissioning
Tool application.

User Manual | page 142 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

2. On the Commissioning Tool page, under Manage the commissioning session, click the
Deactivate Commissioning button.
3. The button text will change to Activate Commissioning, and the button on its right will
become unavailable. The Commissioning Tool icon is removed from the toolbar.

12.7.8.7. Sharing a commissioning session


Up to 8 users can share a commissioning session. The first user will have to click on the Start
Session button to start a commissioning session. A message is displayed below the Start
Session button saying that there is currently no user logged in a commissioning session.
The other users (2 to 7) will see that the commissioning toolbar is brown and a message will
inform them of the number of users actually logged into the commissioning session. For them,
the button to start the session will be the Join Session button.
To stop the session, users 2 to 7 will click on the Leave session button. When they leave, all
simulated points are left as they are. The last user to click on Stop Session will have to manage
these points.
Simulation mode settings (behaviors) can be modified by the initial user that started the session
and by users who joined the session. When a change in these simulation mode settings is
made, all simulations for that instance are reverted back.

12.7.8.8. Losing the web browser connection while in commissioning


In commissioning, it happens frequently that the SMP Gateway must be restarted. When the
connection to the SMP Gateway HMI is restored, if the user had joined a session, he will be
asked if he want to restore the commissioning context, i.e. recover the commissioning session
with the previous settings.
• If the user clicks on the Yes button, the commissioning session will be restarted and restored
with the previous simulation behaviors settings. However, the simulated data points are
not restored. If the configuration file was modified and some instances are not available
anymore, they will be ignored after the session context is restored. Otherwise, if some
instances were added, their simulation behavior will be set to No simulation allowed.
• If the user clicks on the No button, the commissioning session stays closed.

12.7.9. Using the Alarm log


An Alarm log file is stored in the gateway non-volatile memory to keep track of the most recent
alarms that were triggered, and of the operations that were executed to handle them.
The log file is circular and has a limited size: when it is full, new entries replace the oldest ones.
The Alarm log file entries are displayed in chronological order, starting with the oldest one at the
top.
To display the Alarm log file on the SMP Gateway HMI:
• From the HMI menu, under the System section, select the Logs application. The available
log files are displayed under Logs in the HMI menu.
• Select the Alarm log file and it will be displayed on the HMI page. The user may need to
navigate through many pages using the arrows at the bottom of the page. The total number
of entries is also listed on the bottom of each page with the entry range of the actual page.

Eaton User Manual | page 143


12 - Maintenance and commissioning with the SMP Gateway HMI

• The Alarm log file is also available using the SMP Log application.

The Alarms log page has four columns:


• The Date and Time column: By clicking on the arrow located on the column header, the user
can change the chronological order of the data entries.
• The Code column: Every time an alarm appears or returns to normal, an entry is added
to the log file. In that case, the Code column indicates Alarm. Whether the operator clears
sound, acknowledges or recalls alarms, blocks or unblocks alarms, or performs control
operations; an entry is also added to the log file. In that case, the Code column indicates
Operator.
• The Sub Code column provides precision related to the Code, if available.
• The Description column: The action executed by the operator is described in the
Description column or in the case of an alarm, the message displayed in the Description
column is the same that appears in the Alarms page.

12.7.10. Using the Features Status application


The SMP Gateway HMI Features Status application is used for visualization only and is
automatically configured by the SMP Gateway.
The page is always available when the SMP Gateway HMI is enabled. The page is used as
startup page when:
• All HMI applications are disabled in the configuration file.
• The selected application for the startup page has been disabled by the user in the
configuration file.

The Features Status page shows the HMI major applications and displays, for each of them,
information concerning their license, their actual configuration in SMP Config and their status.

User Manual | page 144 Eaton


12 - Maintenance and commissioning with the SMP Gateway HMI

The Function column: displays all possible SMP Gateway HMI applications. When Diagram
pages have been transferred to the SMP Gateway, the page names are listed under the
Diagrams application.
The License column: displays, for each listed HMI applications, the license confirmation for the
application. If the license has been activated for a specific function, the column displays a Yes.
The Configuration column: displays the configuration setting selected in the SMP Config file
for the HMI applications.
The Status column: displays, for each listed HMI application, the status of the application
according to the user’s privilege and the configuration setting selected (Active or Inactive)
It is also used to indicate if diagrams are loaded on the SMP Gateway or not (Active – not
preloaded). For the local display, all diagram pages are preloaded by default; a Stop button
allows the user to skip the preloading operation of these pages in order to shorten the loading
time. The SMP Gateway HMI accessed remotely does not preload the diagram pages. The
diagram pages that are not preloaded can be loaded when the user clicks on the diagram page
link for the first time.

Note: If the SMP Gateway does not have sufficient memory to load all diagram pages,
it will stop loading the diagram pages. The pages that are not loaded will be identified in the
Features Status page and a message will be displayed to inform the user that the memory is
insufficient to handle all the diagram pages.

Eaton User Manual | page 145


13. Operations with the SMP Gateway HMI
The operational part of the HMI is specific for handling alarms and performing control
operations.
In SMP Config, the user can setup alarms based on the analog and binary data points of their
SMP Gateway and design Single-Line and application diagrams and Device's Front Panel
pages, to provide a unified view of the devices in a substation. These Diagram and Device's
Front Panel pages also allow control operations on the various devices.

13.1. The Active Alarms page


The Active Alarms page is essentially where all active or non-acknowledged alarms are
displayed in a list.
The Active Alarms page may display:
• A new alarm, that is still active
• An alarm that has returned to a normal state but needs to be acknowledged
• Multiple appearance of an alarm, that is still in an active state
• multiple appearance of an alarm that has returned to its normal state but needs to be
acknowledged

These alarms are handled by the operator of the SMP Gateway HMI using touch buttons on the
local display or by clicking with a mouse on the buttons when connected remotely via the Web
Browser. To learn how to manage these alarms, see section Managing alarms (page 171).
To configure the display settings of the Active Alarms page:
• In SMP Config, from the tree view, expand the HMI branch and then the Alarms branch.
• Select the Active branch. The resulting content of the right pane is presented in the next
screenshot.

To setup the Active Alarms page, you must go through the following steps:
• Define the Alarm list order.
• Define the type of alarm acknowledgment you want.
• Define the columns you want to display on the page and in which order.

User Manual | page 146 Eaton


13 - Operations with the SMP Gateway HMI

• Define the alarm state colors for minor and major alarms.
• Enable or Disable the Single Alarm Display function (which is not displayed on the Active
Alarms page but on the Communication and System Dashboard, Blocked Alarms, Diagram
and Real Time Data Points pages).
◦ When enabled, define the type of Single Alarm Display you want.
• Define the name of the Acknowledge new alarm button (the button used by the operator to
acknowledge that he is aware that one or more new alarm(s) have been triggered).
• Visualize, in the preview pane, the general appearance of the Active Alarms page, and
modify the configuration if necessary.
◦ Remove or add a column from the preview pane or from the columns pane.
◦ Change the column width from the preview pane.
◦ Change the column order from the preview pane or from the columns pane.

13.1.1. The preview pane


The Preview pane gives you a general idea, when configuring, of the look of the Active Alarms
page according to:
• the Alarm state colors chosen for the major and minor alarms.
• the columns width, order and availability to be displayed on the Active Alarms page.

Changing the column width and order from the preview pane gives you a general feeling of the
display but will not be effective on the SMP Gateway HMI Active Alarms page. You need to use
the Columns pane to make these changes effective on the HMI. Note that the columns width
and order can be modified directly on the SMP Gateway HMI (refer to section Managing alarms
(page 171)).
To change the width of a column in the preview pane:
• Pass the mouse over the line that separates two column headers. The mouse cursor will
change to this:

• Click and drag the mouse to enlarge or reduce the width of the column on the left of the
cursor.

To change the column order:


• Drag and drop each column where you want it to appear on the display.
• You can also to this using the Move Up and Move Down buttons appearing under Columns at
the top of the edition pane.

To make a column available/unavailable for the operator:


• Right-click any column header in the preview display.

Eaton User Manual | page 147


13 - Operations with the SMP Gateway HMI

• A check mark indicates that the column will be available, and it should be displayed as is in
the preview pane.
• Select any column name to change its availability state.

If you intend to use the Alarms application, you must first enable it in the gateway configuration,
using SMP Config. Refer to the section Enabling the HMI applications (page 120).

13.2. Setting up the Active Alarms page


To setup the Active Alarms page :

1. Under Alarm list order, select which alarms should be displayed at the top of the list:
a. The Oldest alarm at top setting is recommended if you want to deal with each alarm in
order and work them down to the most recent.
b. If you want to deal with alarms as they occur, select Most recent alarm at top.
2. Under Alarm acknowledgement, select how alarms will be acknowledged by the operator:
a. To be free to acknowledge and recall any alarm in any given order, select Alarms can be
acknowledged and recalled in any order.
b. To force the operator to acknowledge and recall alarms in the order they occur, select
Alarms must be acknowledged and recalled in the order they occurred.
c. To automatically acknowledge and recall alarms as they occur, without the intervention of
the operator, select Alarms automatically acknowledge and recall.
3. Under Columns, select which columns should be displayed in the alarms list. Remember
that you can see the result of your selection in the Preview pane.
4. Still under Columns, you can move the column names up and down using the Move Up and
Move Down buttons. Selected columns will appear from left to right, starting with the topmost
column name in the list.
5. Under Alarm state colors, set the colors for alarm messages that appear in the SMP
Gateway HMI various display pages:
a. Set the text and fill colors for active unacknowledged alarm messages. Different colors
may be specified for major and minor alarms.
b. Do the same for active acknowledged alarms, unacknowledged alarms that have returned
to normal and acknowledged alarms that have returned to alarms.
c. To revert to default colors, click Default Colors.
6. If you want the Single Alarm Display to appear at the bottom of the HMI applications pages,
put a checkmark in the Display the single alarm area check box, and then under Single
Alarm Display, select which alarm should be displayed in this area:

User Manual | page 148 Eaton


13 - Operations with the SMP Gateway HMI

Note: To learn how to use the single alarm display, refer to The Single alarm display
(page 174)

a. To see the oldest unacknowledged alarm, select Show oldest unacknowledged alarm.
b. To see the most recent unacknowledged alarm, select Show most recent
unacknowledged alarm.
c. When the single alarm display is enabled, it will be displayed at the bottom of the following
pages:
• The Communication and System Dashboard pages
• The Blocked Alarms page
• The Diagrams pages
• The Real-Time Data Points pages
7. On the SMP Gateway HMI Active Alarms page, the toolbar’s middle section displays five
buttons. The leftmost button is used to acknowledge the appearance of new alarms. Not
to be confused with the acknowledge button itself, it is as the first step undertaken by an
operator to notify the system that he knows that this alarm was triggered. The name of this
button can be changed, as follows:
Example:
Beside Acknowledge new alarms label, type the new name of the button. For example,
if the SMP Gateway is equipped with a sound buzzer, you might want to name it Clear
Sound.

Note: On the SMP Gateway HMI Active Alarms page, the five buttons are located
in the toolbar’s middle section.

8. You can also use the preview section of the edition pane to modify the columns’ width, order
and availability state.

Eaton User Manual | page 149


13 - Operations with the SMP Gateway HMI

13.3. Setting up the Blocked Alarms page


An operator may want to “deactivate” some alarms at runtime, during maintenance periods for
example. The SMP Gateway HMI makes it possible by allowing some alarm data points to be
blocked.

When alarm data points are blocked, it means that even when alarm conditions are met for
these points, they will no longer appear in the Active Alarms page: the blocked alarms are then
transferred to the Blocked Alarms page.
To learn how to block and unblock alarms, see Blocking and reactivating blocked alarms (page
173).
To configure the display settings of the Blocked Alarms page:

1. In SMP Config, from the tree view, expand the HMI branch, expand the Alarms branch
and select the Blocked branch. The resulting content of the right pane is presented in the
following screenshot.
Result:

2. Under Columns, select which columns should be displayed in the Blocked Alarms page.
You can see the result of your selection under Preview.
3. Still under Columns, you can move the column names up and down using the Move Up and
Move Down buttons. Selected columns will appear from left to right, starting with the topmost
column name in the list.
4. You can also use the preview pane section to modify the columns’ width, order and
availability state, like for the Active Alarms page (see Setting up the Active Alarms page
(page 148)).

Changing the column width and order from the preview pane gives you a general feeling of the
display but will not be effective on the SMP Gateway HMI Blocked Alarms page. You need
to use the Columns pane to make these changes effective on the HMI. Note that the columns
width and order can be modified directly on the SMP Gateway HMI (Refer to Managing alarms
(page 171)).
If you intend to use the Alarms application, you must first enable it in the gateway configuration,
using SMP Config. Refer to the section Enabling the HMI applications (page 120)

User Manual | page 150 Eaton


13 - Operations with the SMP Gateway HMI

13.4. Setting up the Alarms History page


The Alarms History page is used to keep track of the most recent alarms that were triggered,
and of the operations that were executed to handle them.

Alarm messages are also preserved in the Alarm log file, which content is basically the same
information but displayed differently.
To configure the display settings of the History page:

1. In SMP Config, from the tree view, expand the HMI branch, expand the Alarms branch
and select the History branch. The resulting content of the right pane is presented in the
following screenshot.
Result:

2. Under Columns, select which columns should be displayed in the Alarm History Page. You
can see the result of your selection under Preview.
3. Still under Columns, you can move the column names up and down using the Move Up and
Move Down buttons. Selected columns will appear from left to right, starting with the first
column name in the list.
4. Finally, you can add a Clear History button to this page, by putting a checkmark in the
Show clear button check box. This button allows you clear the Alarm History Page of all its
contents.

The list is circular and can hold a limited number of alarms or operations on these alarms, which
is called the history length; when it is full, new entries replace the oldest ones.

Note: If the Description field was left empty while configuring the alarm, the description
of the data point in the protocol instance is used in the alarm description column.

Eaton User Manual | page 151


13 - Operations with the SMP Gateway HMI

13.5. Managing control permission on control points


The Control Authorization function, in SMP Config, allows to specify which user or group has
the permission to control specific points (AO/BO). To do that, the name of the control points
and the user names or groups must be specified in the function; otherwise, if no control point
is specified, no restrictions are imposed unless the user does not have the required Monitoring
and Control privileges.

Note: It is not possible to limit access to a whole page, only to specific control points.
Also, this function does not apply to a Commissioning Tool session.

To manage control permission on control points:

1. In SMP Config, from the tree view, expand the HMI branch. Select the Control
Authorization branch.
2. In the Control Authorization pane, place your mouse pointer in the first free Name cell, to
highlight it.
3. In the left pane, right-click on the Control Authorization branch and click Select Points.
4. In the Select Points windows, choose the control point over which control authorization will
be allowed for specific users or groups. You must choose a binary or analog output point
otherwise, you will have an error message at validation.
5. In the corresponding User Names cell, enter User(s) and/or Group(s) for which you want to
allow access to the specified point. You can add several Users and/or Groups, separated by
a coma.
6. Repeat this operation, for as many points you want.
7. Validate your configuration file.
8. Save the configuration file and send it to the SMP Gateway.

A users that does not have permission on a control point will get a Refused message upon a
control request on that point.

13.6. Diagrams for the SMP Gateway HMI


Diagrams used for the SMP Gateway HMI can be created using several applications. This
section explains the difference between these applications and mainly focuses on the SMP
Diagram Editor application.
The procedures to save, upload and retrieve an HMI file according to the application used to
create the diagrams are also provided in this section.
Two different applications can be used to create diagrams for the SMP Gateway HMI:

User Manual | page 152 Eaton


13 - Operations with the SMP Gateway HMI

• The Visual T&D Diagram Editor: Editor used to create diagrams for Visual T&D and for
the SMP Gateway. The Visual T&D software must be installed to use this editor. When
Visual T&D Diagram Editor is used to design SMP Gateway HMI diagrams, it is necessary
to export the diagrams to the SMP Gateway HMI Package (.hmi) format, which can then be
uploaded on the SMP Gateway. To learn how to design diagrams using Visual T&D Diagram
Editor, refer to the Visual T&D Diagram Editor User Guide.
• The SMP Diagram Editor: Diagram Editor adapted for use with the SMP Gateway HMI,
it includes SMP Gateway-specific applications that are not available with the Visual T&D
diagram Editor; it is installed with the SMP Gateway Software and Tools.
◦ Can be launched directly from SMP Config: the diagrams are saved directly within the
SMP Gateway configuration file. This is the preferred method for creating and saving
diagrams.
◦ Can be launched from SMP Manager: diagrams are saved in a separate file (.hmi) that
has to be loaded to the SMP Gateway HMI. SMP Diagram Editor icon is placed in the
SMP Manager Toolbar for this purpose (placed on the right side of the Web HMI browser
icon). The program can also be launched from the SMP Manager using the Tools menu.
The disadvantage of this method is that you have to load the file to the SMP Gateway
separately from the configuration file and you have two files to manage.

Note: For SMP Gateway Software and Tools version earlier than 8.0R1, Visual T&D
Diagram Editor remains the only way to create or modify diagrams for the SMP Gateway
HMI. The Visual T&D application must be installed separately.

Once the HMI file is sent to the SMP Gateway (embedded in the configuration file or sent
separately) users can access the diagram pages either locally, through a touchscreen
connected directly via the SMP Gateway HMI's local display, or remotely through a Web
browser.
Visual T&D documentation provides all the provides all necessary information and instructions
to create high-quality interactive diagrams; these documents are included on the electronic
media. Some information is presented in this present document regarding the actions of
exporting, uploading and retrieving diagrams to the SMP Gateway.
The SMP Diagram Editor allows the use of some specific features, like the Gauge and Trend
graphs, that can be added to Diagram pages to produce useful indicators for users. These
specific features are not included in the Visual T&D documentation and are discussed in the
present document.

13.6.1. Using SMP Diagram Editor


The SMP Diagram Editor can be launched from SMP Config or SMP Manager.
Using SMP Diagram Editor, users can draw general application diagrams and single-line
representations of their substation, distribution or transmission grid or design Device's Front
Panel pages, load the corresponding multi-pages diagram on the SMP Gateway (for diagrams
that were not designed using the SMP Diagram editor launched from SMP Config), and then
access the pages either locally, through a touchscreen connected directly to the SMP Gateway
VIDEO port, or remotely through a Web browser via the SMP Gateway HMI.
Most functions are the same as the ones used by Diagram Editor from Visual T&D and you can
rely on the Visual T&D Diagram Editor User Guide for configuration guidance. However, some
functions were developed specifically for SMP Diagram Editor, these functions are described in
this section.

Eaton User Manual | page 153


13 - Operations with the SMP Gateway HMI

If you intend to use the Diagrams or the Device's Front Panel applications, you must first enable
them in the SMP Gateway configuration, using SMP Config. Refer to the section Enabling the
HMI applications (page 120).

Note: When the SMP Gateway HMI's favorites bar is displayed, the whole page on the
screen shifts to the right. If you intend to use the favorites bar, take into account the space
needed by the application when you design Diagram or Device's Front Panel pages. Leave
some space on the right side of the page to avoid the use of a scroll bar in order to be able to
view the whole page.

13.6.2. The SMP Diagram Editor interface


SMP Diagram Editor is available only in design mode; animation related functions and access to
the server are disabled. However, because the program is launched from SMP Config or SMP
Manager, access to the SMP Gateway data points is granted.
To learn how to design Diagrams, refer to the Visual T&D Diagram Editor User Guide. For SMP
Gateway specific features, this present document provides the necessary information.
An additional feature sets the SMP Diagram Editor apart from the Visual T&D Diagram
Editor to enforce Diagram edition in page dimensions that are adapted for the SMP Gateway
touchscreen display area. Therefore, the SMP Diagram Editor has two combo boxes located
in the Toolbar. They are used to resize all diagram pages in order for them to fit exactly in the
Diagram display area of the target screen.

The first box allows to choose between different SMP Gateway version ranges:

Note: This option is not configurable when SMP Diagram Editor is launched directly from
SMP Config.

• SMP Gateway 6.3R1 or later


• SMP Gateway 7.1R1 or later
• SMP Gateway 7.2R1 or later
• SMP Gateway 8.0R1 or later

The second box allows to choose a screen resolution adapted for the touchscreen connected to
the SMP Gateway video port and used for the SMP Gateway HMI local display. The choices for
the screen resolution are the following:
Table 13 - Possible screen resolution settings
800 x 600 1280 x 1024 1600 x 900

1024 x 768 1366 x 768 1680 x 1050

1280 x 800 1440 x 900 1920 x 1080

User Manual | page 154 Eaton


13 - Operations with the SMP Gateway HMI

13.6.3. Supported languages in Diagrams and Device's Front


panels pages
The SMP Gateway HMI is fully bilingual, supporting English and French languages. Additionally,
multiple languages are now supported in the local and remote SMP Gateway HMI for every field
customizable by the user.
This mainly applies to text entered by the user in the Diagram and Device's Front Panel pages.
The following table lists the Windows code pages supported by the SMP Gateway HMI.
Table 14 - Supported Windows code pages associated with different languages
Code page Associated language

1252 Afrikaans, Basque, Catalan, Danish, Dutch, English, Faroese, Finnish, French, Galician,
German, Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili,
Swedish

874 Thai

1250 Central Europe languages: Albanian, Croatian, Czech, Hungarian, Polish, Romanian, Serbian
(Latin), Slovak, Slovenian

1251 Cyrillic languages: Azeri, Belarusian, Bulgarian, Macedonian, Kazakh, Kyrgyz, Mongolian,
Russian, Serbian, Tatar, Ukrainian, Uzbek

1254 Turkic languages: Azeri (Latin), Turkish, Uzbek (Latin)

1255 Hebrew

1256 Arabic, Farsi, Urdu

1257 Baltic languages: Estonian, Latvian, Lithuanian

1258 Vietnamese

13.6.4. Supported fonts on the local display of the SMP


Gateway HMI
The following table lists the fonts which are supported by the local display of the SMP Gateway
HMI; these specific fonts can be used to create Diagrams and Device's Front Panels.
Table 15 - Supported fonts on the local display of the SMP Gateway HMI
Arial Courier New Segoe UI Tahoma Verdana

Arial Black Georgia Segoe UI Light Times New Roman Webdings

Arial Narrow Lucida Sans Unicode Segoe UI Semibold Trebuchet MS Wingdings

Comic Sans MS Microsoft Sans Serif

Using another font will generate a warning message; it is not possible to add new fonts.

Eaton User Manual | page 155


13 - Operations with the SMP Gateway HMI

13.6.5. Implementation of a control interlock software


mechanism in Diagrams
A control interlock software mechanism can be implemented in an SMP Gateway HMI Diagram,
by adding to a diagram page, a button that toggles the control operation mode (local or remote)
of the SMP Gateway.
The local and remote control operation mode are defined as follows:
Local control:
• Local control can be activated from the local HMI only.
• When local control is active, control operation can only be performed from local stations,
through the local HMI.
• Once the local control is active on the local HMI, it can then be deactivated from the local
HMI only.

Remote control:
• When remote control is active (local control inactive), control operations can be performed
both from local stations, through the remote and local HMI, and from the SCADA.
• It is not possible for the Remote HMI or SCADA to deactivate the local control operation
mode. The local control operation mode must be deactivated from the local HMI.

To toggle the control operation mode, the system data point _smp___setLocalControl is
used to switch from local to remote control. Additionally, the _smp___LocalControl data point
indicates whether the SMP Gateway is controlled locally (set to 1) or remotely (set to 0). For
additional information on these data points, refer to the description of this point in System data
points (page 307).
To learn how to set up a Control interaction on a diagram shape, refer to the “Interactions”
chapter of the Visual T&D Diagram Editor User Guide.

13.6.6. Creating Diagrams via SMP Config


Eaton provides a Diagrams section in SMP Config to allow users to create diagram pages with
SMP Diagram Editor launched directly from SMP Config.

SMP Diagram Editor can be launched directly from SMP Config to create standalone diagrams.
You simply launch the editor using the Edit function included in each created Diagram instance;
the created pages are then saved directly within the configuration file, thus allowing the use
of a single file for the complete configuration of the SMP Gateway. This method for creating
diagrams is preferred over the method of launching SMP Diagram Editor from SMP Manager.
Once created and saved, the diagrams are listed as diagram instances. The following
procedures show how to created a single diagram instance, directly from SMP Config.

Note: Refer to section Templates (page 157) if you want to design Diagram and
Device's Front Panel pages which have similarities (use of templates).

User Manual | page 156 Eaton


13 - Operations with the SMP Gateway HMI

To create a diagram instance:

1. In SMP Config, expand the HMI branch.


2. Select the Diagrams branch.
3. In the middle pane, enter a name for the diagram you are about to create.
4. In the left pane, expand the branch of the newly created diagram.
5. Select the Edit Branch.
6. In the middle pane, click on the Edit with SMP Diagram Editor button, located at the top.
7. Once SMP Diagram Editor is open, design the Diagram using the different shapes available.
The user has a total freedom regarding the point list configuration.
8. When you are satisfied with the design, save it using the File > Save option from the menu.
9. Exit SMP Diagram Editor using the File > Exit option from the menu.
10. From the menu, select Validate > Validate all.
11. Save the configuration file.
12. In SMP Manager, update the SMP Gateway using Update > Send Configuration File.
13. Open the SMP Gateway HMI; from the menu, in the Diagrams section, a diagram page
should be displayed for each created diagram instance. Select the newly created diagram
and verify the functionality of the animations and interactions.

You can also edit and modify an existing diagram by clicking on its name, then via the Edit
branch, launch the SMP Diagram Editor and modify the diagram following the previous
procedure.

13.6.7. Templates
Eaton provides two different template types to allow the user to design Diagrams and Device's
Front Panel pages which have similarities.
SMP Diagram Editor can be launched directly from SMP Config to create templates for
diagrams and Device's Front Panels which have common items. You simply launch the editor
using the Edit function included in each created Device's Front Panel; the created pages are
then saved directly within the configuration file, thus allowing the use of a single file for the
complete configuration of the SMP Gateway. Using these templates will save the user significant
configuration time and effort.

13.6.7.1. Device's Front Panel


A Device's Front Panel is an interactive visual representation of an IED connected to the SMP
Gateway; it is used to facilitate control interactions between a device and the SMP Gateway.
The creation of a Device's Front Panel is performed from the SMP Config file under the HMI/
Template branch; SMP Diagram Editor is launched directly from there for editing and designing
the Front Panel. The Front Panel layout is then saved as an embedded component into the
configuration file (.par), like a diagram.
Each Front Panel included in a configuration file is internally linked to at least one master
protocol instance in the SMP Gateway configuration file. On the SMP Gateway HMI, the
Device's Front Panels are listed in their own section, with a subsection for each master protocol
instance which is associated to the Device Front Panel template.

Eaton User Manual | page 157


13 - Operations with the SMP Gateway HMI

As mentioned previously, Device's Front Panels are displayed on their own pages; they can
be accessed via a Diagram page using the Open Page functionality, when configured to do so
(shape interaction), or directly from the SMP Gateway HMI menu, in the Device's Front Panels
section.
When using a template for designing a Device's Front Panel, the user can create shape
animations and/or interactions using points which are common to all master protocol instances
that are associated to this specific Front Panel. These common points are designated as
Symbols and are resolved in SMP Config, once the Front Panel design has been saved and
the configuration file validated.
Once the design phase completed, the user must assign these Symbols to points for each
associated master protocol instances.
The user can also create labels in SMP Diagram Editor and then define them for the master
protocol instances associated to the Front Panel template.
The following illustration shows the operation principle of the Front Panel design application.

The following illustration shows a Form6 Front Panel edited in SMP Diagram Editor.

User Manual | page 158 Eaton


13 - Operations with the SMP Gateway HMI

A Front Panel is closely tied to the specific master protocol instance to which it is linked to; it
depends on the master instance points for shape interaction and animation. For this reason,
Front Panel templates are not available as standalone files but rather a complete .par file,
containing an existing Front Panel. The reason is that once a specific Front Panel has been
designed and associated to at least one master protocol instance, it is embedded in the
configuration file containing the master protocol instance(s) to which is associated to.

13.6.7.2. Reusing an existing Device's Front Panel template from another


configuration file
To reuse an existing Device's Front Panel template that was created in another configuration
file, the user simply needs to create a master protocol instance using a similar instance from
another configuration file. Each time a master protocol instance which is associated to a
Front Panel template is imported from another configuration file, the Front Panel template is
automatically added to the configuration file, importing the master protocol instance with the
newly added master protocol instance already configured as associated instance.
The imported master protocol instance may be deleted subsequently if not needed and other
master protocol instances can be associated to the newly imported Front Panel template.
To reuse an existing Device's Front Panel template from another configuration file:

1. In SMP Config, expand the Master Protocols branch; select the protocol branch in which
you will add a master protocol instance.
2. Right-click on the selected branch and select Import instance from File
3. Select the Instance in the Source field and provide a Name and Device Prefix, then click
OK.A new instance is created in the Master Protocol branch and a new Device's Front Panel
is also created in the HMI/Devices Front Panel branch; we are assuming that the imported
protocol instance was associated with a Front Panel.
4. Click on the /HMI/Template/Devices Front Panel branch and rename the newly added
Device's Front Panel template according to your requirements.
5. Now you have the Device's Front Panel template in your current configuration file, the newly
added master protocol instance was configured as an associated instance during the import
process, it can be deleted and other instances can be associated with the Device's Front
Panel template. The newly added protocol instance can also be deleted from the Master
Protocols branch without affecting the Device's Front Panel diagram.
6. Associate the Master Protocol instance(s) to the Device's Front Panel template:
a. Select the Device Instances branch
b. In the middle pane, select at least one master protocol instance that will be associated
to the Front Panel. It is important to select master protocol instances that are appropriate
for the Front Panel’s shapes interaction and animation; they must share the appropriate
common points.
7. Edit the Front Panel, if necessary, if you must apply some modifications. Save the diagram if
modifications were implemented and exit SMP Diagram Editor.
8. In SMP Config, in the Device Instances branch, click on the first associated master protocol
instance. The middle pane shows two sections:
a. Label Resolution: this is where the created labels are associated names for this specific
instance. Enter the label names.
b. Symbol Resolution: this is where the symbols used in the Front Panel design are
associated to default point name for this specific instance. The user can override the
default point name by providing a name in the Override Point cell.

Eaton User Manual | page 159


13 - Operations with the SMP Gateway HMI

9. Repeat the previous step for all the associated master protocol instances in the Device
Instances branch.
10. Save the configuration file.
11. In SMP Manager, update the SMP Gateway using Update >Send Configuration File
12. Open the SMP Gateway HMI; from the menu, in the Devices Front Panel section, select
a Device's Front Panel and verify the functionality of the animations and interactions. The
following screenshot is an example of a Device's Front Panel on the SMP Gateway HMI, with
its control interaction window.
Result:

13.6.7.3. Template for Diagrams


The Diagram template is useful when the user must create several similar diagram pages which
are not related to a specific device.
With the Diagram template, the point list attached to the diagram is not associated to a particular
device or protocol instance but rather to a group of points used to define animations and
interactions on the diagram page. The user must create an instance for each Diagram page to
create.
Creating a Diagram using the template is similar to creating a Device's Front Panel with the
difference that with the Diagram template, the user has a total freedom regarding the point list
configuration; the created diagram is not linked to a specific protocol instance.
The design of the Diagram is performed from the SMP Config file, which launches the SMP
Diagram Editor for editing and designing the Diagram. The Diagram layout is then saved as an
embedded component into the configuration file (.par).
On the SMP Gateway HMI, the created Diagrams pages are accessible in the Diagrams
section, with other diagrams.
When designing a Diagram using the template, the user can create shape animation and/or
interaction using points that can be associated to any data point in the configuration file. The
use of Alias during the design phase will then result in Symbol names for each configured
instance associated to a specific Diagram template. So when naming an Alias, the data point
common string should be used, for example: if the protocol instance use a binary input point
named FP_81, then the Alias should be name FP_81.

User Manual | page 160 Eaton


13 - Operations with the SMP Gateway HMI

Once the design phase completed, and the configuration file validated, SMP Config resolves the
Symbol and assigns a point name to each Symbol. Each configured Diagram template instance
gives the possibility to assign a Prefix and a Suffix to the data points associated to the diagram
instance; even if optional, using a prefix and/or a suffix greatly increases the success of the
Symbol resolution operation. If the user is not satisfied with the result of the resolve operation,
which is located in the Point cell, he can manually write the point name in the Override Point
cell.
The user can also create labels in SMP Diagram Editor and then define them for the master
protocol instances associated to the Diagram template.

13.6.7.4. Creating a Diagram template


To create a Diagram template:

1. In SMP Config, expand the HMI branch, and then expand the Template branch.
2. Select the Diagrams branch.
3. In the middle pane, enter a name for the Diagram template you are about to create.
4. Enter a Prefix and Suffix that will be associated to the points related to the Diagram template.
The Prefix and Suffix are optional; however, using them greatly increases the success of the
Symbol resolution operation.
5. In the left pane, expand the branch of the newly created Diagram template.
6. Select the Edit Branch.
7. In the middle pane, click on the Edit with SMP Diagram Editor button, located at the top.
8. Once SMP Diagram Editor is open, design the Diagram template using the different shapes
available. The user has a total freedom regarding the point list configuration; the created
diagram is not linked to a specific protocol instance. The points used for shape interaction
and animation will then be referred as Symbols and associated to the corresponding points.
You can also add labels using the text box and the [labelxxx] format. The labels will then be
assigned to the associated instances
9. When you are satisfied with the design, save it using the File > Save option from the menu.
10. Exit SMP Diagram Editor using the File > Exit option from the menu.
11. From the menu, select Validate > Validate all.
12. In SMP Config, click on the first created Instance located under the Instances branch. The
middle pane shows two sections:
a. Label Resolution: this is where the created labels are associated with names for this
specific instance. Enter the label names.
b. Symbol Resolution: this is where the alias (symbols) used in the Diagram template
design are associated to point names for this specific instance. If a device prefix and/
or suffix were specified when creating the instance, the symbol resolution process is
greatly enhanced. The user can override the default point name by providing a name in
the Override Point cell.
13. Repeat the previous step for all the instances located under the Instances branch of the
Diagram template.
14. Save the configuration file.
15. In SMP Manager, update the SMP Gateway using Update > Send Configuration File.

Eaton User Manual | page 161


13 - Operations with the SMP Gateway HMI

16. Open the SMP Gateway HMI; from the menu, in the Diagrams section, a diagram page
should be displayed for each instance associated to the created Diagram template. Select a
Diagram page and verify the functionality of the animations and interactions.

13.6.8. SMP Diagram Editor's specific applications


The SMP Gateway HMI allows the use of some specific application features, like the Gauge,
Trend and Alarms indicators that can be displayed on the Diagram pages to presents useful
information for users in a graphical presentation.

The SMP Diagram Editor Toolbar gives direct access to these tree (3) indicators:
• The Active Alarms indicator on the far right side
• The Gauge indicator on the far left side
• The Trend indicator on the middle

These following sections present instructions on how to add and configure these indicators in
diagram pages.
• Adding an Active Alarms indicator into the Diagram page (page 162)
• Adding a Gauge indicator into a diagram page (page 163)
• Adding a Trend indicator into a diagram page (page 164)

Note: These features are only available in SMP Diagram Editor.

The Trend indicator is used to display up to five (5) trend curves to show real performance of
processes overtime.
Trend indicators are used to display a tendency; these indicators are not precise graphs. Trend
indicators are sampling the selected data points at regular intervals; the sampling rate depends
on the selected duration as well as the width of the Trend indicator on the page (number of
pixels). This means that certain transitions may be missed when they occur between two
sampling occurrences, especially when long trend duration is selected.

Note: If you are worried to loose certain values for a given point, between sampling
occurrences (for example minimum or maximum values); you can simply create a new point
using the automation function feature to retrieve the minimum, maximum or average value of
this specific point and display it on the Trend indicator as a separate curve.

13.6.8.1. Adding an Active Alarms indicator into the Diagram page


For convenience, to avoid having to switch between several HMI pages, it is possible to add
the Active Alarms indicator to a Diagram page. This Active Alarm indicator shows exactly the
same information as the Active Alarms Page of the SMP Gateway HMI, with the associated
buttons used for alarm management located in the SMP Gateway HMI toolbar. When added on
the Diagram page, this Active Alarms feature is not configurable.
To add the Active Alarm feature into an Diagram page:

1. In SMP Manager, click on the SMP Diagram Editor icon.


2. In SMP Diagram Editor, click on the Active Alarm icon from the Toolbar.

User Manual | page 162 Eaton


13 - Operations with the SMP Gateway HMI

3. On the SMP Diagram Editor’s design area, re-sized or move the Active Alarm Place holder
shape to fit properly on the Diagram page.
4. Add a title or descriptive text to identify the shape on the Diagram page, if necessary.
5. Save the file: File > Save as. This will generate a file with the shm extension.
6. Save the diagram to be used by the SMP Gateway HMI:
a. File > Export for SMP Gateway. This will generate a file with the hmi extension
b. From SMP Manager, send the .him file to the SMP Gateway: Update > Send File(s)
7. Open the SMP Gateway HMI using the Web browser icon in SMP Manager and verify that
the Active Alarm indicator is working properly.

13.6.8.2. Adding a Gauge indicator into a diagram page


The SMP Diagram’s Gauge indicator is used to display the state of a process, which is
associated to a data point, in a circular manner. Different colors can be used to emphasize
certain values reached by the point.
To add and configure a Gauge indicator into an Diagram page:

1. In SMP Manager, click on the SMP Diagram Editor icon.


2. In SMP Diagram Editor, click on the Gauge icon from the Toolbar.
3. The Gauge properties window opens and a Gauge Place holder is added to SMP Diagram
Editor’s design area. This place holder can be re-sized to fit properly on the Diagram page as
soon as the Gauge properties are filled and saved.
Result:

4. First, select the Data point name that will be represented by the gauge indicator. The pointer
and texts are black by default; the color can be modified by clicking on the square next to
Text, pointer, values and labels color. It is possible to configure the gauge to use a single
zone or multiple zones. When configuring the zone values; you must have a good idea of the
values that the data point can reach in order to have a realistic Gauge indicator.
a. The single zone gauge has a background color and a foreground color; the latter is used
to graphically indicate the actual point value. If you want to use this option:
• Select Use single zone

Eaton User Manual | page 163


13 - Operations with the SMP Gateway HMI

• In the Options pane, select the Foreground and Background colors by clicking on the
colored square.
• Enter the minimum (Min Value) and maximum (Max Value) values and Unit value.
b. The multiple zones gauge does not have a background color. The user configures up to 5
zones, with their specific color and limit values; these zones are permanently displayed on
the Gauge indicator. The pointer is used to indicate the data point value with reference to
the Gauge graph settings. If you want to use this option:
• Select Use multiple zones
• In the Options pane, you can define up to five (5) zones; put a check mark on the far
left check box of each selected zone.
• Enter the minimum (Min) and maximum (Max) values for each selected zone. The
maximum value of a zone always corresponds to the minimum value of the following
zone; this is done by default in the system. This type of indicator is a continuous
graph, no jump is allowed.
• Select the zones colors by clicking on the colored square on the far right of each zone
row.
• The zones limit values will be displayed on the graph at the zones transition if the
Show value labels box is checked (default).
5. In the Fraction digits field, enter the number digits displayed after the point for fractional
numbers, default is zero.
6. Select the text, pointers and labels color by clicking on the associated square.
7. Click OK to close the Gauge properties window.
8. On the SMP Diagram Editor’s design area, re-sized or move the Gauge Place holder shape
to fit properly on the Diagram page. You can modify the properties by right-clicking on the
selected Gauge Place holder and selecting Properties.
9. Add a title or descriptive text to identify the gauge indicator on the Diagram page.
10. Choose the number of fraction.
11. Save the file: File > Save as. This will generate a file with the shm extension.
12. Save the diagram to be used by the SMP Gateway HMI:
a. File à Export for SMP Gateway. This will generate a file with the hmi extension
b. From SMP Manager, send the .him file to the SMP Gateway: Update à Send File(s)
13. Open the SMP Gateway HMI using the Web browser icon in SMP Manager and verify that
the Gauge indicator is working properly.

13.6.8.3. Adding a Trend indicator into a diagram page


To add and configure a Trend indicator into a Diagram page:

1. In SMP Manager, click on the SMP Diagram Editor icon.


2. In SMP Diagram Editor, click on the Trend icon from the Toolbar.
3. The Trend properties window opens and a Trend Place holder is added to SMP Diagram
Editor’s design area. This place holder can be re-sized to fit properly on the Diagram page as
soon as the Trend properties are filled and saved.
Result:

User Manual | page 164 Eaton


13 - Operations with the SMP Gateway HMI

4. In the Trends to display pane, you must configure at least one Trend curve in the Trend 1 to
Trend 5 fields, no specific order is required:
a. Select the Data point name and assign a Label to it. You can modify the default color by
clicking on the colored square associated to the Trend curve row; make sure you don’t
assign the same color to more than one curve. You can choose to display the Y-axis on
the left or right side of the graph.
b. Repeat the operation, if necessary, for up to 5 trend curves.
5. In the Graph property pane:
a. The Display graph title option is selected by default. Enter a title in the Graph title box
if you want a title displayed for your graph; otherwise, remove the check mark from the
Display graph title box.
b. The Display trend legend option is selected by default. Remove the check mark is you
do not want a legend to be displayed.
c. The Display grid option is selected by default. Remove the check mark is you do not
want the grid to be displayed inside the graph zone.
d. Enter the X-axis label in the box.
e. Enter the Y-axis label for the Left axis box and/or the Right axis box depending on the
Trend curves configuration.
f. Select the Trend graph Foreground color, if necessary, by clicking on the grey (default
color) square.
g. Select the Trend graph Background color, if necessary, by clicking on the white (default
color) square.
h. Select if you want single trend duration (default) or a User selectable duration.
• If you choose to use a single duration, adjust the display duration according to your
specific needs.

Eaton User Manual | page 165


13 - Operations with the SMP Gateway HMI

• If you choose the User selectable duration, you can select up to 6 different duration
settings that can be modified directly on the diagram page. One of these duration
settings must be selected as the Initial setting; it will be the one selected by default
on the page.
6. Click OK to close the Trend properties window.
7. On the SMP Diagram Editor’s design area, resized or move the Trend Place holder shape
to fit properly on the Diagram page. You can modify the properties by right-clicking on the
selected Trend Place holder and selecting Properties.
8. Add a title or descriptive text to identify the gauge indicator on the Diagram page.
9. Save the file: File > Save as. This will generate a file with the shm extension.
10. Save the diagram to be used by the SMP Gateway HMI:
a. File > Export for SMP Gateway. This will generate a file with the hmi extension
b. From SMP Manager, send the .hmi file to the SMP Gateway: Update >Send Files(s)
11. Open the SMP Gateway HMI using the Web browser icon in SMP Manager and verify that
the Trend indicator is working properly.

13.6.9. Multi-control capability of SMP Diagram


It is possible to configure several control interactions on a single shape in SMP Diagram Editor.
When operating an SMP Gateway HMI diagram using a shape associated to several control
interactions:
• When a user clicks on the shape, all configured interactions are displayed on control pane
located on right side of the display.
• If several interactions without validation are configured, all the associated controls are sent at
once.
• The alarm interaction is operational.
• As soon as a multi-phase interaction is started (i.e. SBO), the other control interactions are
disabled.
• With a mix of control interactions with and without validation, when clicking on the shape, the
controls associated with the interactions without validation are sent all at once; the control
pane which is usually located on the right side is not displayed.

13.6.10. The Control Interaction Configuration window


The Control Interaction Configuration window in SMP Diagram is different from the one used by
Visual T&D Diagram Editor, see the following capture:

User Manual | page 166 Eaton


13 - Operations with the SMP Gateway HMI

The Control Interaction Configuration window for SMP Diagram is quite intuitive and, depending
on the options selected, options are grayed out, simplifying the configuration process.
The differences with the Control Interaction Configuration window in Visual T&D Diagram Editor
are:
• Addition of an option No validation on send: this option allows to set a predefined value
which will be sent without validation; the value is defined in the Automatic Behavior pane
at the bottom of the window. This feature is mainly used for controlling push buttons that will
change an operating mode or a setting.
• Addition of an option Separate Open and Close data points: this option allows the definition
of the Open and Close action separately.
• Addition of an option Select/Execute separated: this option allows to perform selection on
one point and to execute on another point.
• The preview pane is not available.
• It is possible to select only AOs and BOs.

13.6.11. Linking diagram pages using SMP Diagram's shape


interaction
When SMP Diagram Editor is used to create Devices Front Panel and Diagram pages, it is
possible to link a page to another one by using the Open Page interaction.
To configure the Open Page interaction:

1. In SMP Diagram Editor, select the shape that you want to use to open another page.

Note: This procedure slightly differs if you are using SMP Diagram Editor launched
directly from SMP Config from a Template. You will be advised of the differences during
the procedure.

2. Right-click on the shape and select Interaction.


3. In the Shape Properties windows, select the Interaction tab and, in the Grouping section,
click on the Add drop-down list.
4. Select Open Page
Result:

Eaton User Manual | page 167


13 - Operations with the SMP Gateway HMI

5. Select the page you want to access with this shape. If you are working from a template, the
page you select is the page alias; you will be able to associate the alias to the open page
using the Open Page resolution pane in SMP Config after you saved your diagram.

Note: There is always a minimum of 10 pages available for configuration for both
categories, the Devices Front Panel and Diagram pages.

6. Save your diagram.


7. If you edited a Diagram or Device's Front Panel template, in SMP Config, in the left pane,
navigate to the Open Pages of the template (Template > name of template > Instances >
Open Pages). In the Open Page Resolution pane, associate the Page Alias to the Open
Page.
8. If you launched SMP Diagram Editor directly from SMP Config, Save the configuration file
(.par) and send it to the SMP Gateway to see your diagram(s) on the SMP Gateway HMI.
If you launched SMP Diagram Editor from SMP Manager, send the .hmi file to the SMP
Gateway using the procedure in section Uploading an SMP Gateway HMI package file on the
SMP Gateway (page 169).

13.6.12. Exporting a diagram to the SMP Gateway HMI file


format

To export a diagram to the SMP Gateway HMI package file format:

1. From the SMP Diagram Editor or Visual T&D Diagram Editor File menu, choose Export for
SMP Gateway.
2. In the File name box, type a new name for the SMP Gateway package file that will contain
the diagram, or keep the name proposed by default (which corresponds to the site name).
3. In the Target version box, select the firmware version of the target SMP Gateway.

Note: If the actual version of the SMP Gateway firmware is not listed, select the
closest earlier version.

4. Click Save.
5. If the resulting file contains diagram elements that may not be displayed properly, you can
click Yes to display the warning report. Otherwise, click No.

The diagram package file is now ready to be transmitted to the SMP Gateway.

User Manual | page 168 Eaton


13 - Operations with the SMP Gateway HMI

13.6.13. Uploading an SMP Gateway HMI package file on the


SMP Gateway
SMP Gateway HMI Package (.hmi) files can be uploaded on the SMP Gateway using
SMP Manager or the via the SMP Gateway HMI Web interface.

Before proceeding with the upload, make sure that the SMP Gateway license is up-to-date and
that it includes the SMP Gateway HMI option; otherwise, the SMP Gateway will refuse the file.
You must also have Configuration privileges.
Follow step 1 to upload an SMP Gateway HMI Package File on the SMP Gateway, using SMP
Manager and follow step 2 To upload an SMP Gateway HMI Package File on the SMP Gateway,
using the remote SMP Gateway HMI.

1. To upload an SMP Gateway HMI Package File on the SMP Gateway, using SMP Manager:
a. In SMP Manager, select the SMP Gateway.
b. From the Update menu, choose Send File(s).
c. In the Send File window, browse and select the .hmi file containing the diagrams to load
on the SMP Gateway, and then click Open.
d. Wait for the file to be transferred on the SMP Gateway.
e. Restart the SMP Gateway. If the SMP Gateway is not part of a redundancy group, a soft
restart will be performed and communication with SCADA and devices will not be affected.
Otherwise, a Full restart will take place and the aforementioned communications will be
affected.
2. To upload an SMP Gateway HMI Package File on the SMP Gateway, using the SMP
Gateway HMI Web interface:
a. Connect remotely to the SMP Gateway HMI.
b. From the menu, choose The Application Settings page.
Result:

c. In the Diagrams management section, under the Update Diagrams subsection, drop the
file in the Drop SMP Gateway HMI file here box or browse for the .hmi file containing the
diagrams.
d. Once the chosen file is displayed next to the Selected file line, click the Send and
update button to update the Single-Line Diagrams on the SMP Gateway.

Eaton User Manual | page 169


13 - Operations with the SMP Gateway HMI

e. The SMP Gateway will be restarted; if the SMP Gateway is not part of a redundancy
group, a soft restart will be performed and the communication with SCADA and
devices will not be affected. The web server will be unreachable for a few seconds
and then reconnected. Otherwise, a Full restart will take place and the aforementioned
communications will be affected.
f. Once updated, the newly updated HMI files, a .hmi and a .shm files, should be displayed
under the Get current HMI files subsection and the Diagrams are available for
visualization in the Diagrams section of the SMP Gateway HMI.

Note: The .shm file is specific to the Visual T&D Diagram Editor.

13.6.14. Retrieving HMI Diagram files from an SMP Gateway


SMP Gateway HMI files (.hmi and .shm) containing the SMP Gateway’s diagrams can be
retrieved from the SMP Gateway via the remote SMP Gateway HMI interface.

The user can retrieve the file contained in the SMP Gateway via:
• SMP Manager > Update > Get Configuration File
• SMP Gateway HMI > Application Settings > Diagram Management > Get current HMI files
• The SMP Gateway REST API, using the File transfer service.

To retrieve an SMP Gateway HMI file from the SMP Gateway, using the remote SMP
Gateway HMI:

1. Connect remotely to the SMP Gateway HMI.


2. From the menu, choose The Application Settings page.
3. In the Diagrams management section, under the Get current HMI files subsection, select
the file type you want to download by clicking on the hyperlink of the file that is on the SMP
Gateway.
4. Follow the instructions provided on the screen in order to save the file at the desired location.

User Manual | page 170 Eaton


13 - Operations with the SMP Gateway HMI

13.7. Using the SMP Gateway HMI operational


applications

13.7.1. Managing alarms


If you intend to use the SMP Gateway Alarms application, you must first enable it in the gateway
configuration, using SMP Config. Refer to section Enabling the HMI applications (page 120) for
details. If you previously defined alarm conditions, you will have to manage the alarms that will
be triggered when these conditions will be met.
When an alarm condition is met for a given input, an alarm is triggered and sent to the SMP
Gateway HMI, which:
• Turns on the sound warning system, to alert the operator that something requires its attention
(when enabled);
• Adds the alarm to the Active Alarms page, as an alarm message that uses the text and
background colors configured for the severity level of the condition (major or minor). The
alarm message will be preceded by the alarm appearance indicator displayed on a red
background. The ‘A’ letter is used as the indicator if no specific category was defined and
assigned to the corresponding alarm.

You must turn off the sound warning system before you can acknowledge the alarm. The
sound warning system also acts as an interlock, ensuring that you are aware of all the alarms
that occurred. To really hear a sound, you need to install a buzzer on the SMP Gateway as
described in Enabling or disabling sound on a new alarm (page 175).
To turn off the sound warning system:
• From the Active Alarms page, press the leftmost button, which is named Ack New Alarms
by default. You can change the name of this button using SMP Config (see Setting up the
Active Alarms page (page 148) ).

To handle an alarm condition:


Press Ack/Clear All to acknowledge all new alarms. It also clears the Active Alarms
display of all alarm data points that have returned to their normal condition. OR Press the
Acknowledge button to acknowledge the alarm. The entire row turns to white, except for the
alarm appearance indicator which remains the same color. If more than one alarm is active,
the alarm that will be acknowledged depends on the alarm acknowledgment rule selected in
SMP Config for the Alarms page (see Setting up the Active Alarms page (page 148)). If you
selected Alarms can be acknowledged and recalled in any order, you must select the alarm
to acknowledge before pressing the button.
OR

Eaton User Manual | page 171


13 - Operations with the SMP Gateway HMI

Press the Block button to move the alarm data point in alarm to the Blocked page. Make sure
the data point you want to block is selected before pressing the button. For more details about
the block feature, see Blocking and reactivating blocked alarms (page 173).
The data points that are in an alarm condition remain in the alarm display until the points return
to their normal condition, at which time you can clear them from the display.
When a point returns to its normal condition, the sound warning system turns on again and
the alarm appearance indicator is replaced by the return-to-normal indicator displayed on a
green background. The ‘R’ letter is used as the indicator if no specific category was defined and
assigned to the corresponding alarm.

You must once again clear the sound before you can acknowledge and recall the data point,
which will then no longer be displayed in the Active Alarms page.
To handle the return-to-normal condition:
• To clear the sound warning system, click on “The leftmost button” of the Active Alarms page
(Could be named Clear Sound). This button is used to acknowledge the appearance of new
alarms and its name is configurable, refer to the section Setting up the Active Alarms page
(page 148).
• Handle the return-to-normal event. This can be performed in two different ways:
◦ Click Ack/Clear All to acknowledge all alarms and clear the alarm display of all data
points that have returned to their normal condition.
◦ Press Acknowledge to acknowledge the alarm. Again, if more than one alarm
can be acknowledged, the alarm that will be acknowledged depends on the alarm
acknowledgment rule selected in SMP Config for the Alarms page. If you selected
Alarms can be acknowledged and recalled in any order, you must select the alarm
to acknowledge before pressing the button. Then, press Clear in order to clear the alarm
display of the alarm data point that has returned to normal. The alarm acknowledgment
rule defined in SMP Config also applies to clear (recall) operations.

If an alarm is triggered more than once before it can be handled, the indicator is replaced by the
corresponding one defined for multiple occurrences, which is ‘Ax’ or ‘Rx’ if no specific category
was defined and assigned to the corresponding alarm.

Note: A filter located in the toolbar is available to ease the search for specific
information; filtering is applied to static information displayed on the page.

User Manual | page 172 Eaton


13 - Operations with the SMP Gateway HMI

13.7.2. Blocking and reactivating blocked alarms


For some reasons, you might want to temporarily deactivate some alarm conditions. Such
behavior may be required, when a certain part of the substation is under maintenance, for
example. For this matter, the SMP Gateway HMI offers an alarm blocking feature.

If you intend to use the SMP Gateway Blocked Alarms application, you must first enable
it in the gateway configuration, using SMP Config. Refer to the section Enabling the HMI
applications (page 120).
When an alarm is blocked, it no longer triggers alarms, even when the triggering conditions are
met.
You can only block an alarm that is currently displayed in the Active Alarms page. When it is
blocked, the alarm is moved to the Blocked Alarms page, and it will not appear in the Active
Alarms page until it is reactivated. In fact, alarms will no longer be triggered for this input.

1. To block an alarm:
a. From the Active Alarms page, select the alarm data point that you want to block.
b. Press the Block button located on the Active Alarms page’s toolbar.
c. From the Active Alarms page, select the alarm data point that you want to block.
Result:

2. To reactivate a blocked alarm:


a. From the Blocked Alarms page, select the alarm data point that you want to reactivate.
b. Press the Reactivate button located on the Blocked Alarms page’s toolbar.
c. The alarm is moved back to the Active Alarms page. The sound warning system turns
on and you will then have to take action, to acknowledge and recall the input current
condition (see Managing alarms (page 171)).
3. To reactivate all blocked alarms simultaneously:
a. From the Blocked Alarms page, press the Reactivate All button located on the Blocked
Alarms page’s toolbar.

13.7.3. The Alarms History page


When an alarm appears in the Active Alarms page, it is also listed in the Alarms History Page.
The Alarms History page also lists all operations that were executed to handle the alarms,
active or blocked. A Clear History button is available at the top of the page to delete all entries
displayed on the page, at once.
To delete the content of the Alarms History page:
• Select the Alarms History page.
• Press the Clear History button located on the Alarms History page’s toolbar.

Eaton User Manual | page 173


13 - Operations with the SMP Gateway HMI

Note: A filter located in the toolbar is available to ease the search for specific
information; filtering is applied to static information displayed on the page (filter is not shown
on the screenshot).

The Alarms History Page also has a function that allows highlighting, in bold characters, all
alarms related to a selected alarm or operator event on the page.
The list is circular and can hold a limited number of alarms or operations on these alarms, which
is called the history length; when it is full, new entries replace the oldest ones.
The Alarms History Page has six columns, which position and width are configurable on the
HMI page:
• The Icon column is not configurable in SMP Config. This column displays the alarm category
related to the alarm. In case of an operation on an alarm, the column is left blank.
• The Point Name column displays the alarm point name.
• The Date and Time column: By clicking on the arrow located on the column header, the user
can change the chronological order of the data entries.
• The Type column (same as the Code column in the Alarm Log file): Every time an alarm
appears or returns to normal, an entry is added to the Alarm History Page. In that case, the
Type column indicates Alarm. Whether the operator clears sound, acknowledges or recalls
alarms, blocks or unblocks alarms, or performs control operations; an entry is also added to
the Alarm History Page. In that case, the Type column indicates Operator.
• The User column is directly related to the operator operation on an alarm; it indicates the
user that performed the operation. This column is left blank for an alarm entry type.
• The Description column: The action executed by the operator is described in the
Description column or in the case of an alarm, the message displayed in the Description
column is the same that appears in the Alarms page.

13.7.4. The Single alarm display


The single alarm display is found at the bottom of many SMP Gateway HMI applications pages.
For obvious reasons, it is not displayed on the Active Alarms page but will appear on the
bottom of the Communication and System Dashboards, Blocked Alarms, Diagram and Real
Time Data Points pages.

It is used to manage alarms one at a time. Depending on how it is customized, the oldest or
most recent alarm is displayed here, and the operator can acknowledge or clear the alarm
without having the Active Alarms page displayed on the screen.
To customize the single alarm display, see Setting up the Active Alarms page (page 148).
Using the single alarm display is easy:

User Manual | page 174 Eaton


13 - Operations with the SMP Gateway HMI

• If the sound warning system is on, press the Clear Sound button on the rightmost side of the
single alarm display, which will give the same result than pressing the configurable leftmost
button of the Active Alarms page (the button could be named Clear Sound).
• The sound warning system is turned off and the alarm is ready to be acknowledged.
• If the sound warning system has already been turned off, press the Acknowledge button on
the rightmost side single alarm display to acknowledge the alarm just like you would do using
the Acknowledge button of the Active Alarms page.

13.7.5. Enabling or disabling sound on a new alarm


The SMP Gateway has a normally open relay that can be used to trigger an output.

If you have installed a buzzer on this relay output and you have the Activate Relay on Alarm
setting enabled in SMP Config, the buzzer will be triggered upon alarm (Refer toSetting up
an alarm buzzer (page 84). The sound of the buzzer can be enabled or disabled on the SMP
Gateway HMI.
To disable the alarm buzzer feature (the sound is enabled by default):

1. In the SMP Gateway HMI (remote access or local display), from the Parameters section,
select the Application Settings page.
2. Under Alarms, uncheck the Enable sound on new alarm setting.

13.7.6. Using the Diagrams or Device's Front Panels application


If you intend to use the Diagram or the Device's Front Panel application in the SMP Gateway
HMI, you must first enable the Diagrams option in the gateway configuration, using
SMP Config. Refer to the section Enabling the HMI applications (page 120). The Diagrams and
Device's Front Panels can be enabled separately, however, the access control option, View Only
or View and Control, is common to both diagram types.

13.7.7. Performing control operations from a Diagram or


Device's Front Panel page
When creating your Diagram or Device's Front Panel, you can create shapes like touch buttons
that allow operators to perform control operations on points.
When you select such a shape, like a button, a modal window appears over the diagram page
on the right side of the display. The upper part of the window is used for control operation on the
alarm point related to the selected shape.
In the following screenshot from a single-line diagram, the selected shape is the “345 Breaker
B3 Critical” rectangle on the upper left corner of the page, we can see that the shape is selected
because of the white rectangle around the shape. The color of the shape is consistent with the
state of its alarm point shown on the modal window on the right side.
On the screenshot, the modal window shows the control operation that the operator can do
using this specific shape (the selected shape is identifiable by a white rectangle surrounding
it). The selected point name is identified with its description and alarm management is also
possible for the alarm point related to this specific shape.

Eaton User Manual | page 175


13 - Operations with the SMP Gateway HMI

This modal window is also customizable; in the snapshot above, the State 0 button is named
Open and the State 1 button is named Close.

13.7.7.1. To perform a control operation


To perform a control operation:

1. On the diagram page, select the shape corresponding to the alarm point you want to control.
2. On the modal window, on the right side of the page, under CONTROL, press either the State
0 or State 1 button :
a. To force the corresponding output to state 0 (FALSE), press the State 0 button.
b. To force the corresponding output to state 1 (TRUE), press the State 1 button.
3. Click on the diagram main page to close the modal window.
4. If you force an output state, two entries will be added to the Alarm log file: one to indicate
that a control operation has been performed on the given binary output, and another to
indicate the result of this control operation. The same entries, with more precise information,
are also stored in the Control log file. Both log files can be accessed using the SMP Log tool
or Logs from the HMI menu. For more information about the SMP Log tool, see Viewing log
files (page 86)

For control operations on analog outputs that support limits on their control operation values
(e.g., master DNP3 and master Modbus components) or for control operations on Automation
Functions’ Logical analog outputs, the minimum and maximum ranges that are set in the
component at configuration time are indicated below the Analog Set value box.
When the user enters a value that is outside of the permitted range, the control operation
is refused and an out of range message is displayed. The following capture shows such a
situation, a value of 325 A was entered while the permitted range was set between 0 and 300 A;
the operation was refused. The user must then either:
• Clear the field and click on the diagram page to abort the control operation process.
• Enter an allowed value in order to complete the operation with the Execute command.

User Manual | page 176 Eaton


13 - Operations with the SMP Gateway HMI

Note: The limits on a control operation value are applied only for control operations from
diagram pages. Control operation values from Visual T&D, slave components or from the
SMP Gateway Commissioning Tool are not validated using the configured limits.

13.7.8. Managing alarms from the Diagram or Device's Front


Panel page
From a Diagram or Device's Front Panel diagram page, when you select a shape allowing
the operator to perform control operation on the data point, a modal window appears over the
Diagram page on the right side of the display. The middle part of the window is used for alarm
management operations on data points that are configured as alarms and also related to the
animation of the selected shape.
So, alarm command interactions allow operators to perform alarm management operations on
data points by clicking on a diagram shape that is mapped to these points. Three buttons are
available and have the same function than the first three buttons on the Active Alarms page:
• Clear Sound
• Ack
• Clear

When a button is available to the operator, it is highlighted, otherwise the buttons are not
available and clicking on them will have no effect.
To perform alarm management on a selected shape:

1. On the modal window, on the right side of the page.


2. Under ALARMS, press the Clear Sound button.

Note: The name of this button is configurable under the Active Alarms page

3. When the Ack button becomes available, click on it to acknowledge the alarm.
4. The Clear button is then available to clear the alarm that has returned to its normal condition.
5. Click on the Diagram's main page to close the modal window.

Eaton User Manual | page 177


13 - Operations with the SMP Gateway HMI

If the Single-Line Display was enabled in SMP Config, when an alarm is available for alarm
management on the modal window, it is also displayed at the bottom of the diagram page, on
the Single-Line Display. The alarm acknowledgment is effective on the Single Alarm Display and
also on the Active Alarms page.

13.7.9. Troubleshooting animation errors on a diagram page


Once the diagram pages are available on the SMP Gateway HMI, animation errors, if any, are
highlighted using a question mark in a red circle icon.
Clicking on the question mark icon, opens a window, at the bottom of the page, which displays
the selected shape animation information.

Note: The Shape animation information window is available only for the remote SMP
Gateway HMI. The local SMP Gateway HMI displays the animation error icons but clicking
on them will have no effect.

Such a tool is available to help users quickly troubleshoot any animation errors present on
newly designed diagram pages. Once selected, the selected animation error icon is enclosed by
a white square to facilitate the shape identification when many animation errors are displayed
on a single page.
The Shape animation information window specifies any animation error type which may be
caused by:
• an non-existent data point
• an invalid function
• an unsupported function
• a division by zero

The following screenshot shows one selected animation error; the window at the bottom of
the page displays information about the shape animation error. In this particular example, the
specified data point was not found in the SMP Gateway configured data points.

User Manual | page 178 Eaton


13 - Operations with the SMP Gateway HMI

13.7.10. Enable or disable zoom control


Zoom control is available on the SMP Gateway HMI for remote access and also locally (on the
SMP SG-42xx platform only). It is used to adjust some HMI pages to fit the user’s visualization
needs when the user uses a mouse without a scroll wheel.
When enabled, the zoom control is available for the following pages:
• Communication Dashboard
• System Dashboard
• Diagram pages
• Device's Front Panel pages

The Zoom control can be enabled or disabled on the SMP Gateway HMI .
To disable the zoom control feature (the zoom control is enabled by default):
• Go to the SMP Gateway HMI, from the Parameters section, select the Application Settings
page.
• Under Zoom, deselect the Show zoom controls in diagram pages setting.

Eaton User Manual | page 179


14. SMP Gateway add-in for Microsoft
Excel®
The SMP Gateway add-in for Microsoft Excel (SMP Excel add-in) allows retrieving information
from an SMP Gateway and placing it in an organized Excel list file.
This operation enables the user to handle data for specific use like commissioning, comparing
data points information, planning, designing new substations, etc.
Three preconfigured SMP Excel add-in lists are available, they are:
• Instance List: List all instance components from the SMP Gateway configuration file with
the number of data points they produce, the number of simulated points and the simulation
behavior.
• Data Points List: List all data points, grouped together by instances from which they are
produced. Each data point is listed with a set of characteristics.
• Working Plan List: List all data points, grouped by instances from which they are produced
or consumed. This means that a single data point could be listed more than one time; once
for the instance that produces the point (producer) and once for each instance that uses the
point (consumer). Each data point is listed with a set of static and dynamic characteristics as
well as user defined status and automatically generated timestamping information that can
be useful for commissioning.

The information retrieved from the SMP Gateway is used to create a list to serve a user defined
purpose. A refresh action is possible to update the list with characteristics that were modified in
the configuration file subsequent to the list file creation. It is however not possible to send the
information from the Excel list files, modified or not, to the SMP Gateway. For example, the user
cannot modify an instance behavior, value, quality, description, scale or offset of a data point on
the SMP Gateway from the Excel add-in list file.
The connection to the SMP Gateway is used to retrieve the information and is not permanent.
When creating a list, SMP Excel add-in connects with the SMP Gateway using the user
provided IP address and credentials. Once the information is retrieved and transferred to
the list, the connection with the SMP Gateway is ended. The created list, however keeps the
IP address and Login information from the SMP Gateway that was used to create the list; a
Refresh action initiated by the user simply requires the password to be entered in the dedicated
field.
The newly created list can be saved and subsequently reopened for the user to continue
working with the same list. In such a case, the SMP Gateway IP address and login from which
the list retrieved the information are saved with the file; the user must simply provide the
password upon a refresh action to retrieve updated information, if necessary.
The user can create as many lists as needed from a single SMP Gateway or different lists from
several SMP Gateways and these lists are not bounded. When SMP Excel add-in retrieves
information from an SMP Gateway, to create or update a list, the information transferred to
the list is the one existing at the time of the retrieval, no further links exists between the SMP
Gateway and the created list; timestamping information is provided on the list upon creation
and refresh actions to help users identify the validity of the list content. The user must therefore
identify the created lists in an organized manner in order to avoid confusion when several lists
are used.

User Manual | page 180 Eaton


14 - SMP Gateway add-in for Microsoft Excel®

14.1. Installing the SMP Excel add-in


The SMP Excel add-in is specially designed to be under the control or Microsoft Excel 2010 or
2013. Therefore, make sure the software is installed before you begin with the installation of
SMP Excel add-in.
The SMP Excel add-in is installed with the SMP Tools installation package, as an option. The
user needs to install or upgrade SMP Tools using the Complete installation setup; a Version
Pack installation will have no impact on the SMP Excel Add-In installation or upgrade.
The installer presents a window with the option to install the SMP Gateway add-in for Microsoft
Excel, the option must be selected in order for the installer to install or update the SMP Excel
Add-In.

Note: The installer will detect if an already installed version must be upgraded and will
install the latest version. If the already installed version is up to date, a message will inform
the user that the SMP Excel Add-In will not be re-installed.

Once the installation completed, the user will not see that the Excel add-in is installed when
looking at SMP Manager. The Microsoft Excel program must be opened to see that the SMP
Excel add-in is installed; the add-ins tab will then include an SMP section in its ribbon.

14.2. Accessing the SMP Excel add-in


To retrieve information from an SMP Gateway in order to create a list, the IP address and
credentials must be provided. A refresh action on an existing list requires only the SMP
Gateway password.

To access the SMP Excel add-in and create a list:


TM
1. Open the Microsoft Excel program
2. Select the Add-Ins tab from the menu on the top. An SMP section should be available on the
ribbon; it includes a few features, they are:
• The New List selection tool: used to create a new list from an SMP Gateway. The user
will need to identify the SMP Gateway, from which the list information will be extracted, by
providing its IP address and credentials. The following lists can be created; you must click
on the New List selection tool to access them:
◦ Instances
◦ Data Points
◦ Working Plan
• A Refresh button: Used to update the data on the selected list.
3. Click on the New List selection tool.
4. The Connect window opens; you must:
a. Enter the IP address of the SMP Gateway in the Server field.
b. Enter the credentials associated to security database of the SMP Gateway, even if the
security database is not on the SMP Gateway.

Eaton User Manual | page 181


14 - SMP Gateway add-in for Microsoft Excel®

c. Select which list you want to create in the List pane.


d. Click OK.
5. The selected list is created.
Result:
All created lists include a common header containing the following sections:
• Identification section:
◦ List name: The SMP Excel add-in list type name.
◦ IP address: The SMP Gateway IP address, this information is used by the SMP
Excel add-in to connect to the device and retrieve information.

Note: If the IP address is modified by the user, it will not be possible to access
the SMP Gateway for a refresh action.

• General Report Information section:


◦ Refresh information: timestamping information from the creation or last refresh
action
◦ Settings: SMP Gateway information, as provided by the configuration file
◦ Versions: versions used on the SMP Gateway
◦ Hardware: hardware information for the SMP Gateway
• Global Progression Status section (for the Working Plan list only):
◦ Status: Number of data points corresponding to the commissioning statuses
◦ Pie Chart: indicates the commissioning completion status. The chart is filled
according to the data points’ statuses
By default, the list header is shown; it can be hidden totally or partially by using the hiding
row function from Excel. Columns can also be hidden using the hidden function but be
aware that the header will be affected.

14.2.1. Unsuccessful connection to the SMP Gateway


If the connection to the SMP Gateway is successful, the list is created or refreshed in Microsoft
Excel. If however, the connection to the SMP Gateway is unsuccessful, the user will be asked
for a retry or cancel action.
In case of an unsuccessful connection to the SMP Gateway, at the list creation or for a refresh
action, verify the following:
• The SMP Gateway status using SMP Manager; the status should be Started; other statuses
will not allow a successful connection.
• The network accessibility to the device.
• A standby SMP Gateway, which is part of a redundant pair, is not accessible. The user
should access the active SMP Gateway.
• SMP Software and Tools version 7.1R3 or later is required.

User Manual | page 182 Eaton


14 - SMP Gateway add-in for Microsoft Excel®

14.2.2. Opening an existing list

To use an existing List:

1. Open the file containing the existing List that you want to use.
2. Select the appropriate worksheet (The list type is written next to the SMP Gateway IP
address on the header’s first line).
3. From the ribbon, click on the Refresh button to get the latest data from the SMP Gateway, if
necessary. You will be asked for the SMP Gateway password.
4. Changes in the configuration file will be reflected in the list content.
5. Save the updated file.

14.3. The Instances list


The instances list is used to list all component instances from a specified configuration file
together with specific instance characteristics.
The Instance list provides the following information:
• Instance: The instance’s short name.
• Name: The instance’s name and path from the configuration file (SMP Config).
• Produced Points: The quantity of data points produced by the instance.
• Simulated Points: The quantity of data points that were simulated at the list creation or when
the last refresh occurred.
• Simulation Behavior: The selected simulation behavior that was set at the list creation or
when the last refresh occurred.

The following capture shows an example of an Instances List:

Eaton User Manual | page 183


14 - SMP Gateway add-in for Microsoft Excel®

14.3.1. Using the Instances list


An SMP Gateway from which the configuration file was modified introduces modifications to an
existing Instances list upon refresh.
When the user clicks on the Refresh button, the Instances list is updated according to the
actual configuration file content, replacing the previous list content.

14.4. The Data Points list


The Data Points list is used to list all instances’ data points from a specific SMP Gateway’s
configuration file.
The data points are listed together with the following information:
• Instance: The instance’s short name that produce the data point
• Type: The data point type (AI, AO, BI or BO)
• Name: The data point’s full name as seen in the SMP Gateway HMI
• Floating-point value: The data point’s floating point value (0,000 or 1,000 for a BI or BO data
point types)
• Integer Value: The data point’s integer value (0 or 1 for a BI or BO data point types)
• State: the data point’s state, used for a BI or BO data point only
• Quality: The data point’s quality
• Date / Time: Date and time of the data point’s last transition
• Description: Data point’s description as entered in the configuration file
• Address: Internal address assigned to the data point while configuring the instance
component
• Scale: Conversion multiplication factor for analog data points as entered in the configuration
file
• Offset: Conversion constant for analog data points as entered in the configuration file

The following capture shows an example of a Data Points List:

User Manual | page 184 Eaton


14 - SMP Gateway add-in for Microsoft Excel®

14.4.1. Using the Data Points list


An SMP Gateway from which the configuration file was modified introduces modifications to an
existing Data Points list upon refresh.
When the user clicks on the Refresh button, the Data Points list is updated according to the
actual configuration file content, replacing the previous list content.

14.5. The Working Plan list


The Working Plan list is used mainly to plan commissioning work. All data points, for each
instance, are listed. For each data point, specific instance characteristics, static and dynamic,
are provided from the SMP Gateway to which it is connected.
Some values are entered by the user or are updated by SMP Excel Add-In and provide content
related to the commissioning status and thus feed the Global progression status graph located
in the header. This last feature gives the user a quick update on the commissioning progress.
The Working Plan static characteristics provided by the SMP Gateway are related to the
following columns:
• Instance: The instance’s short name that produce or consume the data point
• Type: The data point type (AI, AO, BI or BO)
• Name: The data point’s full name as seen in the SMP Gateway HMI
• Description: Data point’s description as entered in the configuration file
• Address: Internal address assigned to the data point while configuring the instance
component
• Scale: Conversion multiplication factor for analog data points as entered in the configuration
file
• Offset: Conversion constant for analog data points as entered in the configuration file

Eaton User Manual | page 185


14 - SMP Gateway add-in for Microsoft Excel®

The Working Plan dynamic characteristics provided by the SMP Gateway are related to
the following columns:
• Floating-point value: The data point’s floating point value (0,000 or 1,000 for a BI or BO data
point types)
• Integer Value: The data point’s integer value (0 or 1 for a BI or BO data point types)
• Quality: The data point’s quality
• Date / Time: Date and time of the data point’s last transition

The Working Plan values entered by the user or updated by Excel are related to the
following columns:
• Status: Commissioning status selected by the user or modified automatically after a refresh
action. The Global progression status graph located in the header is updated as soon as a
data point status is modified. The value is set according to the data point’s commissioning
status and is selected from the following list:
◦ Not tested (default value)
◦ Passed
◦ Passed – To be reviewed: this status can be selected by the user or set by Excel upon a
refresh action where a modification to a data point’s static characteristic was detected and
a Passed status was previously set.
◦ Failed
◦ Failed – To be reviewed: this status can be selected by the user or set by SMP Excel add-
in upon a refresh action where a modification to a data point’s static characteristic was
detected and a “Failed” status was previously set.
• Notes: Commissioning notes entered by the user. The notes are modified or deleted by the
user only.
• Status Updated on: Field filled automatically by SMP Excel Add-In with the actual date and
time when the data point status is modified to a value other than Not tested.
• Status Updated by: Field filled automatically by SMP Excel Add-In with the user’s name when
the data point status is modified to a value other than Not tested.

The Status column is not affected by a Refresh action, unless the data point was added,
modified or removed from the SMP Gateway configuration file since the last refresh action.
Following is an example of a Working Plan progression status (located in the header)

The following capture shows an example of a Working Plan (partial view):

User Manual | page 186 Eaton


14 - SMP Gateway add-in for Microsoft Excel®

14.5.1. Using the Working Plan list


An SMP Gateway from which the configuration file was modified introduces modifications to
an existing Work Plan list upon refresh. When the user clicks on the Refresh button, an SMP
Excel add-in window informs the user about the latest data points related modifications that
were brought to the configuration file since the creation or the last Refresh of the Work Plan List.
A data point related change in the configuration file will have the following effect on the Working
Plan list upon clicking on the Refresh button:
• A Microsoft Excel window opens to inform the user about the modifications made to the
data points since the last refresh; these modifications are triggered upon specific data point
characteristics that were changed, added or modified in the configuration file.
◦ Total Added : quantity of data points that were added
◦ Total Modified: quantity of data points for which static characteristics were modified
◦ Total Removed: quantity of data points that were removed
• The data points with Failed or Passed statuses for which a static characteristic was
modified will have their statuses changed to Failed - To Be Reviewed or Passed - To Be
Reviewed respectively. All other data point statuses will remain the same upon a change in
their configuration.
• A static data point characteristic that was modified introduces a red mark in the Working
Plan list related cell. This red mark is located in the cell’s upper right corner and is
independent of the data point status. Clicking on the red mark, opens a message box
displaying the data point’s characteristic old and new values.
• A removed data point will have its whole row crossed out. This data point will have to be
deleted manually.
• An added data point will be placed at the end of the Working Plan list.

Eaton User Manual | page 187


15. Security
To derive full benefits from IED integration, substation data must be available to users at the
enterprise level. However, widespread data access can become an important security risk if it is
compromised.

15.1. Displaying appropriate use banner


An appropriate use banner can be displayed upon each interactive access attempt to the
SMP Gateway, essentially in the following circumstances:
• At SMP Manager startup
• In the console of a terminal application, when a user connects to the SMP Gateway
passthrough server command line interface via the passthrough direct access port
• In a Web browser, when a user tries to connect the SMP Gateway HMI without launching the
web browser from SMP Manager

By default, no appropriate use banner is configured on the SMP Tools computer and on the
SMP Gateway.
To set up an appropriate use banner:

1. Create a text file named Banner.txt. The file should have the following form: [Title] <Insert the
Appropriate Use Banner dialog box title here.> [Text] <Insert the appropriate use banner text
here>
a. Under Title, type a title for the dialog box that may be used to display the banner.
b. Under Text, type the banner text required by the security policies of your company.
2. To display the banner only at SMP Manager startup, copy the banner file to the following
folder: ProgramData\Cooper Power Systems\SMP Tools
3. To display the banner for all other accesses to the SMP Gateway, upload the banner file to
the SMP Gateway:
a. In SMP Manager, from the Update menu, choose Send File(s).
b. Select the banner text file and click Open.
c. Restart the SMP Gateway.

The following screenshot presents an example of an appropriate use banner that is displayed at
SMP Manager startup.

User Manual | page 188 Eaton


15 - Security

Note: IED Manager Suite (IMS) has its own appropriate use banner mechanism, which
overrides the SMP Gateway local banner when the SMP device is managed by IMS and
SMP Manager is setup to connect to IMS. Refer to the IED Manager Suite documentation for
more details on the appropriate use banner mechanism.

15.2. Meeting NERC CIP requirements


The SMP Gateway helps you meet NERC requirements by providing secure access to
substation devices. Its sophisticated software includes the following security features:
• Authentication and authorization. Each user is authenticated by the SMP Gateway via a
user name and a password. Strong passwords, individual user accounts, user groups, and
detailed group permissions protect critical system functions from unauthorized access. All
access attempts are logged, and some authentication policies can be defined to lock out
specific accounts in the event of consecutive failed attempts.

Note: This security model can be extended, by purchasing IED Manager Suite (IMS).
See Extending the SMP Gateway security model (page 190) for details.

• Integrated firewall. The SMP Gateway is protected by an integrated firewall, which


only allows communications with specific users, computers and programs, including
communications with the SMP Tools, which goes through a TLS-encrypted access port. This
feature limits access to the SMP Gateway internal components and services.
• Monitoring and locking of remote connections. Modem and passthrough access is
continuously monitored, and can be enabled or disabled by the control center. All accesses
are logged and limited to authorized users.
• Integrity checking. All SMP Gateway software and firmware components are digitally
signed in order to ensure their authenticity and integrity. All executable files are also
continuously monitored to prevent execution of unauthorized code.

15.2.1. Identifying which ports are open in the SMP Gateway


firewall
When the SMP Gateway’s integrated firewall is configured and active, access to most
communication ports is blocked.
If you have a copy of the SMP Gateway configuration file, you can open it using SMP Config
and navigate through it to find which ports are open in the integrated firewall, and which ones
are not. An easier way to get this information is to look at the SMP Gateway Security log using
SMP Log or the SMP Gateway HMI.

Note: Only users with security management privileges can view the Security log.

The netstats (network statistics) command-line utility tool is often used to display TCP/IP
network connections. It can be useful to find active TCP and UDP connections, with their related
port addresses. However, the SMP Gateway firewall rules are what users should really look at to
find out which services are allowed through the firewall.

Eaton User Manual | page 189


15 - Security

As an example, port UDP 67 is listed in the UDP table when using the netstat -n command;
however, the SMP Gateway firewall does allow access to this port. Refer to section Specifying
firewall rules (page 203), for more details.
To identify ports which are opened in the SMP Gateway firewall:
• Start SMP Log (see Viewing log files (page 86)).
• Select the Security folder.

In the right pane, navigate through the various entries until you reach the ones that are time-
stamped at the date and time of the last startup. There should be an entry for each firewall rule.

15.2.2. Extending the SMP Gateway security model


The SMP Gateway security model is effective “locally”: security settings are stored in the
SMP Gateway, which is also responsible for security processes like authentication, and features
such as the firewall and VPN connections.
You may extend the SMP Gateway security model by purchasing the IMS Security Server,
which is part of IED Manager Suite. The IMS Security Server provides a global security model,
bringing it up to the corporate level and increasing access rights control and flexibility.

Note: The IMS Security Server global security model is out of the scope of this
document. For more information, contact your local Eaton representative.

15.3. Substation network security considerations


Security, as implemented on the SMP Gateway, is not a substitute for full network security that
includes properly configured firewalls, switches, IDS, IPS, etc.
It can be argued that if unauthorized users get as far as trying out the SMP Gateway security
features, there has already been a security breach at some other level. The goal of the
SMP Gateway integrated firewall, simply stated, is to protect the SMP Gateway internal
components and reduce its services’ exposure.

15.3.1. The SMP Gateway integrated firewall


The integrated firewall is active by default on a brand new SMP Gateway. Also, when a new
configuration file is created using SMP Config, the integrated firewall is also active in the file.
When activated, the firewall shuts off all the TCP/UDP ports of the SMP Gateway, except for the
following:

User Manual | page 190 Eaton


15 - Security

• TCP 6650 This is the SMP Gateway management port. All the network messages exchanged
between the SMP Gateway and the SMP Tools go through this secure port and are
encrypted using the Transport Layer Security (TLS) protocol (formerly known as Secure
Sockets Layer or SSL).
• TCP 443 This is the Hypertext Transfer Protocol over Secure Socket Layer (HTTPS) port,
which will be used by the Web browser to access the SMP Gateway Web server.

Note: Firewall rules can be defined to restrict access through these ports in the firewall.
However, be careful with the 6650 TCP port: if full access is restricted through this port, you
may no longer be able to connect to the SMP Gateway using the SMP Tools. If this situation
happens, refer to Firewall-related problems (page 304) , to learn how to fix this issue.

In addition to these ports, you can define additional access rules to allow other applications
to connect to the SMP Gateway, including SCADA and master stations, as described in
Configuring the integrated firewall (page 203).
The ICMP Ping service is also allowed by default through the firewall.

15.3.2. Using SMP Tools through a substation LAN firewall


As described in the previously, communications between the SMP Tools and SMP Gateways
are made through a single encrypted communication port. Access through this port is permitted
in the integrated firewall, but it must also be granted through the substation LAN firewall. It
is also strongly recommended to open the HTTPS port (TCP 443), to allow access to the
SMP Gateway Web server. This information is summarized in the following table.
Table 16 - Ports to open for SMP Tools usage in a substation LAN firewall
Application Port Protocol

General encrypted communications 6650 TCP


(SMP Gateway management port)

HTTPS 443 TCP

Modifying the security connection settings for the SMP Tools usage
The two encrypted ports that are dedicated for the SMP Tools usage, port 6650 and 443, are
setup by default with the TLS 1.2 protocol and Strong Cipher Suites. All available SSL/TLS
protocol settings are:
• TLS 1.2 (default)
• TLS 1.1, 1.2
• TLS 1.0, 1.1, 1.2
• SSL 3.0 and TLS 1.0, 1.1, 1.2

The SSL 3.0 protocol is now known to have a security design vulnerability. Eaton offers a
workaround to avoid using the SSL 3.0 protocol and use only the TLS encryption protocols.
To modify the security connection settings for the SMP Management port (6650):
• In SMP Config, expand the System branch, then the Management Server branch.
• Select the Connection branch.

Eaton User Manual | page 191


15 - Security

• At the top of the right pane, for port 6650, two settings can be adjusted.
• In the SSL/TLS Protocols cell, select the encryption protocol to be used for the SMP
Gateway management port. The selection choices are:
◦ TLS 1.2 (default)
◦ TLS 1.1, 1.2
◦ TLS 1.0, 1.1, 1.2
◦ SSL 3.0 and TLS 1.0, 1.1, 1.2
• In the Cipher Suite Profiles cell, select the set of cryptographic algorithms that will be used
to this connection. The use of Strong Cypher Suites is recommended.

Note: The list of ciphers available in each profile can be found in the following branch:
Security > SSL/TLS > Cipher Suite Profiles.

To modify the security connection settings for the Web Server port (443):
• In SMP Config, expand the System branch, then the Secure Web Server branch.
• Select the Connection branch.

• At the top of the right pane, for port 443, three settings can be adjusted.
• In the SSL/TLS Protocols cell, select the encryption protocol to be used for the Web server
port. The selection choices are:
◦ TLS 1.2 (default)
◦ TLS 1.1, 1.2
◦ TLS 1.0, 1.1, 1.2
◦ SSL 3.0 and TLS 1.0, 1.1, 1.2
• In the Cipher Suite Profiles cell, select the set of cryptographic algorithms that will be used
to this connection. The use of Strong Cypher Suites is recommended.

Note: The list of ciphers available in each profile can be found in the following branch:
Security > SSL/TLS > Cipher Suite Profiles.

• In the Local Certificate cell, select the certificate that will be used to authenticate the SMP
Gateway with the Web Server. The default setting is SMP Default, meaning that the default
SMP Gateway certificate is used. Other local certificate, provided by the user, can be used if
they are first defined in the SMP Config > Security > Certificates branch.

Note: The certificate provided by the user must be transferred to the SMP Gateway
using the SMP Manager’s menu: Security > Manage Certificates.

User Manual | page 192 Eaton


15 - Security

15.4. SMP Gateway authentication policy


Every utility defines its own set of security policies, including one for authentication.
The SMP Gateway authentication policy specifies the login requirements a user must meet in
order to get access to the SMP Gateway services and information. It also defines user account
lockout mechanisms.
SMP Manager allows you to specify the SMP Gateway authentication policy based on your
own policy, in order to apply it to the user accounts and passwords that you will define in the
SMP Gateway local security database. The policy itself is also stored in the SMP Gateway as
part of its security database.

15.4.1. Defining the SMP Gateway authentication policy (first


time)
The SMP Gateway authentication policy must first be defined at the creation of the
SMP Gateway security database. It can also be modified at a later time.

To define the authentication policy of an SMP Gateway for the very first time:

1. From the Security menu of SMP Manager, select Edit Local Security Database.
Result:

2. In the Description box under Security Configuration, type a short description for the security
database of the SMP Gateway; this description will appear at the top of the Local Security
Database Editor window.
3. Under Password, specify the requirements that passwords must meet when they are
entered:
a. In the Minimum password length box, specify the minimum number of characters that a
password must contain.
b. Select Password must meet complexity requirements if the password must contain at
least one character from each of the following categories:

Eaton User Manual | page 193


15 - Security

• English alphabetic (a through z or A through Z)


• Numerals (0 through 9)
• Non-alphanumerical (such as !, $, # or %, for example)
4. Under Account lock, specifies whether a user account is to be locked out from SMP Gateway
access if the user fails to log in properly and if so, what are the locking and unlocking
parameters:
a. If a user account must be locked out when the user fails to log in properly, select Enable
account lock. The two parameters that follow define the locking and unlocking rules.

Note: User accounts of the Administrators group may only be locked out if the
Enable SMP Gateway administrator account lock is also selected (see below).

b. To automatically unlock an account a certain amount of time (as defined by the Remove
lockout after setting that follows), select Activate automatic account unlock.
c. To also allow administrator accounts to be locked out, select Enable SMP Gateway
administrator account lock and specify the amount of time such accounts will be locked
out in the Remove administrator lockout after box.
d. To also allow administrator accounts to be locked out, select Enable SMP Gateway
administrator account lock and specify the amount of time such accounts will be locked
out in the Remove administrator lockout after box.
5. Click OK.
Result:
The Local Security Database Editor window appears and you are ready to define users and
groups (see The SMP Device security database (page 195) ).

15.4.2. Defining the SMP Gateway authentication policy (not for


the first time)
The SMP Gateway authentication policy can be modified at a later time.

To modify the authentication policy of an SMP Gateway on subsequent occasions:

1. Log into SMP Manager with an authorized username and password.


2. From the Security menu, select Edit Local Security Database.
3. From the Security menu of the Local Security Database Editor window, choose
Authentication Policy.
4. Modify the authentication policy to suit your needs, and then click OK.
Result:
The description of the security database appears in the title bar of the Local Security
Database Editor window, and the authentication policy will go into effect as soon as it will be
sent to the concerned SMP Gateway(s).

15.4.3. User account lockout


An account is locked out when a user attempts to authenticate using this account, but provides
an invalid password a certain number of times over a specific period of time.

User Manual | page 194 Eaton


15 - Security

These lockout settings are specified in the SMP Gateway authentication policy, as explained
in the section Defining the SMP Gateway authentication policy (first time) (page 193) and
Defining the SMP Gateway authentication policy (not for the first time) (page 194)
Locked-out accounts cannot be used to authenticate with the SMP Gateway until they are
unlocked. They can be unlocked automatically after a certain period of time; otherwise, they
must be unlocked manually by a system administrator.
Administrator accounts may also be subject to account lockout, as specified, or not, in the
SMP Gateway authentication policy.

15.4.4. Unlocking user accounts


Security management privileges are required to unlock user accounts.

To unlock one or more user accounts:

1. In SMP Manager, select the SMP Gateway for which you want to perform the unlock
operation.
2. From the Security menu, choose Unlock User Account.
Result:

3. Select Unlock all accounts OR Select Unlock specific account, and specify the account
in the User Name box.
4. Click Unlock to unlock the account(s), and then click Close.

15.5. The SMP Device security database


The SMP Device Security Database contains the authentication policy that applies to a given
SMP Device, along with the list of user accounts that have access to the unit.
The copy of the security database that is stored locally, on the same PC as the SMP Tools, is
called the local security database.
SMP Device access depends on the level of privileges that is granted to user groups that a
given user account belongs to.
New user groups and accounts can be created, renamed and deleted. Some restrictions apply
to administrator groups and accounts. It is not possible to create new privileges.
In this section, you will learn how to perform the following operations:
• Access the Local Security Database Editor.
• Manage the list of user groups and user accounts.
• Grant privileges to user groups.
• Change the password of user accounts.

Eaton User Manual | page 195


15 - Security

• Validate and upload the local security database to an SMP Device.


• Deactivate local authentication.

Important: When local security is added/removed or a new configuration file is sent at


runtime, the application is restarted and the limitations related to local security apply. This
means that if the Local Security Required setting is checked in the configuration file and
local security is removed from the SMP Device, the device starts in Safe Mode and the
Ethernet network is disabled. Inversely, if the Local Security Required setting is checked
in the configuration file and local security is added to the SMP Device, the device starts
normally and the Ethernet network is enabled.

15.5.1. Default groups and privileges


In the following table, you will find default user groups and privileges. You can change group
privileges at will; of course, you have to upload the security database to the SMP Device
afterwards.
Note: If you remove privileges, you must notify the concerned groups or users; otherwise,
they will fill up the security log with access denial messages if they keep trying to access the
gateway.
Table 17 - Privileges assigned to groups by default
Privilege Description Groups

Security Management Update security database: unlock user accounts; Administrators


access Security and Firewall logs.

System Management Update firmware components and license; access Administrators


SMP Console; set date and time; configure
network settings; activate the Commissioning Tool;
configure redundancy settings (if applicable).

Configuration Update an SMP Deviceconfiguration file. Administrators, technicians

Read only Read an SMP Device configuration file (read only). Administrators, technicians,
operators

Diagnostic Access diagnostic tools; access an SMP Device Administrators, technicians,


System Dashboard. operators

IED maintenance Perform IED management with a device connected Administrators, protection
to the SMP Gateway via a passthrough connection engineers
(if applicable).

Monitoring Monitor the SMP device real time database Administrators, technicians,
(RTDX). operators, guests

Operation Perform control operations on real time database Administrators, operators


points.

Remote access Access an SMP device via dial-up or VPN (if Administrators, technicians,
applicable). protection engineers, operators

User Manual | page 196 Eaton


15 - Security

15.5.2. Accessing the local security database editor

Initially, the local security database includes the following elements:


• One predefined user account, namely an administrator with full privileges.
• 5 predefined user groups, each with predefined privileges. Privileges are described in the
Default groups and privileges (page 196).

You can edit the user groups and user accounts using the Local Security Database Editor,
accessible from SMP Manager.
To access the Local Security Database Editor:

1. From the Security menu of SMP Manager, choose Edit Local Security Database. The
Local Security Database Editor window appears.
2. If you click a user group in the left pane, the right pane shows the privileges assigned to this
group and gives a description of each privilege.
Result:

15.5.3. Managing the list of user groups


The Local Security Database Editor allows users to create new user groups, to rename them, or
delete them.
To create a new user group:
• From the Group menu of the Local Security Database Editor window, choose New.
• Type the name of the new group, and then press ENTER.

To rename a user group:


• In the left pane of the Local Security Database Editor window, select the group to rename.
• From the Group menu, choose Rename.
• Type the new name, and then press ENTER.

Note: You cannot rename the Administrators user group.

To delete a user group:


• In the left pane of the Local Security Database Editor window, select the group to delete.

Eaton User Manual | page 197


15 - Security

• From the Group menu, choose Delete. You will be advised if there are any users assigned to
the group you are about to delete.

Note: You cannot delete the Administrators user group.

15.5.4. Granting privileges to a user group


Privileges are not granted to individual users, but to groups. User accounts are then assigned to
the groups that correspond to their roles.

You cannot create, delete or rename privileges. However, you can choose which predefined
privileges you want to assign to a particular group.
To grant privileges to a user group:

1. In the left pane of the Local Security Database Editor window, select the group.
2. In the right pane, select desired privileges’ check boxes for this group.
3. Clear other privileges’ check boxes.

15.5.5. Managing the list of user accounts


The Local Security Database Editor allows users to create new user accounts, to rename them,
or delete them.
The Administrator user cannot be deleted, but it should be renamed the first time you edit the
security database, because the name is so revealing that it exposes the account to brute force
attacks.

Note: The Administrator user account is identified by a different icon.

To create a new user account:


• From the User menu of the Local Security Database Editor window, choose New.
• Type the name of the new user, and then press ENTER.

To rename a user:
• In the left pane of the Local Security Database Editor window, select the user to rename.
• From the User menu, choose Rename.
• Type the new user name, and then press ENTER.

To delete a user:
• In the left pane of the Local Security Database Editor window, click the user to delete.
• From the User menu, choose Delete.

15.5.6. Setting the password of a user account


Each user account defined in the security database must have its own different password,
based on the authentication policy defined for the SMP Device.

User Manual | page 198 Eaton


15 - Security

To assign a password to a new user or to change the password of an existing user:

1. In the left pane of the Local Security Database Editor window, select the user.
2. From the User menu, choose Set Password.
3. In the Set Password window, type and confirm the new password.

15.5.7. Assigning a user account to groups


Privileges are granted to groups, not to users. As a result, you must assign a user account to
one or more user groups.

To assign a user account to one or more user groups:

1. In the left pane, select the user.


2. In the right pane, select the groups the user will be assigned to. For example, in the following
illustration, the user named “Matt” is assigned to the Protection Engineers group.
Result:

15.5.8. Validating the local security database


The local security database, which includes your authentication policy and the users and groups
you have defined, is automatically validated and stored locally on your PC when you close the
Local Security Database Editor window.
However, if you want to manually validate your security database without closing the window,
proceed as follows:
• In the Local Security Database Editor window, from the Security menu, choose Check
Validity. This will compare your security parameters, such as passwords, with the
authentication policy that you defined beforehand.

Eaton User Manual | page 199


15 - Security

15.5.9. The SMP Device security database status


In SMP Manager, the Security column indicates if local authentication or IMS (“global”)
authentication is active on each SMP Device. If the user also has security management
privileges, it also displays the status of the local security database that is currently active the
SMP Device.
Here is an explanation of the different values that may be displayed for local authentication and
the security database, followed by suggestions of actions to take, if any:
• Up to Date: The security database on the SMP Device is the same as the local security
database that is currently active on your PC. This is the normal case.
• Older (date and time): You sent a security database to the SMP Device, but subsequently
modified the local security database. Therefore, the security database on the SMP Device is
older than your local security database.
• Newer (date and time): You sent a security database to the SMP Device, but someone on
another PC subsequently modified his or her own local security database and sent it to the
SMP Device.
• n/a: The software installed on the SMP Device does not support the authentication features.

If the SMP Device contains an older security database:


• Send your local security database to the SMP Device. The Status column will now display
Local: Up to Date.

If the SMP Device contains a newer security database:


• Contact the person who manages this SMP Device configuration, to determine if the changes
are appropriate.
• If you agree, retrieve the security database from the SMP Device in order to update your own
local security database. The Status column will now display Local: Up to Date.
• Otherwise (if the modifications should not have been made):
• Send your own local security database to the SMP Device. The Status column will now
display Local: Up to Date.

15.5.10. Uploading the local security database on SMP Devices


The local security database, which includes your authentication policies, users and groups, is
stored locally on your PC.

To activate local authentication based on these settings on one or more SMP Device, you must
upload your local security database on these SMP Device.
Only users with Security management privileges can update the local security database of an
SMP Device.
To upload the local security database on SMP Device:

1. In SMP Manager, select the SMP Device(s) on which you want to upload the local security
database.

User Manual | page 200 Eaton


15 - Security

2. From the Security menu, choose Update Security Database. SMP Manager encrypts the
information, and then sends the configuration to the SMP Devices(s).

If the user has security management privileges, the Security column indicates if the security
database of each SMP Device in the list matches the local security database currently stored on
the PC.
Otherwise, the Security column only displays whether authentication is active, or not, on the
gateway, without telling if the local security database is up-to-date.

15.5.11. Retrieving an existing security database from an SMP


Device
You may want to replace your current local security database with the security database that is
currently loaded on a specific SMP Device.

To retrieve the security database of an SMP Device:

1. In SMP Manager, select the SMP Device.


2. From the Security menu, choose Get Local Security Database. SMP Manager retrieves
the file from the SMP Device and upon your approval, replaces your local security database
with the one retrieved from the SMP Device.

15.5.12. Exporting the local security database

There are two reasons why you may want to export your local security database to a file:
• To create a backup copy.
• To transfer your security database from one PC to another.

To export the local security database to a file:

1. In SMP Manager, choose Edit Local Security Database from the Security menu.
2. In the Local Security Database Editor window, choose Send to File from the Security menu.
3. In the Send Security to File window, specify a file name and click Save.
4. Close the Local Security Database Editor window.

15.5.13. Uploading a previously saved security database


Let us suppose that an authorized person in your organization updated the local security
database on his or her PC, and sent you a copy of the security database file.

To load this new security database onto one or more SMP Device:

1. Retrieve the file:


a. From the Security menu of the Local Security Database Editor window, choose Get from
File.

Eaton User Manual | page 201


15 - Security

b. In the Get From File window, specify the file name and click Open. The retrieved file now
becomes the currently active local security database.
c. Close the Local Security Database Editor window.
2. In SMP Manager, select the SMP Device(s) to which you want to send the security database.
3. From the Security menu, choose Update Security Database.

15.5.14. Deactivating local authentication on SMP Devices


If you want to deactivate local authentication on an SMP Device, you must remove its security
database.

To remove the security database from one or more SMP Device(s):


You can reactivate local authentication of one or more SMP Devices by sending them your local
security database, as described under Uploading the local security database on SMP Devices
(page 200).

1. In SMP Manager, select the SMP Device from which you want to remove the security
database.
2. From the Security menu, choose Remove Security Database.

Note: If IMS authentication is active on the SMP Gateway, the Remove Security
Database command will be unavailable. If you really want to deactivate local
authentication on the SMP Gateway, you must first deactivate IMS authentication.
Refer to the IED Manager Suite, Supporting Devices with IMS – Reference Guide,
MN913023EN.

Once you have confirmed your intention and the security database has been removed, the
Security column in SMP Manager now displays the following status for the SMP Device(s) you
selected: Local: Disabled.

Note: Removing the security database only deactivates the authentication policy, user
accounts and groups. Other security features, such as integrity checking, firewall and VPN
management, are still active.

What to do next:
You can reactivate local authentication of one or more SMP Devices by sending them your local
security database, as described under Uploading the local security database on SMP Devices
(page 200)

User Manual | page 202 Eaton


15 - Security

15.6. The SMP Gateway Security log


If you have security management privileges, you can view the security log and see all security-
related events, including:
• All authentications, whether granted or refused
• All user account locks and unlocks
• All configuration, maintenance, and security management activities
• All console, Web and passthrough server accesses
• Integrity check status information
• Security server status information
• All ports that are open in the SMP Gateway integrated firewall

15.6.1. Viewing the Security log


Security management privileges are required to view the Security log in SMP Log or SMP
Gateway HMI.

If you do not have sufficient privileges, this log folder will not appear in SMP Log or in SMP
Gateway HMI.
To view the security log using SMP LOG:

1. From the Tools menu of SMP Manager, choose SMP Log.


2. In the SMP Log application window, click the Security folder in the left pane. The security-
related events will appear in the right pane.

15.7. Configuring the integrated firewall


This section describes how to configure the firewall, as well as the various related options that
are offered.
Some predefined settings open a few ports in the integrated firewall, as described in the section
entitled The SMP Gateway integrated firewall (page 190). The following sections explain how to
modify these settings to allow access to the SMP Gateway applications and services.

15.7.1. Specifying firewall rules


Firewall rules includes specific services that are allowed, or not, through the firewall. Custom
rules can also be defined to open, or not, additional port(s), or to allow access to applications
from specific computers or subnets.

1. To modify services access through the firewall:

Eaton User Manual | page 203


15 - Security

a. In SMP Config, expand the Security branch, the Firewall branch, and then select the
Rules branch. At the top of the right pane, a list of services is displayed.
Result:

b. To allow a service through the firewall, select Allow.


c. To restrict access to a specific computer of subnet, select the appropriate setting in the
Accessible From cell and enter the name or address of the computer/subnet in the
Specific Computer or Subnet cell.

Note: The maximum number of address/subnet allowed is 32. CIDR notation


is supported (Classless Inter-Domain Routing), meaning that you can write
10.106.187.55/24 instead of 10.106.187.55/255.255.255.0. If you wish to specify an
address range (e.g: 10.106.186.128 to 10.106.188.128) you can use the online tool
to convert the range to a CIDR netmask list, to facilitate notation. Refer to https://
www.ipaddressguide.com/cidr for details and examples.

Result:
If a service is not present in the list, refer to Restricting access to other services (page
205), to see if access is not configured somewhere else in SMP Config. If it is still not the
case, a custom firewall rule must be defined.

Note: If you plan to use legacy versions of the SMP Tools to monitor SMP Gateways
with recent software installed, access must be given to the Legacy Status Server
service. Otherwise, the legacy SMP Manager will not be able to monitor the gateway
status. Moreover, depending on the strategy used to address DCOM access to the
SMP Gateway, access to the VPN service may also be required. If VPN is not an option
(VPN is not supported on the SMP SG-42xx platform), a final alternative is the definition
of all ports, including those used by DCOM, as custom firewall access rules.

2. To define a custom firewall access rule:


a. In SMP Config, expand the Security branch, the Firewall branch, and then select the
Rules branch. At the bottom of the right pane, a list of custom rules is displayed. Note that
no custom rule is defined by default.
Result:

b. Click in the Name cell, and then type a short name to briefly describe the rule you are
about to define.
c. Select Allow, to allow access OR Clear the Allow check box to restrict access.
d. Select the protocol (either TCP/IP or UDP/IP).

User Manual | page 204 Eaton


15 - Security

e. In the Port Range cell, enter the number(s) of the port(s) for which you want to permit/
restrict access. You can enter multiple ports, separated by commas. Port ranges are
defined using a dash: for example, 1270-1280 means that the rule applies to all ports
between and including ports 1270 and 1280.
f. If the rule applies to a specific computer or subnet, enter this information in the
Accessible From and Specific Computer or Subnet cell.

Note: The maximum number of address/subnet allowed is 32. CIDR notation


is supported (Classless Inter-Domain Routing), meaning that you can write
10.106.187.55/24 instead of 10.106.187.55/255.255.255.0. If you wish to specify an
address range (e.g: 10.106.186.128 to 10.106.188.128) you can use the online tool
to convert the range to a CIDR netmask list, to facilitate notation. Refer to https://
www.ipaddressguide.com/cidr for details and examples.

g. In the Description cell, you can enter additional information to further describe the rule.
This field is optional.
3. To delete a rule:
a. Click in the row. You will see an arrow on the left side of that row.
b. Click the arrow and press the Delete key.

15.7.2. Restricting access to other services


Access to some of the SMP Gateway services and applications through the integrated firewall is
not configured in the System/Firewall branch.
TCP/IP and UDP/IP slave connections are automatically allowed through the integrated firewall,
but access can be restricted to specific computers or subnets, as described in section Setting
up a TCP/IP slave connection (page 104) and Setting up a UDP/IP slave connection (page
106).
The same applies to the SNTP server and the Passthrough Direct Access Port, when
configured. To learn how to restrict access to the SNTP server from specific computers or
subnets, see section Setting up the SMP Gateway to act as an SNTP server (page 271). For
the Passthrough Direct Access Port, refer to the technical note entitled Using the SMP Gateway
Passthrough Command Line Interface, MN912069.

15.7.3. Deactivating the integrated firewall


For some reasons, the integrated firewall might not be required on the SMP Gateway.

To disable the integrated firewall:

1. In SMP Config, expand the Security branch, the Firewall branch, and then select the
General branch.
Result:

2. Clear the Enabled check box.

Eaton User Manual | page 205


15 - Security

15.7.4. Disabling the Firewall log


All firewall activities are logged in the Firewall log, which can be accessed using the SMP Log
tool. If for some reasons, firewall activities logging is not required, this feature can be
deactivated as follow:

If for some reasons, firewall activities logging is not required, this feature can be deactivated as
follow:

1. In SMP Config, expand the Security branch, the Firewall branch, and then select the
General branch.
2. Clear the Log Enabled check box.

15.8. Device account password management


When connecting to a specific device, the SMP Gateway may have to provide account
information, such as a login name or a password.
Such information is usually specified at configuration time, in the SMP Gateway configuration
(PAR) file, using SMP Config.
If the corresponding account changes on the device, the SMP Gateway configuration must be
updated with the new account information. However, this approach requires an SMP Gateway
restart, which may not be appropriate in some situations.
For some protocols and services, it is possible to change these passwords at runtime, using
SMP Manager, without having to change the SMP Gateway configuration. This feature has
the double advantage of not having to restart the SMP Gateway and also avoiding having the
password written in the configuration file, which is not a very secure practice.
This feature is made possible through the SMP Gateway password secure store, and requires
the Security Management privilege. We highly recommend using the secure store as good
practice for obvious security reasons for protocols and services that support this feature, for
example the DNP3 protocol.

Note: The device account password management feature cannot change the password
of the corresponding devices themselves. For that matter, you must either perform
the change manually using the corresponding maintenance tool (locally or through a
passthrough connection), or use the Password Manager application of IED Manager Suite
(IMS). For additional information about IED Manager Suite and Password Manager, contact
your Eaton sales representative.

15.8.1. The SMP Gateway password secure store


The SMP Gateway password secure store is a central repository for account information used
by various SMP Gateway components, notably master protocols, to communicate with devices
or master stations.

User Manual | page 206 Eaton


15 - Security

When a protocol instance or any other component that supports this feature (must also be
enabled), is started for the first time by the SMP Gateway application, an account entry is added
to the secure store. The password of this account entry can then be updated at runtime, using
SMP Manager, without having to change the SMP Gateway configuration.
This secure store entry will not be used until it is first updated through SMP Manager, which
means that you will still be able to update the corresponding passwords using SMP Config.
However, as soon as you update this account password in the SMP Gateway
secure store, the corresponding component will no longer look in the SMP Gateway
configuration file for this password (for obvious security reasons) even if it is updated in
the SMP Gateway configuration file.
Once an account entry exists in the secure store for a specific device or service, it cannot
be deleted as long as the corresponding component instance exists in the SMP Gateway
configuration.

15.8.2. Updating an account password in the SMP Gateway


secure store
This procedure explains how to update an account password in the SMP Gateway secure
store, in order to override the current password specified for this account in the SMP Gateway
configuration (PAR) file at configuration time.

This update has no effect on the actual account password stored in the device itself. Moreover,
if you update an account password directly in the SMP Gateway secure store, you will no longer
be able to update it through the SMP Gateway configuration file.
To update an account password in the SMP Gateway secure store:

1. Start SMP Manager.


2. Select the SMP Gateway to update.
3. From the Security menu, choose Update Device Accounts.
Result:

4. Select the account to update, and then click Modify.


Result:

Eaton User Manual | page 207


15 - Security

5. Enter the new password twice, and then click OK.


6. Click Yes to confirm.
7. Once the update operation is completed, click OK to close the confirmation window, and
close the Update Device Accounts window.

15.8.3. Deleting an account password from the SMP Gateway


secure store

The following procedure explains how to delete an account entry from the SMP Gateway secure
store when it is no longer used (e.g., the corresponding master protocol instance was deleted
from the configuration).
To delete an account password from the SMP Gateway secure store:

1. In SMP Manager, select the SMP Gateway to update.


2. From the Security menu, choose Update Device Accounts.
3. Select the account to update, and then click Delete.

Note: You cannot delete an account password that is currently in use.

4. Click Yes to confirm.


5. Once the delete operation is completed, click OK to close the confirmation window, and close
the Update Device Accounts window.

15.9. Secure authentication using X.509 certificates


X.509-based secure authentication can be configured for master and slave protocols at the
Transport layer level (i.e. at the TCP/IP connection level).
Some protocols, such as ICCP, also supports secure X.509 authentication at the application
level.
In both cases, you must:
• import X.509 certificate information in the SMP Gateway configuration file, using SMP Config;
• assign these certificates to the corresponding protocol or communication component
instances in the configuration file, using SMP Config;
• upload the actual certificate file on the SMP Gateway, using SMP Manager.

User Manual | page 208 Eaton


15 - Security

Note: Although it is possible to use the same set of X.509 certificates both at the
Application and Transport level, it is recommended to use a different set for each.

These operations are presented in details in the sections that follow.

15.9.1. Importing X.509 certificate information in the


SMP Gateway configuration
Each X.509 certificate that will be used by an SMP Gateway software component must
be defined in the SMP Gateway configuration so it can be assigned to the corresponding
component instance.

Repeat this procedure for each X.509 certificate.


To import X.509 certificate information in the SMP Gateway configuration:

1. In the left pane of SMP Config, expand the Security branch, and then select the Certificates
branch.
2. From the Tools menu, select Import Certificate Information.
3. Browse for the X.509 certificate file, select it, and then click Open. Information about the
selected certificate will be added in a new row of the right pane.
4. A Name is proposed for this certificate, based on the imported information; if you want to
change this name, click in the corresponding cell and type the new name.

15.9.2. Associating X.509 Certificates to a TCP/IP master


connection
X.509 certificates can be associated to a TCP/IP master connection to implement secure
authentication at the Transport layer level.

Before proceeding with this task:


• the TCP/IP master connection must be created and configured; moreover, TLS/SSL
encryption must be configured for that connection;
• information about the corresponding X.509 certificates must be imported in the
SMP Gateway configuration.

To associate X.509 certificates to a TCP/IP master connection:

1. In the left pane of SMP Config, expand the Connections branch, the TCP/IP branch, the
Masters branch, and then select the branch of the connection to configure.
2. In the Local Certificate cell, select the certificate that will be used to authenticate the
SMP Gateway with the IED.

Note: Only X.509 certificates that are defined in the SMP Gateway configuration
and whose File Type setting is set to Local (has private key) can be assigned to this
setting.

Eaton User Manual | page 209


15 - Security

3. In the Remote Certificate cell, select the certificate that will be used to validate the Serial
Number field of the IED certificate.

Note: Only X.509 certificates that are defined in the SMP Gateway configuration
and whose File Type setting is set to Remote (public key only) can be assigned to this
setting. If no Remote Certificate is specified, the only validation that is performed on the
IED certificate is whether it comes from the proper trusted Certificate Authority (CA) or
not.

4. In the Trusted Root CA cell, select the trusted Certificate Authority (CA) that will be used to
validate the signature of the IED certificate.

Note: Only X.509 certificates that are defined in the SMP Gateway configuration
and whose File Type setting is set to Trusted Root CA can be assigned to this setting.

15.9.3. Associating X.509 certificates to a TCP/IP slave


connection
X.509 certificates can be associated to a TCP/IP slave connection to implement secure
authentication at the Transport layer level.
Before you begin:
• the TCP/IP slave connection must be created and configured; moreover, TLS/SSL encryption
must be configured for that connection;
• information about the corresponding X.509 certificates must be imported in the
SMP Gateway configuration.

Before proceeding with this task:


To associate X.509 certificates to a TCP/IP slave connection:

1. In the left pane of SMP Config, expand the Connections branch, the TCP/IP branch, the
Slaves branch, and then select the branch of the connection to configure.
2. In the Local Certificate cell, select the certificate that will be used to authenticate the
SMP Gateway with the IED.

Note: Only X.509 certificates that are defined in the SMP Gateway configuration
and whose File Type setting is set to Local (has private key) can be assigned to this
setting.

3. In the Remote Certificate cell, select the certificate that will be used to validate the Serial
Number field of the IED certificate.

User Manual | page 210 Eaton


15 - Security

Note: Only X.509 certificates that are defined in the SMP Gateway configuration
and whose File Type setting is set to Remote (public key only) can be assigned to this
setting. If no Remote Certificate is specified, the only validation that is performed on the
IED certificate is whether it comes from the proper trusted Certificate Authority (CA) or
not.

4. In the Trusted Root CA cell, select the trusted Certificate Authority (CA) that will be used to
validate the signature of the IED certificate.

Note: Only X.509 certificates that are defined in the SMP Gateway configuration
and whose File Type setting is set to Trusted Root CA can be assigned to this setting.

15.9.4. Uploading X.509 certificate files on the SMP Gateway


To upload X.509 certificate files on the SMP Gateway:

1. In SMP Manager, select the SMP Gateway to update.


2. From the Security menu, select Manage Certificates.
3. In the SMP Device Certificate(s) window, click Add.
4. Browse for the certificate files to add to the SMP Gateway certificate store, select them, and
then click Open.
5. If you selected PKCS #12 or PFX certificate files, you will be prompted for passwords; enter
the right password for each file as requested.

The uploaded files should appear in the SMP Device Certificate(s) window.

15.9.5. X.509 authentication at the application layer level


To learn how to configure X.509 secure authentication at the Application layer for a specific
protocol component, refer to the corresponding protocol reference manual.

15.10. File certification and integrity checking


All executable files on the SMP Gateway and all SMP Tools are digitally signed to ensure that
they originate from Eaton. A digital fingerprint is encrypted and inserted in the file at the factory.
Whenever you upload a file to the SMP Gateway, SMP Manager or SMP Loader performs
an integrity check on the file. Furthermore, a continuous integrity check is performed on the
SMP Gateway at all times, to detect whether any executable file has been tampered with by a
virus or if an unauthorized file has been loaded via an unconventional method.

Eaton User Manual | page 211


15 - Security

Once you have uploaded a version of the SMP Gateway software that includes file integrity
checking to the SMP Gateway, you cannot use a previous uncertified version of the
SMP Gateway software, or a version of the SMP Tools that use uncertified files, since they
would fail the integrity checks.

15.10.1. Detecting an integrity check failure


If a file fails the integrity check, the SMP Gateway restarts and goes into “Safe mode”, in which
there is no communication between the devices and the SMP Gateway.
You can detect this situation as follows:
• In the SMP Manager window, the Status column shows that the SMP Gateway is in “Safe
mode”.
• All device points are tagged with a communications failure attribute. A series of alarms are
generated, at the SCADA level or in a local HMI.
• The Reset log indicates that the integrity check function has restarted the SMP Gateway in
safe mode.
• The Security log contains an entry indicating when the problem was detected, and several
entries identifying which files failed the integrity check. It can take up to 5 minutes for all
entries to appear in the log.

15.10.2. Recovering from an integrity failure


Windows CE, which is installed in the SMP Gateway, is the software responsible for the integrity
check. If the gateway goes into safe mode, it means that the gateway application needs to be
updated to match Windows CE.
To recover from an integrity failure:
• If the Security log indicates an Integrity check warning concerning a specific file (DLL
or EXE), for example: INTEGRITY CHECK: Warning - File "\DiskA\Current
\LogComp.dll" not certified by Cooper Power Systems (10), you will have to
change the file extension and retrieve it via SMP Manager, before proceeding with the update
of the SMP Gateway application. To do that:
◦ Launch SMP Console
◦ Go to the file location: for example cd \diska\current, if the file is located in the diska/
current directory
◦ Change the file extension for .txt. To do that, type:
ren <filename.yyy> <filename.txt>
◦ If the file is not located in the diska/current directory, move it there.
Example for a file located in diska:
> cd \diska\current
> move \diska\<filename.txt> .
◦ In SMP Manager, retrieve the file: select Update > Get Configuration file
• Update the SMP Gateway application on the SMP Gateway described in section Updating
SMP Gateway Software and Tools (page 279)

User Manual | page 212 Eaton


15 - Security

• If the SMP Gateway goes into safe mode after the update, contact Eaton’s Technical Support
(see Getting assistance (page 17) ).

15.11. Locking passthrough and incoming RAS


connections
Passthrough connections between the SMP Gateway and the IEDs, and incoming RAS dial
up connections to the SMP Gateway, represent yet another possible security threat to the
SMP Gateway.

Note: For more information about passthrough connections, see Using Passthrough
connections (page 216). For more information about RAS dial up connections, see SMP
Tools remote access to the SMP Gateway (page 276).

The control center can lock all incoming RAS dial up connections, as well as individual
passthrough connections, using some of the SMP Gateway system data points. These system
data points are presented in System data points (page 307)
The following sections explain the various methods available to lock/unlock RAS/passthrough
connections.

15.11.1. Locking or unlocking a passthrough connection


The control center can lock or unlock passthrough connections individually, and can also
request that a particular passthrough connection be automatically locked or unlocked on
SMP Gateway startup.

To request that a particular passthrough connection be locked or unlocked on SMP Gateway


startup:

1. To lock or unlock a passthrough connection:


a. From the SCADA, perform the OPEN or CLOSE operation on the
_smp___passthru<connection>Enable data point.
You can do a Direct Execute or a Select Before Operate (SBO). For additional
information on how to perform control operations using Visual T&D Explorer, refer to
Visual T&D Explorer User Manual, MN914001EN .
2. To request that a particular passthrough connection be locked or unlocked on SMP Gateway
startup:
a. In SMP Manager, select the SMP Gateway.
b. From the Tools menu, choose SMP Config.
c. In the left pane, expand the Passthrough branch, and then select the Connections
branch.
d. In the right pane, select the passthrough connection, and then either select or clear the
Locked at Startup check box.

Eaton User Manual | page 213


15 - Security

15.11.2. Locking or unlocking all incoming RAS dial up


connections
The control center can lock all incoming RAS dial up connections at any time, regardless of
whether or not there is communication in progress.

When the SMP Gateway restarts, RAS dial up connections’ lock information is preserved.
There are 2 ways to lock or unlock incoming RAS dial up connections:

1. Method 1- Through SMP Console and using the RAS Manager utility program:
a. In the SMP Manager window, select the SMP Gateway and start a console session.
b. Type the command that starts the RAS manager: RASMGR
c. Type the command that toggles between locking and unlocking incoming dial up
connections: X
Result:
The following example illustrates how you can lock, and then unlock RAS dial up
connections.

2. Method 2 – By performing a control operation on a system data point:


a. From the control center or a local HMI (such as Visual T&D or SMP Gateway HMI),
perform the OPEN or CLOSE operation on the _smp___dialupEnable data point. You
can do a Direct Execute or a Select-Before-Operate (SBO)

Note: The SMP SG-42xx platform does not accept direct incoming RAS
connections; an intermediary device must be used to connect the SMP SG-42xx
platform to a modem. Refer to the Application note: Accessing an SMP SG-42xx
Platform Using a RAS Connection, MN912141EN for information on how to proceed.

15.12. Security-related system data points


The SMP Gateway store some security-related statuses and data into system data points.
These points are listed in section System data points (page 307).

User Manual | page 214 Eaton


15 - Security

15.13. Using VPN connections


VPN is only supported on the SMP 4/DP platform, it is however not necessary to use a VPN
connection because SMP Gateway connections are secured.

Note: To manually set up a VPN connection, the user must have the System
Management privilege for the SMP Gateway.

To manually set up and use a VPN connection:

1. In SMP Manager, select the gateway for which you want to configure a VPN connection from
your PC.
2. From the SMP Device menu, choose Connect Through VPN.
3. What happens when you click this function the first time is:
a. It creates a new connection in the Network Connections view of Windows’ Control Panel.
b. In SMP Manager, in the VPN column for the selected gateway, you will see the
Connecting… status message, and then Connected.
c. In Windows, open the Start menu, and navigate up to the following menu: Control Panel
> Network and Sharing Center > Set up a new connection or network
d. Select Network Connections. You will now see a new icon named after your gateway,
under Virtual Private Network.
e. You are now ready to use your tool/application through the VPN connection.
4. To disconnect from the VPN:
a. From the SMP Device menu, choose Disconnect VPN.

Eaton User Manual | page 215


16. Using Passthrough connections
Two optional passthrough features give you the ability to use PC-based tools to access the
devices connected to an SMP Gateway.
The first Passthrough feature is for general use, most manufacturers of recent IEDs provide
maintenance tools (NVT) for the configuration and maintenance of their devices. These tools
usually connect to the device using a serial link or, less frequently, a network connection. Since
IEDs are now connected to the SMP Gateway instead, the SMP Gateway passthrough function
has to intercept this communications link and provide a mechanism to exchange data between
the NVT and the IED. The SMP Gateway passthrough feature gives you the ability to use
PC-based tools to access the devices connected to an SMP Gateway. Different options are
available when using this feature.
The second passthrough feature is a simplified one compared to the first passthrough feature
because it is used solely between SMP Manager and SMP devices thus, eliminating the
necessity of using SMP Connect. This passthrough feature is called the Proxy Passthrough.
In the SMP Software and Tools documentation, we will use the term Passthrough for the
first feature which is general and can be used by SMP devices as well; the term Proxy
Passthrough will be used for the second passthrough feature.

16.1. The Passthrough feature

16.1.1. Principles of operation


The standard passthrough feature provides two options; with the first option, the process needs
to be manually started using the SMP Manager’s SMP Connect application. It then uses the
SMP Gateway as a terminal server to access the remote device.
The second option allows for automated passthrough connections, for example by using scripts,
using the command line interface provided by the SMP Gateway passthrough server. It is
accessible from a single TCP port called the Passthrough Direct Access Port.
The two different ways of accessing an IED through the SMP Gateway are described in the
following sections.

16.1.1.1. Passthrough functionality using SMP connect


The passthrough functionality is implemented by two software components: the SMP Connect
windows application, which is part of the SMP Tools suite, and the SMP Gateway Passthrough
Server.
An overview of the passthrough functionality is presented in the illustration that follows.

User Manual | page 216 Eaton


16 - Using Passthrough connections

Figure 13 - The passthrough process, using SMP Connect, explained

A virtual loopback connection must be set up between SMP Connect and the NVT. This allows
SMP Connect to intercept the communications link from the maintenance or configuration
tool, and forward the data to the SMP Gateway. The SMP Gateway passthrough server then
forwards the data to the device via a serial link. The result is that maintenance and configuration
tools can operate as if the device were directly connected to the PC.
While the PC application is communicating with the IED or RTU, the SMP Gateway, which acts
as the master, may have to suspend its data acquisition with the devices. This may happen
even though only one device is engaged in communications with the PC application and it
depends on the serial link and device type involved. This suspension is illustrated using a red
“X” in previous figure.
SMP Connect terminates the passthrough connection if a problem arises or if there is no
data exchanged during a specified inactivity period, corresponding to the Inactivity Timeout
parameter in SMP Config.

Eaton User Manual | page 217


16 - Using Passthrough connections

16.1.1.2. Passthrough functionality using the Direct Access Port


Passthrough connectivity with SMP Connect requires human intervention. The SMP Gateway
Passthrough Server command line interface must be used to establish passthrough connections
from a remote computer using automated scripts. This interface is available through the
Passthrough Direct Access Port.
An overview of this passthrough functionality is presented in the illustration that follows.

Figure 14 - The passthrough process, using the Direct Access Port, explained

The Passthrough Server is a software server component that runs on the SMP Gateway
platform. It accepts incoming TCP/IP connections on a predefined port called the Passthrough
Direct Access Port, and provides services to logically link those TCP/IP connections to the
targeted links. In doing so, the server establishes a “passthrough connection” to the target
device. While the PC application is communicating with the IED or RTU, the latter may have to
suspend its data acquisition; depending on the serial link and device type involved, it may be
necessary for all devices on the link to suspend their data acquisition, even though only one
device is engaged in communications with the PC application. This suspension is illustrated
using a red “X” in the previous figure.
Some host applications are designed to work specifically with the SMP Gateway passthrough
server. They know how to contact the server and how to use the command line interface
to access the remote devices. For these applications, refer to the Using the SMP Gateway
Passthrough Command Line Interface technical note, MN912069EN. This specific document
provides information on how to allow third parties to build terminal-based scripts or to develop
applications that can interact directly with the passthrough command line interface.

User Manual | page 218 Eaton


16 - Using Passthrough connections

16.1.2. Setting up passthrough connections


Setting up a passthrough connection involves a number of steps.
• Using SMP Config, you identify the devices that will be accessed through passthrough
connections. For each device, you provide information such as the SMP Gateway port
to be used for the passthrough connection, and the timeout after which the passthrough
connection is to be terminated after the last data exchange.
• Depending on the way you want to access the passthrough server, you either:
◦ In SMP Connect, you identify each application that will communicate with a device via a
passthrough connection. For each of these applications, you specify the type of loopback
connection to be established between SMP Connect and the application, and you define
the communication settings of the loopback connection.
◦ In SMP Config, under the Direct Access Port/Connection branch, set the direct access
port number, if you don’t want to use the default value. Then, specify the communication
settings to be used for the TCP/IP link between the host computer (NTV) and the SMP
Gateway passthrough direct access port.

16.1.2.1. Defining SMP Gateway passthrough settings


Using SMP Config, you can define the SMP Gateway passthrough settings for each IED that will
be using a passthrough connection.

To define the passthrough settings:

1. In the left pane, click Passthrough, and then click Connections.


Result:

2. Create a new connection by entering the following information in the empty row:
a. IED Name: This name will be used to identify the device in the SMP Connect program.
You should use the same name that you assigned to the device when configuring the
master protocol component that it communicates with.
b. Connection: Choose the serial port or the TCP/IP connection that links the SMP Gateway
to the configuration port of the device. Some devices use separate configuration and data
ports. If it is the case, you must use two separate cables to connect the device to the
SMP Gateway and specify here the port that will be used by the IED maintenance and/
or configuration programs; otherwise, the port must be the same as the one used by the
master protocol.

Note: Encrypted master TCP/IP connections cannot be used for passthrough, as


it is assumed that the NVT already encrypts communications if required by the IED.
To learn how to deactivate encryption for a given master connection, see Configuring
TCP/IP master connections (page 70).

Eaton User Manual | page 219


16 - Using Passthrough connections

c. Usage. This setting allows special passthrough usage, in configurations where multiple
simultaneous connections are required, or when the client application uses a protocol
that requires additional processing from the passthrough server. The following options are
available:
• Telnet: Select this value if the client application uses the Telnet protocol to
communicate with the IED.
• FTP: Select this value if the client application uses the FTP protocol to exchange files
with the IED.
• SMP Tools: Select this value to define a passthrough connection that will be used to
monitor the status and activity of another SMP Gateway, using the various SMP Tools
such as SMP Manager, SMP Trace and SMP Log.
• Web: Select this value if the client application is browser-based and uses a Web
browser to communicate with the IED.
• Normal: Select this value for standard passthrough usage.
• TFTP: Select this value if the client application uses the TFTP protocol to exchange
files with the IED.

Note: Only Normal usage is supported for serial passthrough connections.


Moreover, if the direct access port (DAP) is enabled on the SMP Gateway, it is not
possible to define passthrough connections for any other usage than Normal.

d. Connection Count: This setting indicates the number of simultaneous passthrough


connections that are required for the Usage specified. In most cases, the Default value
is appropriate for this setting, because the corresponding number of connections that will
be created by the passthrough server is function of that usage. However, if connectivity or
performance issues are encountered, try some specific values instead of Default.
e. Suspend Link: This setting indicates that data acquisition should be suspended for all
other devices sharing the multidrop link while the passthrough connection is active and
communicating with the selected device. If selected, acquisition of the remaining devices
will be suspended. This setting applies only to devices that support the feature.
f. Suspend IED: This device-specific setting indicates whether or not the master protocol
component should suspend data acquisition while the passthrough connection is active
and communicating with the device.
g. IED Address: This address identifies the device in a multidrop configuration. This setting
is ignored if the Suspend IED check box is not selected.
h. Modem Signals: This setting specifies whether or not the serial port associated with the
IED supports modem control signals. If selected, the DTR and RTS modem control signals
will be transferred across the passthrough connection. By default, modem control signals
are NOT transferred. The modem is not supported while using the Direct Access Port.
i. Locked at Startup: This setting is a security feature. If selected, the passthrough
connection will not be available when the SMP Gateway starts up. You can subsequently
make it available by enabling specific logical data points, as explained under Locking or
unlocking a passthrough connection (page 213).
j. Inactivity Timeout: This mandatory setting specifies how long the passthrough
connection link can remain inactive. If the program detects that no data exchange
occurred between the device and the application during the specified timeout period, it
prompts the user to either terminate the session or specify a longer wait time.

User Manual | page 220 Eaton


16 - Using Passthrough connections

k. Comments: This optional setting is used to store the instructions that will be displayed
to the SMP Connect operator, such as telling him which communication programs to use
with the device.

16.1.2.2. Installing a loopback cable, if necessary (SMP Connect)

There are 3 types of loopback connections that you can set up between the device
manufacturer’s maintenance or configuration application and SMP Connect:
• Virtual serial. This is the preferred choice.
• Real serial. You set up this type of connection only if the device manufacturer’s application
cannot use a virtual communications port.
• TCP/IP. You set up this type of connection only if the device manufacturer’s application uses
TCP/IP.

TCP/IP and virtual serial loopbacks do not require any further physical modifications to the
configuration.
To set up a real serial loopback connection:

1. Configure the device manufacturer’s application to use one of the PC serial ports, COM1 for
example.
2. Attach a null modem cable to this serial port.

Note: A null modem cable is an RS-232 cable that crosses the sending wire with the
receiving wire.

3. Instead of attaching the other end of the cable, to the device, attach it to a second serial port
of the same PC, for example COM2.

Note: Most modern PCs are equipped only with a single serial port. If virtual
communications ports are not supported by the application and the PC is only equipped
with a single serial port, a serial expansion card must be installed on the PC. If the PC
is equipped with a USB port, a USB to serial converter is an alternative to the serial
expansion card.

16.1.2.3. Setting up a list of applications and loopback connections (SMP


Connect)
SMP Connect communicates with the device manufacturer’s application via a loopback
connection.

There may be several applications running on the PC. You have to identify all the available
applications, and for each application that must remotely access a substation device, you have
to provide the following information:
• Specify whether the application is to be started manually, identify the path to the application,
and provide any arguments required by the program.

Eaton User Manual | page 221


16 - Using Passthrough connections

• Specify what type of loopback connection is to be used between SMP Connect and the
application, and define the communications settings of the loopback connection. Loopback
connection types are described in a previous section.

1. To start SMP Connect:


a. In SMP Manager, select your SMP Gateway.
b. From the Tools menu, choose SMP Connect. The SMP Connect application window
appears, showing a list of all the passthrough connections you previously configured with
SMP Config for this SMP Gateway.
Result:
The top portion of the screen shows the settings you entered in SMP Config, with
one additional piece of information: the Status column, which indicates whether a
passthrough connection is currently being used for a particular device. The bottom
portion of the screen shows a trace of passthrough connection events.

2. To access IED application and loopback settings:


a. Select the device in the top pane of the SMP Connect window.
b. From the Control menu, choose IED Application Settings.
Result:

3. Now, all the following steps are for adding an application to the list. In the IED Application
Settings dialog box, click Add.
4. In the dialog box that appears, type the application name and click OK.
5. Select the newly created application in the list.
6. Under Application Settings:

User Manual | page 222 Eaton


16 - Using Passthrough connections

a. Specify whether the application is to be started manually. If you select to start it manually,
then when you connect to the device, SMP Connect will start the passthrough and
loopback connections without starting the application; you will be able to start the
application manually.
b. The Close the application manually check box is used to specify whether the application
is to be closed manually. If the Google Chrome browser is used to connect to a Web
server, it frequently happens that the communication is cut off by Chrome. To avoid that
situation, select the Close the application manually option. When Internet Explorer is
used, the “-nomerge” switch is automatically added, thus avoiding the problem. The Close
the application manually option does not need to be checked. Other web browsers may
act the same way; in such cases, select the option to Close the application manually as
well. This will prevent the passthrough connection to be interrupted.
c. Type or browse for the complete path to the application executable file.
d. Type the command line arguments required by the application, if any (see the
manufacturer’s documentation).
7. Under Local Communication Settings:
a. Specify whether SMP Connect is to use a virtual serial loopback, a real serial loopback, or
a TCP/IP loopback connection to communicate with the NVT. Most manufacturers’ tools
use a serial (virtual or real) connection. However, if you are using a terminal emulator
program such as Microsoft HyperTerminal to communicate with the device, you can use a
TCP/IP loopback connection.
b. Click Configure to specify the loopback connection settings:
• The application port (serial only)
• The communications settings, such as parity, data bits, stop bits, flow control (serial
only).
• The SMP Connect port (real serial only).
• The logical port number for the TCP/IP connection; type the same TCP/IP port number
that you set in the device manufacturer’s tool or in the HyperTerminal program (TCP/IP
only).
• The logical port number for the TCP/IP connection; type the same TCP/IP port number
that you set in the device manufacturer’s tool or in the HyperTerminal program (TCP/IP
only).
• An indication whether your application uses the Telnet protocol, or not. Most terminal
applications using TCP/IP do use the Telnet protocol, so the check box is selected by
default (TCP/IP only).
8. Under Remote Communication Settings, Specify whether you want the passthrough server
to wait until the application first data transmission before initializing the connection between
the device and the SMP Gateway, or initialize it as soon as the application is started.

Note: You can also use the Apply base settings for arrow-button to apply default
base settings for some type of applications.

What to do next:
Repeat the previous steps for all applications. Make sure you click OK to save the settings and
close the IED Application Settings dialog box.

16.1.2.4. Setting up a TCP/IP passthrough connection for the Direct Access Port

Eaton User Manual | page 223


16 - Using Passthrough connections

To configure a TCP/IP passthrough connection for the Direct Access Port:

1. In the left pane of SMP Config, expand the Passthrough branch, the Direct Access Port
branch, and then select the General branch.
2. In the right pane, under General Parameter, Select Enabled.
3. In the left pane, select the Connection branch, enter the basic settings for the direct access
port’s TCP/IP connection:
a. In the Port Number cell, type the TCP port number that will be used to access the
passthrough feature using the direct access port. The default port number value is set to
32500.
b. In the Accessible From cell, select if the connection should be accessible from any
computer, from a specific computer or through a VPN (VPN Only (Firewalled)).
c. If you selected Specific Computer or Subnet for the Accessible from setting, type the
range of IP addresses that will be used by the host computer in the Specific Computer
or Subnet cell.

Note: The maximum number of address/subnet allowed is 32. CIDR notation


is supported (Classless Inter-Domain Routing), meaning that you can write
10.106.187.55/24 instead of 10.106.187.55/255.255.255.0. If you wish to specify an
address range (e.g: 10.106.186.128 to 10.106.188.128) you can use the online tool
to convert the range to a CIDR netmask list, to facilitate notation. Refer to https://
www.ipaddressguide.com/cidr for details and examples.

4. If you want the link between the host computer (NTV) and the SMP Gateway to be
encrypted:
a. In the SSL/TLS cell, select the supported version of the Transport Layer Security protocol
(formerly known as the Secure Sockets Layer protocol).
b. In the Cipher Suite Profiles cell, select the set of cryptographic algorithms that will be
used for this connection.

Note: The list of ciphers available in each profile can be found in the following
branch: Security\SSL/TLS\Cipher Suite Profiles.

c. In the Rekeying Delay cell, type the maximum amount of time, in minutes, the
terminal program will wait before renegotiating the session key with the SMP Gateway
passthrough server.
d. In the Rekeying TPDUs cell, type the maximum number of Transport Protocol Data Units
that the terminal program can receive before renegotiating the session key with the SMP
Gateway passthrough server.
e. In the Full Renegotiation Delay cell, type the maximum amount of time, in minutes, the
terminal program will wait before renegotiating the entire session with the SMP Gateway
passthrough server.
f. If the SMP Gateway passthrough server is not compliant with RFC 5746 - Transport Layer
Security (TLS) Renegotiation Indication Extension, select Allow Insecure Renegotiation.
5. If the terminal program on the host computer does not support SSL or TLS encryption:
a. In the SSL/TLS cell, select Disabled.

User Manual | page 224 Eaton


16 - Using Passthrough connections

b. In the Cipher Suite Profiles cell, select All Cipher Suites.

16.1.3. Connecting to the device


Once you have configured the passthrough server and the SMP Connect application and/or the
passthrough Direct Access Port, you are ready to establish a passthrough connection to the
device.

Note: Both SMP Connect and passthrough Direct Access Port can be used
simultaneously for the same device.

16.1.3.1. Using SMP connect


You are now ready to use the application the same way you would if you were connected to it
locally.

1. In SMP Connect, select the device in the device list.


2. From the Control menu, select Connect to IED.
3. In the IED Application Selection dialog box, choose the application /NVT that will
communicate with the device.
4. Click the Connect button.
Result:
If you requested that the application be started manually, the trace window will show that
SMP Connect has established the SMP Gateway passthrough connection and has started
the loopback connection with the application, but the application window will not open. Start
the application now.

You are now ready to use the application the same way you would if you were connected to it
locally.

Eaton User Manual | page 225


16 - Using Passthrough connections

16.1.3.2. Using the passthrough Direct Access Port

1. On the host computer, start a terminal emulator program (e.g., Telnet).


2. At the command prompt, write the OPEN command with the <IP address> or <name> of the
SMP Gateway and the <direct access port number>.
Example:
For example: > open 10.106.100.102 32500
If the connection succeeds, the following welcome message is displayed on the screen:
Welcome to the SMP’s passthrough server. Type Help if needed.
3. The application can then use the link but is not yet communicating with the target device; the
passthrough connection is still in “command mode”.
4. For information on how to use the passthrough command line interface, refer to the Using
the SMP Gateway Passthrough Command Line Interface technical note, MN912069EN. The
document also presents a list of all available commands in table format.

16.1.4. Testing the passthrough connection


Setting up a passthrough connection is usually a straightforward operation. When problems
occur, it is often because a device cannot communicate and perform data acquisition
simultaneously.
You may find the following guidelines useful in identifying and solving problems with
passthrough connections:
• Using SMP Config, check the Suspend IED setting for the selected passthrough connection.
If you modified the setting, remember to load the modified configuration and restart the
SMP Gateway.
• Using SMP Connect, check the message pane to see if the passthrough connection is being
activated correctly.
• Using SMP Trace, open the Master Protocols folder, and check whether the component is
receiving requests from the control center.
• Using SMP Trace, open the PassThruServer folder, and check whether any data is being
exchanged with the device.
• Using SMP Trace, open the Connections folder, and check whether any data is being
exchanged with the device.

User Manual | page 226 Eaton


16 - Using Passthrough connections

16.1.5. Deactivating the passthrough connection


A passthrough connection is automatically deactivated when the manufacturer’s application or
terminal application is closed. It can also be deactivated manually.

16.1.5.1. To manually deactivate a passthrough connection, using SMP Config

1. Click the device in the SMP Connect window.


2. From the Control menu, choose Disconnect from IED.
Result:
The SMP Connect trace window now shows that the passthrough connection is no longer
active.

16.1.5.2. To manually deactivate a passthrough connection, using the


passthrough Direct Access Port

1. To re-enter the command mode and release the connection with the IED device, type the
escape sequence recognized by the SMP Gateway passthrough server. The default escape
sequence is CTRL-Q.
2. To release the connection with the SMP Gateway passthrough server, type QUIT.

Note: In both cases, the passthrough connection is automatically deactivated if there


is no data exchanged on the link during the inactivity period for this particular passthrough
connection. The inactivity period is specified in SMP Config using the Inactivity Timeout
parameter.

16.1.6. Using the trace of passthrough connection events


The bottom portion of the SMP Connect application window is used to display passthrough
connection event messages. It is quite useful to identify and solve passthrough connection
problems.
It is quite useful to identify and solve passthrough connection problems. It can also be
configured to display all the data that is exchanged during a given passthrough session. The
whole trace can be printed or saved to a text file.

Eaton User Manual | page 227


16 - Using Passthrough connections

To display all exchanged data in the trace pane:


• Before establishing a passthrough connection, choose Detail Trace from the View menu.

To print the current content of the trace pane:


• From the View menu, choose Print Preview, if you want to get a preview of the printed
trace, or Print if you want to print it directly.

To save the current content of the trace pane to a file:


• From the View menu, choose Save As.
• In the Save As dialog box, select the directory where you want to save the file and type the
file name.
• Click Save.

To clear the contents of the trace pane:


• From the View menu, choose Clear Trace.

16.1.7. Changing how time information is displayed in


SMP Connect

To change how time information is displayed:

1. From the View menu, choose Time Display Options.


2. From the Time Display Options dialog box, select the type of display from the Time Display
Format drop box: you can choose between the local time (using the time zone settings of
the PC) and UTC. Normally, the clock of the SMP Gateway is set in UTC, but you can display
the information using the time format you like.

User Manual | page 228 Eaton


16 - Using Passthrough connections

16.2. The Proxy Passthrough feature


The Proxy Passthrough configuration and use is much simpler than the standard Passthrough
feature. The reason is that all the devices involved are SMP Gateways and SMP devices of the
SMP IO-2000 series; these devices are communicating with SMP Manager via the management
port (TCP 6650) allowing a simpler transparent connection process between the management
tool (SMP Manager) and the SMP devices.

16.2.1. Principle of operation


To setup a Proxy Passthrough for an SMP device behind an SMP Gateway, an “SMP Tools with
Proxy” passthrough connection must be added in the configuration file of the SMP Gateway.
Once the configuration file modified and sent to the SMP Gateway, the list of the SMP devices
setup to use the Proxy Passthrough is then communicated to SMP Manager by the SMP
Gateway. SMP Manager updates the list of devices accordingly, displaying the newly added
SMP device(s) in a parent/child configuration, with the SMP Gateway as the parent.
The SMP devices are then ready for Proxy Passthrough, meaning that the user can directly
start most of the SMP Tools on the child SMP device, update the firmware, send or get the
configuration file, etc.
There are a few restrictions to the use of Proxy Passthrough; however, remember that the
standard passthrough feature is still available for functions that are not permitted for the Proxy
Passthrough. The restrictions are the following:
• It is not possible to setup a redundancy group for child SMP Gateways
• Launching SMP Connect is not allowed on a child SMP device
• The Web HMI cannot be used on a child SMP device
• A single level of Proxy Passthrough is allowed; additional configuration of proxy levels will be
ignored

Important: No login is required to access the child SMP device using the Proxy
Passthrough so, it is strongly suggested to enable local security on the child SMP device.

Some specific features are associated to child SMP devices that are setup with Proxy
Passthrough on the SMP Manager list view. For the SMP devices for which the proxy
passthrough is setup:

• The IP Address column displays the IP address of the parent SMP Gateway with the prefix
“via” and enclosed in square parentheses. Example: [via 10.106.183.200]

Eaton User Manual | page 229


16 - Using Passthrough connections

• When starting SMP Manager, the child SMP devices are never polled automatically, the
option is grayed out in the SMP device propriety window.
• As soon as a child SMP device is added to the list in SMP Manager, automatic polling is
started on that SMP device, allowing to get the specific information like current status,
version, configuration file, etc. The polling will stop after five (5) minutes if no action is taken
from SMP Manager or Tools started on that child SMP device.
• Manual polling can be started/stopped at any time.
• The child SMP device are named according to the Proxy Passthrough IED Name of the
connection, without the suffix _ACCESSSERVER, when present.

Note: The _ACCESSSERVER suffix is added when the SMP devices are managed
by the IED Manager Suite application (IMS).

• When SMP Manager is in tree view mode, it is quite simple, the child SMP device is
displayed as a next level below the parent SMP Gateway. If the normal view is selected, the
name of the child SMP device is displayed following the standard rule for the flat display:
<group1, if any>\...\<Name of the parent SMP Gateway>\<Name of the child SMP device>

16.2.2. Setting up a Proxy Passthrough connection

The Proxy Passthrough connection uses the SMP Gateway management port (TCP 6650),
you will first have to define a master TCP/IP Master connection and then define a passthrough
connection which uses the previously created CP/IP Master connection.
To setup a Proxy Passthrough connection for an SMP device:

1. Select the SMP Gateway that will serve as parent in the Proxy Passthrough connection.
2. Open the SMP Gateway configuration file using SMP Config.
3. In SMP Config, navigate to the TCP/IP Master Connections Definition pane by selecting the
Connections > TCP/IP > Masters branch.
4. Define a connection for the child SMP device in an empty row:

a. In the Name box, type a significant name for the connection. you will reference this
connection by its name when associating it with the Proxy Passthrough connection that
will be used to connect to the child SMP device. It will also appear in traces, logs and
statistics.
b. In the IP Address cell, type the IP address of the child SMP device.
c. In the Port Number cell, type 6650.
d. Leave the SSL/TLS Protocols cell to Disabled and leave all the following security
settings to their default value, the Proxy Passthrough connection does not support
encryption.

Note: Do not forget to enable local security on the child SMP device.

5. In the left pane of SMP Config, navigate to the Passthrough > Connections branch, in the
Passthrough Connections pane:

User Manual | page 230 Eaton


16 - Using Passthrough connections

a. In the IED Name cell, type the name that will be used to identify the child SMP device
and add the _ACCESSSERVER suffix to the name if the SMP device is or is planned
to be managed by IMS. This name will be used by SMP Manager to identify the child
SMP device in the display list (without the _ACCESSSERVER suffix, if present).
b. In the Connection drop down list box, select the Master TCP/IP connection that you
previously configured for the Proxy Passthrough.
c. In the Usage drop down list box, select SMP Tools with Proxy.
d. Leave all other settings to their default values.
6. Save the file and send it to the SMP Gateway.
7. Restart the SMP Gateway when prompt to do so.

Eaton User Manual | page 231


17. Recording Sequence of Events
Sequence-of-events recorders (SERs) are widely used in the power industry. Some IEDs and
RTUs are dedicated SERs, while other devices implement the SER functionality as part of their
function set.
The SMP Gateway also provides a SER function, which allows the generation of events for IEDs
that do not support this feature.
This chapter describes how the SMP Gateway can generate events based on real-time
acquisition data, presents the format in which these events are available, and explains how to
configure this feature using SMP Config.

17.1. Events
The SMP Gateway SER generates events based on the real-time data it acquires from IEDs
and RTUs, notably through master protocols, when specific trigger conditions occur for selected
data points: these data points are called event data points.

17.1.1. Supported data point types


Event data points can be of the following types:
• Binary inputs
• Analog outputs
• Binary outputs

17.1.2. Trigger conditions


An event is generated when one of the following conditions occurs:
• The state (value) of an event binary input has changed.
• The quality of an event binary input has changed.
• A control operation was performed on an event analog output.
• A control operation was performed on an event binary output.

User Manual | page 232 Eaton


17 - Recording Sequence of Events

17.1.3. Quality flags


The quality flags used for events are slightly different than those used in RTDX for real-time
data.
Actually, they are a subset of the RTDX quality flags:
• Only the Good (OK) and Forced event quality flags have the same events meaning as
in RTDX.
• All other RTDX quality flags translate to the Suspect event quality flag.

For additional information about RTDX quality flags, see RTDX status flags (page 315).

17.2. Sequence-of-Events log entries


SMP Gateway events are made available to users through log entries. These entries are stored
in the Sequence of Events log, which can be viewed using SMP Log or SMP Gateway HMI
(Logs).
A new entry is added to the Sequence of Events log each time an event occurs. The event
timestamp, is displayed under the Date/Time column on the SMP Gateway HMI and under the
Time column on SMP Log. The timestamp correspond to the date and time at which the event
occurred.
The format of the entry depends on the type of the corresponding event data point, and can
be customized at configuration time, as described in the section Customizing the format of the
different Event log entries (page 234).

17.2.1. Additional entries


Additional entries are added to the Sequence of Events log when:
• the SMP Gateway restarts;
• the SMP Gateway internal clock is adjusted, which results in a time change.

17.2.2. Syslog entries


Entries stored in the Sequence of Events log can also be transmitted to a Syslog receiver.

17.3. Configuring the Sequence of Events recorders


(SER)
The SMP Gateway SER is a system component that is configured using SMP Config.
To set up the SER, you must:
• Activate the SER function.
• Customize the format of the event log entries for each point type.

Eaton User Manual | page 233


17 - Recording Sequence of Events

• Select the event data points.


• Define point-specific labels to be used in log entries, if necessary.
• Change how time information is displayed in the event entries, if necessary.

Each of these configuration steps is explained in details in the following sections.

17.3.1. Activating the SER


The SMP Gateway SER function is not active by default.

To activate the SER:

1. In SMP Manager, from the Tools menu, choose SMP Config to open it.
2. In the left pane of SMP Config, under the SMP Gateway name branch, expand the System
branch.
3. Select the Sequence of Events branch, and then select the General branch.
Result:

4. Put a checkmark in the Enabled cell.

17.3.2. Customizing the format of the different Event log entries


Event entries are formatted according to their corresponding data point type. Default entries are
provided, using keywords that allow insertion of event- or point-specific information at runtime.

The following table lists the various keywords that are available:

Note: Each keyword must be surrounded by brackets (ex. [LABEL]). As a result,


brackets are not allowed in event entries except for that usage.

Table 18 - Sequence of events recorder entry format keywords


Keyword Description

CONTROL (analog and binary control events The control operation that was performed, between the following:
only)
• Select
• Execute
• Direct Execute

CONTROLRESULT (analog and binary The result of the control operation that was performed. If the
control events only) operation failed, the cause is also displayed.

User Manual | page 234 Eaton


17 - Recording Sequence of Events

Keyword Description

CONTROLTYPE (binary control events only) The execution type of the control operation that was performed,
between the following:
• Open
• Close
• Pulse

CONTROLVALUE (analog control events The analog control value.


only)

LABEL This keyword can be used to insert context-sensitive text in the log
entries.
For each selected event data points, you can define labels that will be
inserted in the log entries depending on the current value of an input
point, or on the execution type of the control operation performed on
an output point:
• For binary events, two labels can be specified: one for state 0,
and another for state 1.
• For analog control operation events, a single label is used for all
operations, regardless of the value or execution type.
• For binary control operation events, three labels can be specified,
one for each execution type: Open, Close and Pulse.

For example, when a binary event occurs, the LABEL keyword is


replaced by the text of the State 0 Label or State 1 Label specified for
the corresponding point, if this keyword is present in the binary event
pre-formatted entry.
To learn how to specify these labels, see Defining point-specific
labels for Log entries (page 237).

POINTDESC The description of the event data point that triggered the event.
This is the same description that is specified for the point in the
corresponding master protocol configuration.

POINTNAME The name of the event data point that triggered the event.
This is the complete RTDX name of the point, with its device prefix.

QUALITY (binary events only) The quality of the event data point that triggered the event.
This is not the complete RTDX quality, but a simplified version of it,
as described in section Quality flags (page 233).

STATE (binary events only) The state (value) of the event data point that triggered the event.

The default entries will fulfill most user requirements, but can be customized if necessary.
To customize the format of event entries:

Eaton User Manual | page 235


17 - Recording Sequence of Events

1. Under the System/Sequence of Events branch, select the Event Entries Format branch.
Result:

2. Specify the row of the type of event that must be customized (Event Binary Inputs, Event
Analog Outputs or Event Binary Outputs).
3. In the Format cell, adjust the provided entry text as required, using plain text and the
aforementioned keywords.

17.3.3. Selecting event-generating data points


Events are generated when the value or quality of the event binary input points change, or when
control operations are performed on the event analog and binary output points.

Like for slave protocols, data points are selected by typing the point names one by one, or by
selecting them using the Subscribe To or Select Points commands.

1. To select event data points by typing their name:


a. Select the Event Binary Inputs, Event Analog Outputs or Event Binary Outputs branch.
b. In the first empty row, click in the Point Name cell.
Result:

c. Type the complete RTDX name of the point, including the device prefix.
d. Repeat these steps for each event data point.
2. To select event data points using the Subscribe To command:
a. Select the Sequence of Events branch.
b. From the Tools menu, choose Subscribe To.
c. In the Master I/O list, expand the branch of the component that produces the data points
to select.
d. Choose the data points. Use the CTRL and SHIFT keys on your keyboard to extend your
selection.
e. Repeat these steps for each component that produces data points to select.
3. To select event data points using the Select Points command:
a. Select the Event Binary Inputs, Event Analog Outputs or Event Binary Outputs branch.
b. In the first empty row, click in the Point Name cell.
c. From the Tools menu, choose Select Points.

User Manual | page 236 Eaton


17 - Recording Sequence of Events

d. In the Select Points window, expand the branch of the component that produces the data
points to select.
e. Click Paste.
f. Repeat these steps for each event data point.
g. Close the Select Points window.

17.3.4. Defining point-specific labels for Log entries


Labels are used to customize log entries with context-sensitive information.

For example, two labels can be specified for binary events: one for state 0, and another one
for state 1; if the LABEL keyword is found in the pre-formatted entry for binary event, it will be
replaced at runtime by the state 0 label when the corresponding binary input turns to 0, and by
the state 1 label when it turns to 1.
Labels are point-specific: they must be defined separately for each event data point.
For additional information about keywords and pre-formatted log entries, see Customizing the
format of the different Event log entries (page 234).
To define point-specific labels for log entries:

1. Select the Event Binary Inputs, Event Analog Outputs or Event Binary Outputs branch.
2. In the row of the event point to edit, click in the State 0 Label or State 1 Label cell (for event
binary inputs); in the Label cell (for event analog outputs); or in the Open Label, Close
Label or Pulse Label cell (for event binary outputs).
3. Type the text that will replace the LABEL keyword in the pre-formatted entry, for this event
data point.

17.3.5. Modifying triggering events conditions


It is possible to ignore the change in quality of a binary input’s event point when its state
remains unchanged.

This is used to avoid triggering an event based solely on an event point’s quality modification.
To ignore the quality of a binary input’s event point:

1. Select the Event Binary Inputs branch.


2. In the row of the event point, put a checkmark in the Ignore Quality box.

17.3.6. Changing how time information is displayed in log


entries
Event timestamps are stored in the UTC format and are usually displayed using this format in
the sequence-of-events log entries, under the Time column (not in the message itself).

It is possible to change the timestamp display format to local time, by specifying the time zone
and daylight saving time settings that are specific to the user’s locale.
To display timestamps in the local time format in log entries:

Eaton User Manual | page 237


17 - Recording Sequence of Events

1. Select the General branch.


2. In the Client Time Zone cell, select the time zone setting specific to your locale.
3. To have the SMP Gateway perform daylight saving time adjustments when required, put a
checkmark in the Auto Adjust DST cell.

17.4. Activating Syslog reporting of events


The sequence-of-events log entries can also be transmitted to a Syslog receiver.
To learn how to configure the SMP Gateway Syslog transmitter, see Setting up Syslog (page
241).

Note: Make sure the Sequence of Events log is enabled in the Facilities branch, and that
is set to the desired Facility code.

User Manual | page 238 Eaton


18. Automation
Because it is connected between the substation devices and the control centers, the
SMP Gateway is well positioned to implement advanced processing functions that would be
impossible to perform by less sophisticated devices.
The SMP Gateway provides the following automation capabilities:
• The SMP Gateway Automation Functions module, which add basic automation functions.
• The SoftPLC module and CODESYS development platform, which allow the creation of
sophisticated automation scripts, such as closing circuit breakers and load balancing.

18.1. The SMP Gateway Automation Functions


module
The SMP Gateway Automation Functions module is an optional software package designed to
extend the capabilities of existing devices by adding local automation capabilities similar to what
could be implemented using an external PLC.
For complete details on this module, including the configuration procedures and setting
references, refer to the SMP Gateway Automation Functions Reference Manual.

18.2. The SoftPLC module


The SoftPLC Module is an optional software module available on all models.
Using this module, you can create automation scripts that access the data points in the
SMP Gateway real-time database in order to create sophisticated control functions.
Since the SoftPLC module is part of the internal architecture of the SMP Gateway, the scripts
you define can be used to:
• create new logic data points, with values based on the result of calculations performed on
real data points;
• process data in real time before sending it to control centers;
• implement sophisticated local automation functions, such as automatic closing of circuit
breakers and load balancing.

The Soft PLC module is provided with the CODESYS development platform, a complete
development environment that supports the IEC 61131 programming languages:

• Instruction List (IL) • Function Block Diagram (FBD) • Ladder Diagram (LD)

• Structured Text (ST) • Continuous Function Chart (CFC) • Sequential Function Chart (SFC)

Eaton User Manual | page 239


18 - Automation

18.2.1. The CODESYS development environment


CODESYS is one of the most popular IEC 61131-3 programming systems for PLCs and
industrial controllers.
CODESYS supports the full range of standard IEC 61131-3 data types, as well as user-
defined data types: arrays, structures, enumerations, aliases and pointers. The tools provide a
comfortable programming environment, with full debugging support.
For complete details on using CODESYS to create scripts for the SMP Gateway SoftPLC
module, see the SMP Gateway SoftPLC Reference Manual.

User Manual | page 240 Eaton


19. Using Syslog with an SMP Gateway
Syslog is a method for delivering log information from a sender to a receiver, typically across an
IP network.
Normally used for computer system management and security auditing, Syslog is supported by
a wide variety of devices and receivers across multiple platforms.
Because of this, Syslog can be used to integrate log data from many different types of systems
into a central repository. It is then possible for the system administrator to dispatch these
messages to email or SMS systems, for example.
The SMP Gateway Syslog component uses the UDP or TCP protocol to send its log entries to
a single receiver. It is configured using SMP Config, and is active as soon as the SMP Gateway
starts up.
For an overview of the messages that an SMP Gateway may send to a Syslog receiver, launch
SMP Log and take a look at the various log files’ contents. To learn how to use SMP Log, see
Viewing log files (page 86).
The following section describes the few steps to follow to set up syslog on an SMP Gateway.

19.1. Setting up Syslog


Because it is based on the integrated log feature of the SMP Gateway, the Syslog feature is
easy to configure on an SMP Gateway.

Several Syslog instances are configurable in SMP Config, allowing the use of many Syslog
receivers. For each Syslog instance, the receiver of the Syslog messages must first be
specified. If needed, the facility qualifiers attached to messages can be customized to your
needs.
To enable and configure an SMP Gateway Syslog instance, proceed as follows:

1. In SMP Manager, from the Tools menu, choose SMP Config to open it.
2. In the left pane, under the SMP Gateway name branch, expand the System branch.
3. Select the Syslog branch, in the right pane, type the name of the new syslog instance at
the end of the list of names and click on a free space on the left pane. A check mark in the
Enabled cell is automatically added when an instance is created. The Syslog instance can
be disabled by removing the check mark.
4. In the left pane, under the newly created Syslog instance, select the General branch.
Result:

5. Specify the general settings of the Syslog transmitter:

Eaton User Manual | page 241


19 - Using Syslog with an SMP Gateway

a. (Optional) In the Hostname cell, type the value of the HOSTNAME field that will be used
by the SMP Gateway Syslog component for each Syslog message. If not specified, the
following identifier will be used: SMP<serial#> where <serial#> is the SMP Gateway
serial number.
b. In the Time Zone cell, select the time zone used by the receiver server.
c. If the server is configured for daylight saving time schedule adjustments, put a checkmark
in the Auto Adjust DST cell.
d. If the Syslog messages must be transmitted to an application or server that supports the
Common Event Format (CEF), such as ArcSight Logger, select ArcSight CEF in the
Message Format cell; otherwise, select RFC 5424 (new standard) or RFC 3164 (older
standard).
6. Select the Receiver branch.
Result:

7. Specify the settings of the intended recipient of all Syslog messages that will be issued by
the SMP Gateway:
a. In the IP Address cell, type the IP address of the message recipient.
b. By default, the SMP Gateway uses the UDP Syslog port number 514. To use a different
port number, such as the default TCP Syslog port number 601, type it in the Port Number
cell.
c. In the Connection Type cell, select the Syslog implementation to use between the
following: UDP or, TCP. Note that there are some differences in log transmission between
UDP and TCP.
• For an UDP connection, logs are transmitted only from the moment that the Syslog
component is started. Therefore, Startup logs and the cause of the last restart are
precisely lost. The source port must be specified in the Source Port Number cell. It is
recommended to use the port as the one specified in the Port Number cell.
• For a TCP connection, the index of the last transmitted log, for which it is assumed that
its destination was reached, is saved. This allows transmitting all logs, including the
Startup logs. Because the Syslog protocol does not use any backchannel mechanism
to convey information back to the sender, it is assumed that the message is received
according to the health status of the transmission link. Therefore, after a restart, a
number of logs are retransmitted because it could not be assumed that the message
was received. A delay can be configured in SMP Config to set the time to wait, in
seconds, for new log entries to become available before transmitting them in a single
TCP frame. Type the delay in the TCP Buffer Time cell.
d. If the recipient supports SSL or TLS encryption:
• In the SSL/TLS cell, select the supported version of the Transport Layer Security
protocol (formerly known as the Secure Sockets Layer protocol).
• In the Cipher Suite Profiles cell, select the set of cryptographic algorithms that will be
used for this connection.

Note: The list of ciphers available in each profile can be found in the Security
\SSL/TLS\Cipher Suite Profiles branch.

User Manual | page 242 Eaton


19 - Using Syslog with an SMP Gateway

e. If the device does not support SSL or TLS encryption:


• In the SSL/TLS cell, select Disabled.
• In the Cipher Suite Profiles cell, select All Cipher Suites.
f. Select the Facilities branch.
Result:

g. For each SMP Gateway Log File:


• In the Facility cell, specify the facility code that will be assigned to this log file’s entries
in syslog messages. The default settings, as illustrated above, should satisfy your
requirements.

Note: Facility codes are used to distinguish different classes of Syslog


messages. These codes are mainly useful for message classification.

• To transmit the log entries of the corresponding log file, clear the Disabled check box.

Eaton User Manual | page 243


20. Redundancy
The SMP Gateway is a critical component in a substation automation system. Hence, there are
circumstances in which losing an SMP Gateway can severely impact substation operations.
With the redundancy option, you can group two SMP Gateways together in a redundant
configuration.
The redundant SMP Gateways configuration ensures continued operation of the substation
automation system in the event of a failure. If one gateway fails or a failover condition is met, the
other one takes over. If one gateway fails or a failover condition is met, the other one takes over.
There are different types of redundancies, as IEDs, SMP Gateways and networks can be
redundant in many combinations.
Redundant SMP Gateways are addressed by a SCADA center as if they were a single
SMP Gateway with a single IP address. In the event that one SMP Gateway fails, the second
SMP Gateway immediately becomes active and takes ownership of the logical IP address.
Failover from the active SMP Gateway to the standby SMP Gateway typically takes less than
5 seconds. Network connections from the control center are temporarily lost when the active
gateway goes offline. The control center simply needs to reconnect to the same group IP
address in order to re-establish a new connection and restore system operation.
An additional benefit is that you can update SMP Gateway settings with minimum down time, by
updating the settings of the standby SMP Gateway, which will take over the other SMP Gateway
during its own update.

Note: The redundancy function is not available on the SMP 4/DP.

20.1. Redundant group operation


In an SMP Gateway redundancy group, one SMP Gateway plays an active role while the other
stands by.
The active gateway polls the substation devices and responds to requests from control centers.
The standby gateway initializes itself, places its serial links in a high-impedance state and waits
to become active.
The active SMP Gateway uses a special protocol to send regular heartbeat messages to
the standby SMP Gateway. If the standby SMP Gateway fails to receive these messages, it
automatically assumes that it should become active. Additional failover conditions can also be
defined for a better control of which SMP Gateway is to be active. Two distinct communications
channels are used for the heartbeat messages, to minimize the chances of both SMP Gateways
becoming active due to a single faulty connection. These channels can be LAN connections,
dedicated serial connections, or a mixture of both.
The two SMP Gateways in a group must have identical configurations and be physically
connected to the same substation devices.

User Manual | page 244 Eaton


20 - Redundancy

Note: The SMP Gateways of a redundancy group must have identical configuration files;
it is although possible to group different SMP SG-42xx platform’s models together. In such a
situation, the Hardware Type setting of the SMP SG-4260 must be set to SMP SG-4250 in
order for the redundancy configuration to work properly.

20.1.1. SMP Device A and B designation


You have to designate one SMP Gateway of the group as the SMP Device A (as the A unit of an
A-B protection scheme).
By default, the first SMP Gateway of the group is designated as SMP Device A.
The _smp___rsGatewayA system binary input indicates if this is the SMP Device A (or B).

Note: It is possible to give priority to SMP Device A, so it takes precedence over


SMP Device B. The SMP Device A will become active when there are no error conditions.
This setting will cause an additional failover when the SMP device A recovers from a fault.

20.1.2. Redundant IEDs


To improve reliability of their monitoring systems, utilities can use multiple protection IEDs to
monitor their breakers (also called “A-B protection”).
For this matter, they normally use IEDs from different manufacturers for maximum reliability: if
an IED malfunction is caused by a specific hardware or software design problem, chances are
good that the second IED will display the same erratic behavior.
This type of redundancy is called “IED redundancy”. It is achieved by configuring the
SMP Gateway to poll both IEDs simultaneously with two different masters, using the Best-of
automation function of the gateway to consider only data retrieved from one of the masters.
The following illustration presents a typical failover scenario in a redundant IED configuration.

Figure 15 - Using the “best of” automation function to support redundant IEDs

The use of the Best-of automation function implies the configuration of three data points for
the same information: one point for each master protocol, and a third point that is configured
to store the result of the automation function. The SCADA should be monitoring the third point,
which is called the “best-of point”. The value and quality of the best-of point is determined as
follow:

Eaton User Manual | page 245


20 - Redundancy

1. If the quality of the first data point evaluates to OK, then the value of this point is copied to
the best-of data point.
2. Otherwise, if any of the bad quality flags is raised for the first point (communication failure,
bad hardware, etc.) and the quality of the second point evaluates to OK, then the value of the
second point is copied to the best-of point.
3. If the quality of both data points is bad, the value and quality of the first point will be copied to
the best-of point.

IED redundancy using the best-of function of the SMP Gateway presents the following
characteristics:
• The best-of automation function can be used with any protocol. It requires the Automation
Function component to be a part of the SMP Gateway license.
• The two IEDs of a redundant pair can use different protocols. For example, the first
protection IED can use DNP3, while the second one uses IEC 60870-5-101, even if there are
slight differences in the data map.
• It is a point-by-point redundancy. This means that it allows for any failure in the acquisition
path, as the logic used to determine the quality and value of the data point is not based on
the current state of the communication link or on the availability state of the IEDs: it is the
responsibility of the automation function component, and it is based on the quality of the
source data points.
• Binary control or analog set points can also be mapped to best-of points. When a control
operation is performed on a best-of output point, it is applied to the first point for which the
quality evaluates to OK, starting with the preferred one (if any).

Note: When two redundant IEDs share the same data map and use the same protocol,
the preferred solution is to use a single master with redundant communication links. This
solution requires less configuration effort, because only one set of data points is required. In
comparison, the best-of solution requires 3 sets of data points: one for each master/IED and
the set of best-of data points.

20.2. Grouping 2 SMP Gateways for redundancy


Basic SMP Gateway redundancy consists of an active SMP Gateway and a standby
SMP Gateway. The active gateway is polling the devices and communicates with the control
center as if it was a stand-alone system.
The active and standby gateways are communicating with each other so that when the active
gateway fails, the standby one becomes active.
Both SMP Gateways share a public IP address to which the control center can connect. This
ensures that no special network configuration is needed at the control center; in fact, when the
control center connects to the public IP-address, it has no indication which gateway is active
and which one is on standby.
In the following example, SMP Gateways 10.2.15.1 and 10.2.15.2 are grouped under the public
IP address 10.2.15.3.

User Manual | page 246 Eaton


20 - Redundancy

Figure 16 - Typical failover scenario of an SMP Gateway redundancy group

You should know that:


• Each SMP Gateway has its own private IP address.
• Both SMP Gateways share a public IP address which is assigned to the active gateway.
• Basic failover condition is the detection of a hardware failure on the active SMP Gateway.
• The standby SMP Gateway can still be accessed by its private IP address for maintenance.
• It is possible to force a failover, as explained in section Forcing an active SMP Gateway to
fall on standby (page 249).

20.2.1. Prerequisites
Two SMP Gateways can be grouped together for redundancy if:
• The same version of the software (bootstrap, firmware and application) is installed on both
SMP Gateways;
• Both gateways have the same configuration

Note: The SMP Gateways of a redundancy group must have identical configuration
files; it is although possible to group different SMP SG-42xx platform’s models together.
In such a situation, the Hardware Type setting of the SMP SG-4260 must be set to SMP
SG-4250 in order for the redundancy configuration to work properly.

• The redundancy option is included in the license of both SMP Gateways.


• Both gateways are not already part of a redundancy group.

20.2.2. SMP Manager Redundancy column


The Redundancy column shows the current state of each SMP Gateway within a redundancy
group.
The second SMP Gateway is on hot standby if the data points of the IEDs connected to the
SMP Gateways have been configured for hot standby (for details, see section Hot Standby
(page 252)). There can be several intermediate states, such as “initial”, “listen” or “speak”,
while the grouping takes place. Thereafter, the following states may be displayed:

Eaton User Manual | page 247


20 - Redundancy

• Active: Indicates that this SMP Gateway is active. It communicates with the field devices and
sends “keep alive” messages at a frequency set through parameter settings. In the event of a
failover, it becomes the standby SMP Gateway.
• Standby: The Standby status is transitional; it indicates that this SMP Gateway is configured
to be the standby unit and is trying to reach the Hot Standby or Partial Hot Standby statuses
(if a problem occurs).
• Hot Standby: Indicates that this SMP Gateway is on hot standby. It listens for “keep
alive” messages from the active SMP Gateway. Moreover, the SMP Gateway device on
standby will display the Hot Standby status when the redundancy group has reached the full
synchronization status, which is defined according to the default redundancy functionalities
as well as to the hot standby configuration requirements set in SMP Config for the master
protocols, the slave protocols and other system components. See section Hot Standby (page
252), for more information about this particular redundancy feature.
• Partial Hot Standby: Indicates that this SMP Gateway is on hot standby (see above), but
that the SMP Gateways have different configuration files or that there are some real-time
data synchronization issues. The Redundancy logs may be helpful in searching the cause of
the synchronization problem.

When nothing is displayed, SMP Manager is not able to communicate with the SMP Gateway
for one of the following reasons:
• The SMP Gateway redundancy software is not running because you have not set its
redundancy parameters.
• The redundancy software has not been installed correctly on the SMP Gateway.
• The SMP Gateway is down.

This column may also advise you of exceptional situations, as described here:
• Peer: <Serial number>: Indicates that one SMP Gateway of the group is not present in the
SMP Device list of SMP Manager. To fix the problem, add the second gateway to the list. To
get the IP address of the missing SMP Gateway, select Redundancy à Group Properties
and take note of the IP address of the SMP Gateway marked as unlisted.
• Too Many SMPs: There are more than 2 SMP Gateways in this redundancy group. To fix the
problem, remove the excess SMP Gateways.
• Different parameters: The 2 SMP Gateways in this group do not have the same redundancy
settings. See below to learn how to fix this configuration problem.
• Peer IP: <Serial number>. => Not in redundancy. The Peer is in the SMP Device list,
but is not part of the redundancy group. This can happen if one of the 2 SMP Gateways in
the group lose its redundancy configuration. To fix the problem, ungroup the SMP Gateway
that is still in the redundancy group (see section Ungrouping SMP Gateways (page 250))
and regroup both gateways again.
• Virtual gateway (IP: nnn.nnn.nnn.nnn). You have added, to the SMP Device list, an
SMP Gateway with a virtual IP address you assigned as the public IP address of the
redundancy group. The address of the active gateway is indicated in parentheses.

The redundancy configuration of all SMP Devices in the list is retrieved cyclically. This
mechanism allows you to see the current redundancy state of all SMP Devices, on
SMP Manager’s main screen. Since the refresh cycle is relatively slow, the redundancy
configuration of a given SMP Gateway is automatically retrieved when the SMP Gateway is
added to the list, when it is restarted, and when one or more files are sent to it.
To refresh the redundancy state of all SMP Devices:

User Manual | page 248 Eaton


20 - Redundancy

• From the View menu, choose Refresh.

To update the parameters of grouped SMP Gateways having different parameters:


• Click one or both SMP Gateways.
• From the Redundancy menu, choose Group Properties.
• A warning message appears, telling you that SMP Manager will use the default redundancy
settings and asking you if you want to go on. If you reply in the affirmative, the Group
Properties dialog box appears and you can change the settings to your liking. When you
close the dialog box, both SMP Gateways will have the same settings.
• Restart both SMP Gateways to activate the parameters.

20.3. Managing redundancy

20.3.1. Forcing an active SMP Gateway to fall on standby

To force an active SMP Gateway to fall on standby:

1. Using SMP Manager, select the active SMP Gateway in the list.
2. From the Redundancy menu, choose Force Standby.

The selected SMP Gateway will enter standby mode, while the other SMP Gateway in the
group will enter active mode. This will happen only if the standby SMP Gateway is error free;
otherwise, nothing will change, the active device will stay active and the standby device will stay
on standby.

20.3.2. Additional failover conditions


It is possible to define additional failover conditions to have a better control of which
SMP Gateway is active.
The failover conditions are defined in the SysServerConfig.txt file and that file can be
uploaded to the SMP Gateway as any other file. In this file, 16 additional error conditions can
be defined which will force a failover. An example file was copied on your computer hard drive
during the SMP Tools’ installation, at the following location:
• In a 32-bit version of Windows: \Program Files\Cooper Power Systems\SMP Tools
\Version Pack\ [version number]\Documentation\Technical notes
• In a 64-bit version of Windows: \Program Files (x86)\Cooper Power Systems\SMP
Tools\Version Pack\ [version number]\Documentation\Technical notes

20.3.3. Modifying the redundancy settings of an existing group

To modify the redundancy settings of an existing group of SMP Gateways:

1. In the SMP Device list, select one or both SMP Gateways of the group.

Eaton User Manual | page 249


20 - Redundancy

2. From the Redundancy menu, choose Group Properties.


3. Modify the desired settings in the Group Properties dialog box.

20.3.4. Ungrouping SMP Gateways

To separate 2 SMP Gateways that had been grouped together for redundancy:

1. In the SMP Device list, select both SMP Gateways.


2. From the Redundancy menu, choose Ungroup SMP Gateways.

20.3.5. Testing and validating the configuration


SMP Manager displays the current state of both SMP Gateways in a redundancy group. You
can also use SMP Log and SMP Trace to display additional information.
Using SMP Log with both SMP Gateways:
• Verify in the Redundancy folder that one SMP Gateway is stated as active, and that the other
one is stated as “on standby”, waiting for a failover.

For each SMP Gateway, using SMP Stats:


• In the System folder, open the Redundancy folder to view additional redundancy information
and statuses.

20.3.6. Monitoring redundancy status


The GRP LED on the front panel of the SMP Gateway displays the redundancy status.
Refer to your specific SMP Gateway installation guide for details.

20.3.7. Testing a redundant network


Beside SMP Gateway redundancy, there is also the possibility to set up network redundancy.
In a network redundancy setup, the SMP Gateways and the control center can communicate
via either network. Next figure illustrates a typical redundant network configuration, where the
control center communicates with an SMP Gateway group through two subnets.

User Manual | page 250 Eaton


20 - Redundancy

Figure 17 - Typical failover scenarios in a redundant network configuration

Note: Setting up a redundant network is out of the scope of this document. However, the
following instructions describe how you can use the SMP Tools’ IP address switching feature
to test a redundant network configuration.

Normally, the control center accesses the primary network and switches to the secondary
network only if the primary network fails. You should therefore make sure the secondary
network is working properly. To do this, you need to switch to the secondary IP address of your
SMP Gateway, and then run SMP Log and SMP Trace.
To switch from the first IP address to the second IP address:
• In SMP Manager, from the Tools menu, choose Use Second Address.

Important: Note that the switch to the second IP address applies not only to the
SMP Device that is in the redundant network, but to all the devices in the list. From this point
on, if you launch any SMP Tools, console or the Web browser for any SMP Device, these
applications will use the second IP address.

To switch back to the first IP address:


• From the Tools menu, choose Use First Address.

Eaton User Manual | page 251


20 - Redundancy

Note that once a Tool has been launched, it never switches IP addresses regardless of how
many times you toggle the address selection. Address switching applies only to commands that
take place after you instruct SMP Manager to switch addresses.

20.4. Hot Standby


The SMP Gateway unit on standby will display the Hot Standby status when the redundancy
group has reached the full synchronization status.
The full synchronization status is defined according to the default redundancy functionalities
as well as to the hot standby configuration requirements set in SMP Config for the master
protocols, the slave protocols and other system components.
The following sections explain the hot standby configuration requirements that are user defined
in SMP Config. A table also explains the normal SMP Gateway standby functionalities that are
necessary for the standby unit to reach the Hot-Standby Status.

20.4.1. Setting the master protocol components for hot standby


One of the standby device’s configuration requirements that can be set in SMP Config is to
configure master protocol components on the standby SMP Gateway to maintain an up-to-date
image, as complete as it is possible, of the data on the active SMP Gateway.
This is achieved by selecting the “Hot-Standby Support” in the master protocol component’s
General branch. It is available for the most common master protocols.
Whenever a transition occurs on a hot-standby configured data point, the information is first
transmitted to the standby SMP Gateway, and then it’s updated in the real-time database of
the active SMP Gateway. During a failover, no transitions are lost, however events may be
duplicated. Using the Hot-Standby Support feature, integrity scans are not always required,
since the standby device’s data points are already synchronized, reducing the failover time
significantly
To configure a master protocol instance for Hot-Standby Support, refer to the specific protocol
manual found on the SMP Gateway Software & Tools CD-ROM .

Note: The GOOSE protocol does not support hot-standby. IEC61850 and
Interconnections protocols supports the hot-standby mode and also another mode, With
Link Test, which allows initializing the standby device and wait for the failover before starting
data acquisition. This way the failover process is faster because there is no need to wait after
the configuration validation or other initialization steps. However, the IED must be able to
support both SMP Gateway connections in parallel for this mode to work.

20.4.2. Setting the slave protocol components for hot standby


Another standby device’s configuration requirements that can be set in SMP Config is to
configure slave protocol components to be active anytime.

This feature allows taking full advantage of the hot standby capabilities. Points produced by the
slave protocol components are not synchronized, they are specific to each SMP Gateway (e.g.,
__linkActive system data point for the DNP3 protocol).

User Manual | page 252 Eaton


20 - Redundancy

To configure Hot-Standby Support for a slave protocol:

1. In SMP Config, select the General branch of the slave protocol instance.
2. In the Hot-Standby Support cell, Disabled should be checked. Instead, select the behavior
that is expected from the slave component, between the following:

Note: The Comm Status Recovery option is also available for the IEC 60870-5-101
slave protocol, to allow the protocol instance to start while the SMP Gateway is on
standby, but only to initialize the communication link: no acquisition or control operation
will be allowed by this instance until the SMP Gateway becomes active.

a. Acquisition: The slave protocol will receive data from its masters without accepting
control commands from the control center.
b. Acquisition and control: The slave protocol will receive data from its masters and it will
accept control commands from the control center. These commands will be forwarded to
the active SMP Gateway, which will forward the control commands to the devices.

The following illustration presents the acquisition data flow for an SMP Gateway redundancy
group that supports hot standby.

1. The active SMP Gateway receives data from the device.


2. The standby SMP Gateway is updated.
3. Data is sent to the control center by both SMP Gateways.

Figure 18 - Acquisition data flow in a hot standby redundancy SMP Gateway group

Note: The public IP address is always associated with the active SMP Gateway. When
the control center wants to connect to the standby SMP Gateway, it needs to use the
physical IP address.

Eaton User Manual | page 253


20 - Redundancy

20.4.3. Behavior of the active SMP Gateway


Once the redundancy group has reached the Hot Standby status, the active SMP Gateway is
fully operational and the standby unit is ready to become active.
The active SMP Gateway will resign if a local failover condition is in alarm and if the standby
SMP Gateway has no failover condition in alarm. The number of failover conditions is not
important, the absence or presence of at least one failover condition which is in alarm is the
decisive factor for the active unit resignation.
In a situation where the active SMP Gateway is restarted, the standby unit will become active,
independently from the current redundancy status (synchronizing, standby, hot standby or
partial hot standby); data points will be updated with the last synchronized information.
If the active and standby SMP Gateways are not able to communicate with each other, both
units become active at the same time until the communication between them is restored,
leading to the resignation of one unit. To minimize the risk of having such a situation, it is
important to keep fully operational both communication links between the redundant SMP
Gateways.
Refer to System data points (page 307) for details about available internal data points related
to the redundancy status.

20.4.4. Behavior of the standby SMP Gateway


The following table resumes the behavior of the standby SMP Gateway in a redundancy
configuration.
Table 19 - SMP Gateway Standby unit behavior
Functionality On standby unit Details

Syslog reporting of Running independently The SMP Gateway’s physical address is used for the communication.
events

SNMP server (Traps Running independently The SMP Gateway’s physical address is used for Traps transmission.
and SNMP browser) The physical or virtual addresses may be used to answer to polling
requests on the active SMP Gateway.

SNTP client Running independently The SMP Gateway’s physical address is used for requests.

SNTP server Running independently The SMP Gateway’s physical and virtual addresses may be used to
access the server.

PTP client Running independently The SMP Gateway’s physical address is used for requests.

User Manual | page 254 Eaton


20 - Redundancy

Functionality On standby unit Details

Automation Running independently By default, the Automation Functions application does not run on the
Functions but limited standby device; the points are synchronized between the active and
standby devices. It is however possible to force the application to run
also on the standby by using the Execute on standby setting in SMP
Config.
For the moment, only the Logical automation function and Logic
Processor expressions can run on the standby device. The generated
points can be used to run simple equations; for example, to define
additional failover conditions or to transmit additional statuses to
SCADA.

CODESYS No point CODESYS is running but the application is blocked by the


synchronization SMF_CANSTARTPLC function which is set to 0. The points stay at
zero and communication failure is set on the standby device.
No retain variables
synchronization

Inhibited and forced Synchronized with These points are related to Automation Functions or Visual T&D and
points active device are always synchronized between the active and standby devices.

Time Synchronized with The active SMP Gateway will synchronize the standby device if
synchronization active device the time difference between the two units becomes greater than 5
between the devices seconds, when no other time synchronization source is available.

IRIG-B time Running independently The IRIG-B distribution may be activated or not through configuration.
distribution For example, if the configuration setting for the IRIG-B distribution is
set to When started…, the standby device will not distribute the IRIG-
B signal because the device is not started.

System points Synchronized with In a redundancy configuration, most of the system data points are
synchronization active device specific to each SMP Gateway in the group and are not synchronized.
However, the following system data points are generated by the
active device and synchronized to the standby device:
Local Control:
• _smp___setLocalControl
• _smp___localControl

Passthrough:
• _smp___<connection>Enable
• _smp___<connection>Enabled
• _smp___<connection>InUse

Event retrieval No file synchronization After a failover, the new active SMP Gateway retrieves files that are
stored since its last file retrieval, when it was last active; the process
No file retrieved from
follows to the file retrieval usual rules. Consequently, files may be
standby
duplicated or lost.

Eaton User Manual | page 255


20 - Redundancy

Functionality On standby unit Details

Stats, Logs and Running independently All Stats, Logs and Traces are unique to both SMP Gateways. The
Traces information they provide may be incomplete or partial according
to the components’ startup situation. The Stats and Logs are also
accessible via the SMP Gateway HMI.

Sequence of event Running independently Runs with the available data, synchronized or not, according to the
(SOE) configuration.

Passthrough Not available Passthrough is not available on the standby device; SMP Connect
is unable to connect to the SMP Device because the server is not
started.

SMP Gateway HMI Running independently The SMP Gateway HMI alarm management is working independently
Alarm Management on both units of the redundancy group; no synchronization is
performed between the active and the standby devices, meaning that
acknowledged alarms from the active unit are not transferred to the
standby device. The Alarm log’s content is filled with the local SMP
Gateway information only.
Important: If the Activate Relay on Alarm option is selected in
SMP Config, do no close the relay on the standby device; wait until it
becomes active to close the relay, if necessary.

SMP Gateway HMI Running independently The web server is started and accessible on the standby device. The
Web server SMP Gateway HMI interface, local as well as remote, shows an icon
on the toolbar, indicating that the user is connected to the standby
device.

SMP Gateway HMI Command requests may The SMP Gateway HMI Commissioning Tool is running on the
Commissioning be synchronized standby device; simulated values are kept on each SMP device and
not synchronized. However, control requests performed from the
standby device are executed on the active or the standby device,
depending if the point is synchronized or not.

SMP Gateway Synchronized control The SMP Gateway HMI Diagrams and Device's Front Panels are
HMI Diagrams for related synchronized running on the standby device. Control is retransmitted to the active
and Device's Front points device for related points that are synchronized between the SMP
Panels devices. The behavior is similar to a slave set with Acquisition and
Control for its Hot Standby Support setting.

SMP Gateway HMI Running independently The Communication Dashboard displays the Connected status using
Communication the available information.
Dashboard

SMP Gateway HMI Running independently The System Dashboard displays the SMP Gateway system
System Dashboard information.

SMP Gateway Running independently The Redundancy Dashboard displays the SMP Gateway redundancy
HMI Redundancy information from the selected SMP Gateway’s perspective.
Dashboard

User Manual | page 256 Eaton


20 - Redundancy

Functionality On standby unit Details

SMP Gateway Running independently The web server is started and accessible on the standby unit.
REST API

If the full synchronization status is not reached, SMP Manager will display the Partial Hot
Standby status in the Redundancy column. In such a case, the user should consult the
Redundancy logs and search for the following entries:
• SMF Application -, HOT STANDBY FAILURE -> Configuration file (.par)
mismatch
• SMF Application -, HOT STANDBY FAILURE -> HMI file (.hmi) mismatch

20.4.5. Specific behavior or configuration related to a


redundancy configuration
In an SMP Gateway redundancy configuration, some system behaviors or configuration
modifications are different from a standalone SMP Gateway.
Following are some example of these differences:
• SMP Gateway Restart: In a Redundancy configuration, when a restart is requested by SMP
Manager, a full restart will always be performed, independently from the modified files.
• NIC Teaming configuration: In a redundancy configuration, adding or removing NIC
teaming if virtual addresses are associated to the interfaces is not possible. If NIC teaming
needs to be modified, virtual addresses must first be removed, in order to perform the
modification.
• Ethernet interface deactivation: In a redundancy configuration, deactivating an Ethernet
interface is not possible if a virtual address is associated to the it. To deactivate an Ethernet
interface, the associated virtual address must first be removed, in order to perform the
modification.

Eaton User Manual | page 257


20 - Redundancy

20.5. Teaming network adapters (NICs)


SMP Gateways from the SMP SG-42xx platform are equipped with at least two Network
Interface Cards (NICs). You can group both NICs for network fault tolerance.
This process is called NIC Teaming. Network adapters from the standard Ethernet module can
also be grouped together the same way on the SMP SG-42xx platform.
The SMP Gateway implementation of NIC Teaming cannot be used for load balancing. Its sole
purpose is for network fault tolerance: if one NIC fails, the network connection does not cease
and continues to operate on the other NIC.
Moreover, when using the Advanced Ethernet module (AEM), the SMP SG-42xx platform can
also implement PRP and HSR protocols for advanced network management, redundancy and
reliability.

Note: The AEM module also supports PTP for time synchronization of the SMP SG-42xx
platform. Note that PTP over HSR is not supported.

To learn how to configure your SMP Gateway for NIC Teaming, PRP and HSR, refer to the
SMP SG42xx Platform User Manual.

User Manual | page 258 Eaton


21. Setting up the SNMP Server
The SNMP server is an optional software module that allows the SMP Gateway to export
statistics using the SNMP (Simple Network Management Protocol) standard.

Note: The SMP Gateway software implements SNMPv1 and SNMPv2c.

The SMP Gateway SNMP agent publishes and supports both standard MIBs (management
information bases) that are supported by the Windows CE operating system and custom MIBs
that are supported by the SMP Gateway application. The agent supports extensive reading
capabilities as well as limited writing and trap capabilities.

21.1. SNMP Traps


SNMP traps are messages that are automatically sent to selected SNMP clients when specific,
unusual events occur. They are the text equivalent of alarms.
Traps are automatically sent to listening SNMP clients whenever:
• the SMP Gateway restarts;
• a communications link used by a master or slave protocol instance fails for more than 60
consecutive seconds (these traps are called link down traps);
• a communication link used by a master or slave protocol instance becomes active (these
traps are called link up traps).

In order to send traps, the SMP Gateway needs to know the IP addresses of the SNMP clients
that are listening on the network. You can enter a maximum of 32 SNMP client IP addresses
using the SNMP Manager console application.

Eaton User Manual | page 259


21 - Setting up the SNMP Server

21.2. Configuring the SNMP server


Before you begin:
The Simple Network Management Protocol (SNMP) V1 and V2 is available on the product but
sends information in plain text (including the community string); it is thus recommended to use
SNMP in read-only mode. If write mode is necessary, additional protections are recommended
(e.g.: restricting access to a local network, VPN tunnel when accessing remotely).

To configure the SNMP server:

1. Select the SMP Gateway in SMP Manager.


2. From the Tools menu, choose SMP Console. The SMP Console tool starts in a new console
window.
3. Type the following command: snmpmgr
Result:
SNMP manager lists all available commands, as shown next:
Table 20 - Available commands for SNMP Manager
\> snmpmgr

SNMP Manager

Available commands (case insensitive):

A Add a client.

R Remove a client.

L Display all clients.

M Modify the community membership of a client.

C Change a client description.

G Add a community.

D Remove a community.

B Display all communities and their permissions.

I Modify the permissions of a community.

T Modify the name of the system contact.

O Modify the location of the gateway on which the agent is


running

F List information on system contact and gateway location.

W Modify the firewall settings.

H Display the list of all commands.

User Manual | page 260 Eaton


21 - Setting up the SNMP Server

esc Abort the current operation.

Q Quit.

(H) Help, (Q) Quit

You can display the previous list any time, by using the H command.
4. You should specify the SNMP settings in the following order:
a. Add communities and their permissions.
b. Add a system contact.
c. Add a system location.
d. Add a number of clients and associate them to communities.

Any modifications you make will be effective the next time the SMP Gateway will restart.

Note: If the integrated firewall is enabled on the SMP Gateway, SNMP services must
be allowed through the firewall. To learn how to open ports and allow services through the
integrated firewall, see section Specifying firewall rules (page 203).

Eaton User Manual | page 261


22. Time adjustment
This chapter describes the different time adjustment features of the SMP Gateway.

22.1. Monitoring time information


The SMP Gateway offers multiple ways to monitor time information and statuses.
To monitor time information and statuses:
• Some system data points provide time information. They are all prefixed by _smp___clock
and are visible using the SMP Gateway Web server, the SMP Gateway HMI (see Viewing
data in real time (page 130)).

Note: For more information on system data points and an exhaustive list of time-
specific points, see System data points (page 307).

• Current date and time can also be seen in SMP Stats or in the SMP Gateway HMI, in the
Vital System Information folder, from the Internals folder located in the System folder.

Note: For more information on SMP Gateway statistics see Viewing communications
statistics in real time (page 97)

• SMP Gateway clock status is displayed on the gateway front panel, using the SYNC LED.
The Clock status is also displayed on the SMP Gateway HMI’s System Dashboard.

Note: For a complete description of the different states of the SYNC LED, refer to
the corresponding installation guide for the SMP 4/DP and the user manual for the SMP
SG-42xx platform; these manual are available on the SMP Gateway Software & Tools CD-
ROM.

• More precise time information can be seen in SMP Stats or in the SMP Gateway HMI, in the
Clock folder, which is located:
◦ under Internals > System folders ( SMP 4/DP)
◦ under the System folder (for the SMP SG-42xx platform )

Note: The way the SMP SG-42xx platform’s internal clock and time synchronization
operate is explained in detail in the following technical specification: SMP SG-42xx Platform
Clock Technical Specifications.

User Manual | page 262 Eaton


22 - Time adjustment

22.2. Setting the SMP Gateway internal clock


The SMP Gateway has a real-time clock installed, with battery backup. It is set once during the
installation. If the clock does not indicate accurate time or was not set right, you can change it
manually, using SMP Manager.

Note: If the SMP Gateway’s clock is satellite-synchronized (GNSS), or with any other
time synchronization source, setting time manually will not work.

To set the SMP Gateway clock using SMP Manager:

1. Start SMP Manager.


2. Select the SMP Gateway for which you want to adjust time.
3. From the SMP Device menu, choose Set Time.
Result:

4. Select whether the SMP Gateway clock will be set to UTC or Local Time.
5. If you selected Local Time, select the time zone to use for the time conversion. Select Apply
daylight saving time if needed.

Important: The SMP device timestamping architecture is based on the assumption


that the SMP device is set to UTC. Ensuring operational timestamping while not in UTC
requires a deep knowledge of the SMP device; this practice is not recommended. A
message will warn you if you select Local Time, to make sure that you are aware of the
consequences.

Result:
The time at which the clock will be set is displayed just above the buttons.

Note: Daylight saving time automatic adjustment is not supported by the


SMP device. If you use local time on your SMP device, you must manually adjust the
internal clock at every DST clock shift.

6. If date and time is as expected, click OK to set the SMP Gateway clock to this date and time.

Eaton User Manual | page 263


22 - Time adjustment

The SMP Gateway internal clock is not an atomic clock, which means that it drifts from actual
time. Over time, data timestamps become less accurate. Moreover, manual time adjustment
using SMP Manager displays an accuracy of ±1 second. Consequently, time adjustment via
a synchronization source is highly recommended for the SMP Gateway to provide accurate
timestamps.

22.3. Automatic clock adjustment


By configuring the SMP Gateway for automatic clock adjustment, you no longer have to worry
about internal clock drifting.
All I/O changes, logs, traces and other data provided by the SMP Gateway are time-tagged with
a greater degree of accuracy - typically one second or better.
There are five ways to adjust the internal clock automatically:
• Directly from a GNSS signal (satellite synchronization using GPS and/or GLONASS
constellation), if you have an SMP SG-4260 pre-installed with the satellite-synchronized
clock (GNSS) option. You must then have a GNSS antenna receiving the highly accurate
satellites signals.
• Directly from a PTP master clock. The PTP standard for a Precision Clock Synchronization
Protocol is briefly presented in section About GNSS, IRIG-B, SNTP and PTP (page 265).
The standard is available in the IEEE 1588-2008 document.
• Using a time synchronization source, such as an IRIG-B signal. It may come from another
GNSS antenna connected to another device that redistributes demodulated or modulated
IRIG-B. It may also come from another SMP SG-4260 equipped with the satellite-
synchronized (GNSS) clock option that distributes IRIG-B to your SMP Gateway.
• Directly from an SNTP server. SNTP stands for Simple Network Time Protocol, and is briefly
presented in section “About GNSS, IRIG-B and SNTP”, below.
• Using a SCADA protocol, such as DNP3.

Here is a list of the possible time adjustment solutions that are available for the different
SMP Gateway models:
Table 21 - Time adjustment solutions available for each platform
SMP Gateway Modulated Demodulated
Protocol SNTP v4 GNSS PTP
platform IRIG-B IRIG-B

SMP 4/DP √ √ - √ - -

G
SMP SG-42xx √ √ U √ (on the SMP AEM
SG-4260 only)

Legend: √ = Available, G = with the Satellite-synchronized clock (GNSS) option, U = with the
universal communication module, AEM = with the optional Advanced Ethernet Module

Note: Only one time adjustment solution should be implemented at a time for an
SMP Gateway.

User Manual | page 264 Eaton


22 - Time adjustment

These different solutions are presented in the next sections.

22.3.1. About GNSS, IRIG-B, SNTP and PTP


The Global Navigation Satellite System (GNSS) provides autonomous geo-spatial positioning
with global coverage; it includes GPS and GLONASS satellite constellations as well as many
other systems which are satellite-based navigation systems operated and maintained by
their respective country. GPS is operated by the U.S. Department of Defense (DoD) and
GLONASS is operated by the Russian Aerospace Defense Force. They both use a constellation
of satellites to calculate the exact position and altitude of receiver stations and provide time
signals.
The GPS constellation is composed of 24 satellites orbiting the earth in 11 hours and 58
minutes, on six different orbits. The GLONASS constellation is composed of 24 satellites
distributed over three orbital planes with eight evenly spaced satellites on each, orbiting the
earth in 11 hours and 15 minutes. The orbital height of the GLONASS satellites is about 1050
km lower that the GPS satellites.
For both systems separately, with the baseline satellite constellation, GNSS receivers with
a clear view of the sky, have a minimum of four satellites in view to provide accurate timing.
Typically, the receiver sees from six to eight satellites. GPS satellites orbit from 55° North to
55° South. Although the GPS signal covers the entire earth, satellite density is greater when
facing the Equator than the Poles. GLONASS satellites orbit at 64.8 degree inclination, its
use is especially suited for high latitudes (north or south) where getting a GPS signal can be
problematic.
When using both constellation systems simultaneously, in a combined mode, the performance
is improved, especially in areas with reduced visibility, as more satellites are visible in the non-
obstructed portion to the sky.
GNSS technology requires a very accurate synchronization source in order to calculate the
orbital position of the satellites and determine the position of the receiver. To ensure the
required level of accuracy, GNSS satellites are equipped with defined number of atomic clocks
(4 for GPS and 3 for GLONASS) that are kept in synchronization with the master clocks. These
are the U.S. Naval Observatory's Master Clock for the GPS constellation and the State Time
and Frequency Standard of Russia, UTC(SU), for the GLONASS constellation. Each satellite
continuously transmits its current position and a time code.
IRIG-B is a military standard of the Inter Range Instrumentation Group. The best known IRIG
standard is the IRIG Timecode standard used to timestamp video, film, telemetry, radar, and
other data collected at test ranges. The main difference between the codes that are classified in
letters from A to H is their bit rate, which varies between 1 pulse per second and ten thousand
pulses per second. The IRIG-B standard operates at 100 pulses per second.

Note: IRIG-B signals come in two flavors: demodulated and modulated. Demodulated
IRIG-B signals cannot be carried over long distances while the modulated IRIG-B can be
carried over distances larger than 350 meters (1000 feet) without degrading.

NTP stands for Network Time Protocol, and is a standard Internet protocol used to synchronize
the clocks of computers to a time reference. NTP was originally developed by Professor David
L. Mills of the University of Delaware. As a full implementation of the NTP protocol seemed too
complicated for many systems, a simplified version of the protocol was defined: SNTP(Simple
Network Time Protocol). SNTP is basically NTP minus certain internal algorithms that are not
required by all types of servers.

Eaton User Manual | page 265


22 - Time adjustment

Note: The SMP Gateway software implements SNTP version 4 (RFC 2030).

PTP stands for Precision Clock Synchronization Protocol, and is a standard protocol used to
synchronize the clocks of distributed systems to a time reference. To use PTP, the optional
Advanced Ethernet Module (AEM) must be installed on the SMP SG-42xx platform.

Note: The SMP Gateway software implements PTP version IEEE 1588-2008 in client
profile only (slave clock). This means that the SMP Gateway can be synchronized using PTP
but will not distribute PTP time synchronization.

22.3.2. Configuring the satellite-synchronized (GNSS) clock


option
The SMP SG-4260 satellite-synchronized (GNSS) clock option uses the time information
provided by the GNSS system (GPS and/or GLONASS constellations) to provide a highly
accurate time synchronization source for the substation.

Setting up the GNSS clock option is explained in detail in the Satellite-Synchronized clock
(GNSS) option - Installation Guide, which is included on the SMP Gateway Software & Tools
CD-ROM. The configuration instructions in SMP Config are included in this document as well.
To complete the GNSS clock option configuration, using SMP Config:

1. Under the System branch, select Time, and then select GNSS (GPS, GLONASS)
Synchronization.
2. In the Cable Length cell, type the total length, in meters, of the cable that links the
SMP Gateway to the GPS antenna. By default, a 25 m length is specified. Specifying a
precise cable length is essential to get the best accuracy possible during the synchronization
process.
3. The SMP SG-4260 allows selecting which satellite Constellation to use. A combined mode,
using both constellations is also possible.
4. The SMP SG-4260 also offers an Enabled check box for enabling or disabling the satellite-
synchronized clock (GNSS) option.

22.3.3. Using IRIG-B for internal clock adjustment


If your SMP Gateway supports IRIG-B and is not equipped with a satellite-synchronized clock
(GNSS) option, the preferred time adjustment solution is to use an IRIG-B time synchronization
source.
Setting up IRIG-B is described in the installation guide of your SMP Gateway, which is included
on the SMP Gateway Software & Tools CD-ROM.
If your IRIG-B source provides its time information as “local” time, instead of UTC, some
software configuration is required on the SMP Gateway, as the gateway internally uses UTC.
To learn how to set up IRIG-B synchronization for an SMP SG-42xx platform, refer to the
SMP SG-42xx Platform User Manual.

User Manual | page 266 Eaton


22 - Time adjustment

22.3.4. Setting up the SMP Gateway as an SNTP client


Another alternative is to configure the SMP Gateway as an STNP client.

To set up the SMP Gateway as an SNTP client:

1. Start SMP Config.


2. Under the System/Time branch, select SNTP Client.
Result:

3. Put a check mark in the Enabled check box.


4. Under Server Address, enter the SNTP server IP address or network name.
5. Type the refresh rate in the Refresh cell, which is the frequency, in minutes, at which the
SMP Gateway will connect to the SNTP server in order to be resynchronized.
6. Type the recovery refresh rate in the Recovery Refresh cell, which is the frequency, in
minutes, at which the SMP Gateway will retry to connect to the SNTP server following a
connection failure. This value must be smaller than the normal refresh rate.
7. Type the value allowed in the Maximum Time Variance cell, which is the maximum time
difference allowed, in minutes, between the new time provided by the server and the
actual time of the SMP Gateway. If the difference is larger, the time update is ignored; this
mechanism prevents the use of an invalid time synchronization source.

Note: Specify a Maximum Time Variance of 0 to allow SMP Gateway clock


synchronization with an SNTP server without any consideration to the time difference
between both clocks.

22.3.5. Setting up the SMP Gateway as a PTP client


Before you begin:
It is strongly advised to consult the IEEE-1588 specification or another publicly available source
of information on the subject to learn more about PTP client settings.

To set up the SMP Gateway as a PTP client:

1. Start SMP Config.


2. Under the System/Time branch, select PTPv2 (IEEE-1588).

Note: The PTPv2 (IEEE-1588) branch is only available if at least one AEM module
is configured in the Hardware/Configuration branch of SMP Config.

Result:

Eaton User Manual | page 267


22 - Time adjustment

3. Select the Enabled check box for each port of the installed AEM module. Note that PTP
synchronization is available on ports 1 and 3 of each AEM module. If NIC teaming is used on
the AEM module, it depends on the configuration:
• If NIC teaming is used over PRP, then port 1/2 or port 3/4 are used in pairs and the
redundancy is automatically managed.

Note: PTP over HSR is not supported.

• If Standard NIC teaming is used, a PTP master clock must be available on each
redundant network to provide reliable synchronization.
4. Under Profile, select the PTP master clock you will use, your choices are:
• Power Systems Profile IEEE/IEC 61850-9-3:2016 (Default)
• Default Ethernet 802.3 IEEE 1588-2008
• Legacy Power Systems Profile (IEEE C37.238:2011)
5. Under Clock Domain, type the clock domain number of the PTP master clock that is
selected as the time source. The accepted range is between 0 and 127, Default = 0.
6. Under Path Delay Mechanism, select the delay mechanism used by the selected PTP
master clock. This setting compensates for the communication path delay between the
master clock (time source) and the device being synchronized (slave), your choices are:
• P2P (Default): Peer-to-peer

Note: P2P must be selected for the Power Systems Profile IEEE/IEC
61850-9-3:2016

• E2E: End-to-end
7. Check the VLAN Enabled box if the PTP master clock uses VLAN tagging.
8. Under VLAN ID, if VLAN Enabled is checked, type the VLAN ID used by the PTP master
clock. The VLAN ID setting sets the priority of the message traffic. The accepted range is
between 0 and 4094, Default = 0 (disabled).
9. Under 802.1Q Priority, if VLAN Enabled is checked, type the 802.1Q Priority setting used
be the PTP master clock. The 802.1Q Priority setting specifies the VLAN to which the frame
belongs, the priority bits define the processing priority of the frames. The accepted range is
between 0 and 7, Default = 4.
10. In the Note cell, enter any comment pertinent to your configuration (optional).

22.3.6. Using the time adjustment feature of a SCADA protocol


When no time synchronization source is available to the SMP Gateway, the SCADA or
control center can itself serves as a time synchronization source, if the protocol it uses to
communicates with the gateway supports synchronization.
DNP3 and IEC 60870-5-104 are such protocols.

User Manual | page 268 Eaton


22 - Time adjustment

As each protocol has its own distinctive characteristics, refer to the protocol documentation
found on the SMP Gateway Software & Tools CD-ROM to learn how to enable this protocol-
specific feature.

22.4. Using the SMP Gateway as a time


synchronization source
When the SMP Gateway is synchronized by an accurate time synchronization source such as
an IRIG-B source or a satellite-synchronization (GNSS) source, it can distribute accurate time to
substation devices in one of the following ways:
• Through a modulated or demodulated IRIG-B signal.
• By acting as an SNTP server; the SMP Gateway software implements version 4 of the SNTP
protocol (RFC 2030).
• Using a master protocol, such as DNP3, IEC 60870-5-101 or IEC 60870-5-104. The
accuracy may be limited by the protocol, but the overall synchronization of all the devices is
typically accurate to within one second.

A slight delay may be introduced in the time information transmitted to devices. Output time
accuracy is function of the type of time input used to adjust the SMP Gateway internal clock,
and of the type of protocol or signal used to synchronize the devices. The resulting delays is
presented in the following table.
Table 22 - SMP SG-42xx platform time distribution delays
Output Delay Accuracy (± ms)

Protocol SNTP v4 Modulated Demodulated


Output Output IRIG-B Output IRIG-B Output

Protocol Input < 100 < 100 N/A < 100

SNTP Input < 100 < 100 N/A < 100

Modulated IRIG-B Input < 10 < 10 N/A <1

Demodulated IRIG-B Input <1 <1 N/A <1

GNSS Input
N/A N/A N/A <1
(GPS & GLONASS)

PTP N/A N/A N/A <1

For example, if the SMP SG-42xx platform is time-adjusted using demodulated IRIG-B, a
device clock adjusted by the gateway using demodulated IRIG-B will show a delay smaller than
1 millisecond. Note that SMP Gateways can be more accurate: consider these values as “worst
case scenarios”.
Also, the SMP Gateway does not perform accurate time-tagging when I/O changes are received
from a device, because the transmission delay is unpredictable. For the time tag to be accurate,
the device must time-tag the I/O changes itself.

Eaton User Manual | page 269


22 - Time adjustment

The following sections present the various time distribution features of the SMP Gateway.

22.4.1. Configuring IRIG-B time distribution


IRIG-B time distribution is the ability, for an SMP Gateway, to distribute time adjustment
information to various devices using IRIG-B signals.

Unlike using SNTP or the time adjustment feature of a master protocol, IRIG-B time distribution
requires the SMP Gateway to be time-adjusted by a reliable source such as an IRIG-B signal or
by a satellite-synchronized GNSS time source signal.
Setting up IRIG-B is described in the installation guide of your SMP Gateway, which is included
on the SMP Gateway Software & Tools CD-ROM.
Some additional configuration may be required, using SMP Config.

Note: To learn how to set up IRIG-B distribution for an SMP SG42xx platform, refer to
the SMP SG-42xx Platform User Manual.

To specify the availability of the IRIG-B output signal:

1. Under the System branch, expand the Time branch, and then select the IRIG-B
Distribution branch.
Result:

2. In the Distribution Conditions cell, select the condition under which the IRIG-B signal will
be distributed.

Note: If the SMP Gateway is part of a redundancy group and you select one of the
conditions starting with "When started...", IRIG-B distribution will not be activated when
the SMP Gateway is on standby.

3. Unless you selected When started, forward input signal or At system boot, forward
input signal for the Distribution Conditions setting, you must specify additional settings
about the IRIG-B signal that will be distributed by the SMP Gateway:
a. In the Format cell, select the IRIG-B format to which the SMP Gateway system clock
information should be converted.
b. Specify the Output Signal Voltage in the corresponding cell.
c. In the Time Zone cell, select the time zone to use for the IRIG-B output signal; essentially,
it should be the time zone of the area where your substation is located.

Note: If the IRIG-B signal must be distributed in the UTC format, select the GMT
time zone.

d. If required, select Auto Adjust DST to update the IRIG-B output signal for daylight
savings.

User Manual | page 270 Eaton


22 - Time adjustment

22.4.2. Setting up the SMP Gateway to act as an SNTP server


If some devices can be configured as SNTP clients, the SMP Gateway can itself be configured
to act as an SNTP server for these devices.

Note: To configure the devices as SNTP clients, refer to the user manual of each device.

To set up the SMP Gateway as an SNTP server:

1. Start SMP Config.


2. Under the System branch, select SNTP Server
Result:

3. Put a check mark in the Enabled check box.


4. Select from the Accessible From drop down list whether it will be accessible from any
computer or a specific one through the SMP Gateway integrated firewall.
5. If you selected Specific computer or subnet in the Accessible From cell, type an address or
an address range in the last cell.

Note: The maximum number of address/subnet allowed is 32. CIDR notation


is supported (Classless Inter-Domain Routing), meaning that you can write
10.106.187.55/24 instead of 10.106.187.55/255.255.255.0. If you wish to specify an
address range (e.g: 10.106.186.128 to 10.106.188.128) you can use the online tool
to convert the range to a CIDR netmask list, to facilitate notation. Refer to https://
www.ipaddressguide.com/cidr for details and examples.

22.4.3. Adjusting devices clocks using master protocols


Some devices may not be able to retrieve information from an STNP server or an IRIG-B time
synchronization source. However, if the communications protocols used by the SMP Gateway to
communicate with these devices support some sort of time adjustment/synchronization feature,
it can be used to adjust these devices’ clock.
As each protocol has its own distinctive characteristics, refer to the protocol documentation
found on the SMP Gateway Software and Tools CD-ROM to learn how to enable this protocol-
specific feature.

Eaton User Manual | page 271


23. The SMP REST API
The SMP REST API interface follows REST principles and provides programmatic access to the
SMP Gateway; this access can be used to manage and/or obtain information about the SMP
Gateway through different services.
The SMP REST API requires user authentication; username and password from the SMP
Gateway; local security database must be provided.
The interface supports up to sixteen concurrent sessions and privileges linked to the current
session determine the user access to the different services. The Monitoring privilege is
required to access the API and all API services; other privileges may be additionally be required
to access certain services.
The SMP REST API is related to a specific software version since it evolves with time; backward
compatibility is fully supported. To ensure that a new interface does not conflict with current
URIs present on the device, a prefix (api) is added to the management interface.

Note: The SMP REST API uses port 443 to communicate with the SMP Gateway. The
SMP Gateway HMI uses the same port. If the All Features Activation parameter for the
SMP Gateway HMI is set to Disabled, the SMP Gateway HMI is not accessible; the SMP
REST API is, however still available. To have the SMP REST API made inaccessible, port
443 must be deactivated by removing the check mark in the Allow cell for the Secure Web
Server (SMP Config > Security > Firewall > Rules).

23.1. REST architecture, the basics


REST architecture is built on a set of design principles to define web service Application
Program Interfaces (APIs). A REST API service allows its user to obtain information and to
manipulate resources.
Each resource is addressed using a Uniform Resource Identifier (URI); this URI usually allows
the user to unambiguously identify the resource type and the resource itself. Resources are
handled using standard HTTP methods, for example, POST, GET, PUT and DELETE.
Usually, a resource has two addressing levels:
• A level representing a collection of resources
• A level representing unique resources

Depending on the resource, standard HTTP methods allow to interact with the web service. The
following table shows typical actions allowed for each method:

User Manual | page 272 Eaton


23 - The SMP REST API

Table 23 - REST API, actions depending on Resources


Resource GET PUT POST DELETE

Collection of Obtain the list of Replace the whole Create a new Delete the whole
resources identifiers in the resource collection resource in the collection
collection with a new one collection. An
identifier will be
assigned by the
server

Unique resource Obtain details about Replace the resource Seldom used, treat Delete the unique
a resource the resource as a resource from the
collection in its own collection
right and creates a
new entry within it

The web interface requires the use of HTTP, as do most REST service implementations.
Moreover, the HTTP protocol is used through a TLS tunnel. HTTP over TLS is more commonly
known as HTTP Secure or HTTPS. This type of secure connection allows data encryption to
ensure confidentiality and integrity while in transit. It also allows the client to authenticate the
web server using a certificate, to ensure it interacts with a legitimate service.
When accessing a resource, either reading or writing, some information must be transferred
on the link. Using REST architecture, this information does not have a predefined format; it is
only inserted in the body of the HTTP request or response. For the management interface, data
in the body is structured using JSON (Java Script Object Notation). By default, the standard
way to include data in JSON is using a UTF-8 encoding. This is the only Character Encoding
supported.
In large collections of resources, or when a specific resource identifier is required, it is possible
to scope a GET request on a collection of resources to a specific subset. To do so, query
parameters have to be passed in the URI. The resource attribute on which the client wishes to
perform a search is used as the parameter key and the search value is used as the parameter
value. If more than one attribute are researched, they have to be separated with an ampersand
(&).

23.2. The SMP REST API interface


The SMP REST API interface is intended for programmers who understand the fundamental
principles of the REST Architecture and the basics of the SMP Gateway functionality.
Clients must authenticate to the server to access its resources. In order to authenticate
clients, the interface contains session objects. Since the HTTPS protocol does not necessarily
use persistent connections (i.e. the connections can be closed and re-opened between two
requests), a session identifier is used to avoid re-validating user authentication upon each
request. This session identifier will also help future protocol extension; thus allowing for easier
transactions support.
To simplify the usage of the REST API, we provide an offline software development kit (SDK).
This is the preferred way to access the SMP Gateway by applications and scripts. It is also
possible to access the API directly.

Eaton User Manual | page 273


23 - The SMP REST API

23.3. Getting started with the REST API


The interface is categorized into functional groups. Each main service included in the SMP
REST API is introduced with a brief description of its services, including the privileges required
to use the SMP REST API services.
You can find the information on the installation CD, in the Help/index.html file located in
SMP_API_SDK.zip.

23.4. Getting started with the SDK


Starting from the SMP Gateway version 7.2, an SMP REST API documentation kit, condensed
in a SMP_API_SDK.zip file is supplied on the CD ROM with the Software version. A most recent
version of this SMP_API_SDK.zip file is also available for download from Eaton’s EAS customer
web site, using valid credentials. If required, contact the support team for details.

23.4.1. Application examples through sample files


The .zip file contains the SMP REST API offline interface access (SDK) with basic examples
and documentation, DotNet detailed application Sample files to provide programmatic guidance
and the following .dll files:
• Gateway.Api.Client.Net.dll: allowing to interface the SMP REST API using the SDK DotNet
modules
• Newtonsfot.Json.dll:.dll file that is a dependent file of the Gateway.Api.Client.Net.dll
• RestSharp.dll: .dll file that is a dependent file of the Gateway.Api.Client.Net.dll

Python modules are also available however, no application Samples are distributed for the
moment.
The following table introduces the available DotNet Samples contained in the .zip file. These
Sample files are complete application examples and they provide guidance for the programmer
to write applications that are suited for its needs.
Table 24 - DotNet Samples description
Sample Description

Gateway.Api.Sample.Commissioning Generate a window used to activate Commissioning on an


SMP Gateway. Once the commissioning is activated, the user
can start a commissioning session, select instances and the
behavior for each instance and finally display and simulate the
value or state of a data point that belongs to a specific instance.

Gateway.Api.Sample.Files.List Opens a command line window used to list files located in


a remote folder. The path for this folder must be provided;
otherwise the remote root directory will be listed.

User Manual | page 274 Eaton


23 - The SMP REST API

Sample Description

Gateway.Api.Sample.Files.Download Opens a command line window used to download files from a


remote folder to a local folder. The path for both folders must be
provided.

Gateway.Api.Sample.Files.SmpFTP Opens a command line window used for FTP file transfer.

Gateway.Api.Sample.Files.Sync Opens a command line window used to download files that were
either modified or added, since the last download, to a specified
folder.

Gateway.Api.Sample.ListPoints Opens a command line window used to list all data points
belonging to the SMP Gateway. The list displays the data points
ID, Name and Value.

Gateway.Api.Sample.NamePlate Generate a window used to get the nameplate informations V1


from an SMP Gateway. The code may be modified (changing
V1 for V2 in the NameplateForm.cs file) in order to get the
nameplate information V2 from an SMP Gateway.

Gateway.Api.Sample.ReadPoint Generate a window used to get all data points with or without
the details related to each point. A filter pane can be used to
specify specific data point names or IDs that the user wants to
get.

Gateway.Api.Sample.SetPoint Generate a window used to perform a control operation on a


data point.

Gateway.Api.Sample.ShowSecurity Generate a window used to get the SMP Gateway security


settings.

Eaton User Manual | page 275


24. SMP Tools remote access to the
SMP Gateway
You may want the SMP Tools to connect to an SMP Gateway that is not itself connected to your
network.
You would typically do this by setting up a dial-up connection and using a modem to call the
SMP Gateway from your PC running Windows. Less typically, you might choose to access the
SMP Gateway by setting up a direct serial connection between a serial port on your PC and a
serial port or the CONSOLE port on the SMP Gateway from your PC running Windows.
This section explains how to setup dial-up and direct serial connections between a personal
computer and an SMP Gateway.

24.1. Setting up a dial-up (Modem) connection


This section contains the procedure for setting up a dial-up (modem) connection between a PC
running Windows, and an SMP Gateway.
Before you begin:
If security features are activated on your SMP Gateway, you must first make sure your computer
is authorized to access the SMP Gateway and that you selected the Remote Access privilege
for the Guests group in the Local Security Database Security Editor, accessible from the
Security menu of SMP Manager (see Accessing the local security database editor (page 197)).

To set up a dial-up (modem) connection:

1. Set up the SMP Gateway to accept a dial-up connection


a. Start SMP Manager. Select the SMP Gateway to be configured and from the File menu,
choose Properties. In the SMP Device Properties dialog box, clear the Automatically Poll
SMP Status at startup check box. This will prevent polling on the dial up connection
b. From the Tools menu, choose SMP Console.
c. Type RASMGR to start the RAS Manager application.
d. Type L, to display the device list. The device list is actually the list of ports available on the
SMP Gateway, including the CONSOLE port.
e. Type M, to modify the SMP Gateway COM port you intend to use for the dial-up
connection.
f. Type the number of the “MODEM device” to be modified. Note that you cannot specify the
number of the CONSOLE port, as the latter does not support modem connections.

User Manual | page 276 Eaton


24 - SMP Tools remote access to the SMP Gateway

g. All the default settings should be correct, except for the last one: Use device for incoming
connections. Type Y to allow incoming connections on the port and exit RASMGR.
h. Press Q to exit RAS Manager, and then close the console window.
2. Install the modem, if necessary
a. From Windows’ Start menu, access the Control Panel.
b. Click Hardware and sound.
c. Click Device Manager.
d. Click Continue.
e. Click on the name of your PC in the tree views.
f. Click the Action menu then scan for hardware changes.
Result:
If the modem is supported by Windows, it will configure itself. If this does not work,
consult the modem’s manufacturer manual.
3. Set up a new dial-up (modem) connection for the SMP Gateway. Perform these steps for
each SMP Gateway with which you want to communicate via modem (for Windows 8.1).

Note: For Windows 10, Windows Server 2012 R2, refer to instructions provided by
Microsoft.

a. From Windows’ Start menu, access the Control Panel.


b. Click Network and Internet.
c. Click Network and Sharing Center.
d. Click Set up a connection or network.
e. In the Wizard dialog box, select Set up a dial-up connection then click Next.
f. If you have only one modem, skip this point. Click on the modem you wish to use to
connect.
g. Type the phone number you will dial to connect to the SMP Gateway and a useful name
then click Connect. Windows will try to connect to the device for real.
h. During the connection attempt, click Skip.
i. Click Set up the connection anyway.
j. Click Finish.
k. Click Manage network connections.
l. Right-click the Dial-up Connection just created and select Rename. Write a useful name
then press Return.
m. Right-click the Dial-up Connection just created and select Properties.
n. From the General tab, select the modem you want to use for this connection and click
Configure.
o. In the Modem Configuration dialog box, select the Enable hardware flow control check
box, the Enable modem error control check box and the Enable modem compression
check box. Then press OK.
p. Click the Options tab, and then click PPP Settings.
q. In the PPP Settings dialog box, select the Enable LCP extensions check box and the
Enable software compression check box. Clear the Negotiate multi-link for single link
connections check box. Click OK.
r. Click the Networking tab.

Eaton User Manual | page 277


24 - SMP Tools remote access to the SMP Gateway

s. Under This connection uses the following items, clear the Client for Microsoft
Networks check box.
t. Click Internet Protocol Version 4 (TCP/IPv4), and click Properties.
u. In the Internet Protocol Version 4 (TCP/IPv4) Properties dialog box, click Advanced.
v. In the Advanced TCP/IP Settings dialog box, clear the Use default gateway on remote
network check box and the Use IP header compression check box and click OK three
times.
4. Configure SMP Manager to communicate with the SMP Gateway

Note: Note that even if you set up a number of SMP Gateways to communicate via
a dial-up connection, the PC will be able to communicate with only one SMP Gateway at
a time, and will use the addresses specified here.

a. Start SMP Manager. Select the SMP Gateway to be configured and from the File menu,
choose Properties.
b. In the SMP Device Properties dialog box, type a significant name for the new
SMP Gateway, such as “SMP Gateway via modem”.
c. In the First IP Address box, type the IP pool starting address that you specified when you
installed your SMP Gateway (see your SMP Gateway installation guide).
d. Do not type anything in the Second IP Address box. Click Add.

User Manual | page 278 Eaton


25. Updating SMP Gateway Software and
Tools
This chapter explains the software architecture of the SMP Gateway and describes how to
update the SMP Tools and the SMP Gateway software.

25.1. Software architecture of the SMP Gateway


To configure the SMP Gateway, you use the SMP Tools, software that runs on your computer
under a Microsoft Windows operating system.
Inside the SMP Gateway, there are also software components that need upgrading:
• The SMP Gateway runs on Windows CE, called a firmware, the equivalent of the Windows
operating system hosted on your computer. Other firmware that runs on the SMP Gateway
includes the bootstrap programs and the SMP Gateway application.
• The SMP Gateway application (.app file), which contains your protocol translators and other
gateway software files.
• The configuration file (.par file), which tells the SMP Gateway how to communicate with the
computer.

One of the SMP Tools is specialized in carrying files from the computer to the gateway:
SMP Loader.
Consequently, whenever you receive a CD-ROM from Eaton (or the contents of the CD-
ROM via FTP access to a download site), you should perform an update of all these pieces of
software. Follow these steps, in the order they are presented:
• Update the PC software, i.e. the SMP Tools (see Updating the SMP Tools on the PC (page
280)
• For each SMP Gateway:
◦ Update the SMP Gateway firmware (see Updating the SMP Gateway firmware (page
281)).
◦ Update the SMP Gateway application (see Updating the SMP Gateway application (page
283)).

Note: For the SMP SG-42xx platform, the firmware and application are updated
altogether.

◦ Update the SMP Gateway configuration file (see Updating the configuration file (page
283)).

The table below shows the exact order in which you will update the SMP Gateway components,
and the SMP Tool that you will use to perform the update.

Eaton User Manual | page 279


25 - Updating SMP Gateway Software and Tools

Table 25 - SMP Tools to use to update specific SMP Gateway components


Component to update Tool(s)

Bootstrap programs SMP Manager (requires version 4.0 or later of the


SMP Gateway software already installed) OR SMP
Loader

Resident diagnostics (only for the SMP 4/DP platform) SMP Manager

Operating System SMP Manager

SMP Gateway application SMP Manager

Configuration file SMP Config and SMP Manager

25.2. Version Packs


A version pack is a software package that contains all that is required by SMP Manager to
manage a specific version of the SMP Gateway software.
This package includes:
• The corresponding version of SMP Config and 61850 Config, which will be started by
SMP Manager for SMP Gateways that use this specific version of the software.
• The corresponding versions of the SMP Gateway software, which can be uploaded to the
SMP Gateway using SMP Manager.
• The corresponding documentation.

Version packs are integrated with the SMP Tools installer starting with version 5.2.

25.3. Updating the SMP Tools on the PC


Whenever you receive a new version from Eaton, with a new version or release of the SMP
software and Tools, you will start by updating the SMP Tools on your PC.

To update the SMP Tools:

1. Insert the SMP Software and Tools CD-ROM in your computer CD drive.
2. In the Welcome to the SMP Gateway window, click Upgrading.
3. There may be specific instructions that apply to the version you were using previously. If so,
follow these instructions before performing the upgrade.
4. Click the item you want to upgrade and follow the instructions. The SMP Tools installer will
automatically remove the previous version before installing the new one.

User Manual | page 280 Eaton


25 - Updating SMP Gateway Software and Tools

25.4. Updating the SMP Gateway software


The functions of the SMP Gateway are provided by a sophisticated embedded software system
that includes a number of components:
• The bootstrap program, which loads the SMP Gateway application and the Windows CE
operating system into memory when the SMP Gateway starts up.
• The Windows CE operating system, which provides real-time system services, network
services, and device drivers.
• The resident diagnostics, which allow you to ensure that the SMP Gateway is working
properly.

Note: No resident diagnostics are available on the SMP SG-42xx platform.

• The SMP Gateway application, which implements all the functionalities of the SMP Gateway.

25.4.1. Updating the SMP Gateway firmware

To update the firmware:


Once the startup is complete, the Status column will display the current status of the
SMP Gateway. The Status column should display Started. If the Status column shows that the
SMP Gateway did not start up normally, refer to “Troubleshooting”, page 249.

1. Update the bootstrap program:

Note: If the Windows CE version number you read from your SMP Gateway using
SMP Stats is older than version 4.0, then you must use the SMP Loader tool to update
the bootstrap.

a. In the SMP Manager window, click your SMP Gateway.


b. From the Update menu, choose Update Firmware.
c. In the Update dialog box:
• Select Bootstrap
• In the Select version box, select the version of the bootstrap program to upload to the
SMP Gateway
• Click OK
d. Click Yes.
Result:
SMP Manager transfers the file to your SMP Gateway and then informs you that you
have to restart your SMP Gateway for the new firmware to go into effect.
e. Restart the SMP Gateway
2. Update Windows CE:
a. In the SMP Manager window, click your SMP Gateway.
b. From the Update menu, choose Update firmware.

Eaton User Manual | page 281


25 - Updating SMP Gateway Software and Tools

c. In the Update dialog box:


• Select Operating System
• In the Select version box, select the version of the operating system to upload to the
SMP Gateway.

Note: In the case of the operating system, this version number does not refer to
the version of the Windows CE operating system. This is the version number of the
SMP Gateway software package, which includes a version of Windows CE that is
customized for the SMP Gateway.

• Click OK
d. Click Yes
Result:
SMP Manager transfers the file to your SMP Gateway and then informs you that you
have to restart your SMP Gateway for the new firmware to go into effect.
e. Restart the SMP Gateway.
3. Update the resident diagnostics. Proceed as for Windows CE, but:
a. In the Update dialog box, select Diagnostics Tools.
b. In the Select version box, select the version of the resident diagnostics to upload to the
SMP Gateway.
c. Click OK.
Result:
SMP Manager transfers the file to your SMP Gateway and then informs you that you
have to restart your SMP Gateway for the new firmware to go into effect.
d. Restart the Gateway.
Result:
The SMP Gateway will go through a series of startup steps, which will be displayed in
the Status column in SMP Manager.

Once the startup is complete, the Status column will display the current status of the
SMP Gateway. The Status column should display Started. If the Status column shows that the
SMP Gateway did not start up normally, refer to section Troubleshooting (page 297).

Note: Following a firmware update, it is normal that the versions of the bootstrap
programs and rescue operating system components remain unchanged. These components
are factory installed and do not change over the lifespan of the SMP device.

User Manual | page 282 Eaton


25 - Updating SMP Gateway Software and Tools

25.4.2. Updating the SMP Gateway application

To update the SMP Gateway application:

1. In the SMP Manager window, click your SMP Gateway.


2. From the Update menu, choose Update firmware.
3. In the Update dialog box:
a. Select Application.
b. In the Select version box, select the version of the application to upload to the
SMP Gateway.
c. Click OK.
4. Click Yes.
Result:
SMP Manager sends the software to the specified SMP Gateway, and then informs you that
you have to restart the SMP Gateway for the new application to go into effect.
5. Restart the Gateway.
Result:
The SMP Gateway will restart and load the new application.

25.4.3. Updating the configuration file


The last step in upgrading to a new version of the SMP Gateway software and tools consists of
updating the configuration file.

If you just updated the SMP Gateway application, please wait until the SMP Gateway completes
its startup process, to ensure that SMP Manager starts the version of SMP Config that
corresponds to the new SMP Gateway application.
To update the configuration file:

1. From SMP Manager, start SMP Config and open your configuration file. The file name in the
title bar should have a star (*) beside to inform you there is a change.
2. From the File menu, choose Save.

Note: If the Eaton SMP Configuration Comparison Tool is installed on the computer
hosting SMP Manager, an option to compare the local configuration file (the one you
want to send to the SMP device) with the configuration file which is currently on the
SMP device is offered. If you choose to do so, click on the Compare button and wait
for the result of the comparison. You will be asked again if you still want to send the
configuration file to the SMP device.

Result:
A message box will inform you that the current configuration file will be upgraded to a
current version. A backup is automatically saved, which includes the previous version
number in the file name.
3. Send the configuration file to the SMP Gateway using SMP Manager:

Eaton User Manual | page 283


25 - Updating SMP Gateway Software and Tools

a. From the Update menu, choose Send Configuration File.


Result:
SMP Manager will transfer the file on the SMP Gateway, and then informs you that you
have to restart the SMP Gateway for the new application to go into effect.
b. Restart the Gateway.

User Manual | page 284 Eaton


26. Activating a new license
Whenever you contact Eaton to request support for a new device that you want to connect to
your SMP Gateway, or to add support for a particular feature, Eaton will provide you with a new
license, which consists in an ID and a key.
A license ID is a user-readable identifier that helps distinguishes one license from another. A
license key is composed of up to 4 character sequences that define the list of software features
supported by the license, such as redundancy, SoftPLC and automation functions. The license
key also contains information about the maximum number of master protocols (one per device)
and slave protocols (one per control center) that are supported.

26.1. Updating the license of an SMP Gateway


Before you begin:
Before proceeding, make sure you have the new license information at hand. This information is
usually provided by an Eaton’s sales representative, in an email or in a license file.

Note: If you have corporate licenses, you must first create a folder named Licenses
in the directory where SMP Manager's executable file is located (C:\Program Files
(x86)\Cooper Power Systems\SMP Tools\Manager). Add the corporate licenses file in this
directory; the corporate licenses file is a text file which includes all generated licenses for a
given client. Then, follow the following instructions for updating the license.

To update the license of an SMP Gateway:

1. Start SMP Manager.


2. Select the SMP Gateway to update.
3. From the Update menu, choose Update License.
Result:

4. Enter the new license information:


a. If this information is available as a file, click Browse to open a file browser and locate the
license file. In this case, the license information will automatically be placed in the right
boxes.
b. Otherwise, type the License ID and Key (2 or 4 rows) in the corresponding boxes,
including the key for the Signature box (if specified in your license information).

Eaton User Manual | page 285


26 - Activating a new license

5. (Optional) To verify the features and limitations that are part of the specified license, click
Details.
Result:

6. Click OK to upload the license information to the SMP Gateway.


7. If new protocols and components are now part of the license, update the SMP Gateway
application before restarting the gateway, as described in section Updating the license of an
SMP Gateway (page 285)

26.1.1. Protocol classes


The License Information dialog box contains lots of information, including the maximum number
of master and slave protocols of each class that can be configured according to a given license.
Protocols are divided into classes according to their respective features and complexity. Here
are the classes in increasing order of complexity, along with some examples:
• Class 1: Includes commonly-used protocols, such as DNP3, Modicon MODBUS, SEL
protocols and IEC 60870-5.
• Class 2: Includes, but is not limited to, IEC 61850, IEEE C37.118, and OPC Master.
• Class 3: Currently only includes ICCP.

User Manual | page 286 Eaton


27. Miscellaneous SMP Tool features
This section presents SMP Manager and SMP Config commands that provide useful
capabilities, and that were not discussed in other sections of the document.

27.1. SMP Manager features


SMP Manager has a number of handy features:
• Displaying only those SMP Devices with which SMP Manager is currently in communication.
◦ Click Active SMP Devices only from the View menu
• Choosing the time display format: local time or UTC.
◦ Click Options from the Tools menu
◦ See also Modifying SMP Manager Settings (page 287)
• Exporting your SMP Gateway list.
◦ Click Export List from the File menu
• Importing an SMP Gateway list.
◦ Click Import list from the File menu

Also, some SMP Manager settings can also be customized to your needs, as described in the
following section.

27.1.1. Modifying SMP Manager Settings

To modify SMP Manager settings:

1. From the Tools menu, choose Options.


Result:

Eaton User Manual | page 287


27 - Miscellaneous SMP Tool features

2. In the Time Display Format box, select the format you want to use to display time
information in SMP Manager:
a. Local Time: Time information obtained from SMP Gateways will be adjusted to the time
zone and daylight saving time information of your PC.
b. SMP Device UTC: Time information obtained from SMP Gateways will be displayed as is.
3. Clear the Do not prompt for logon credentials at startup check box if you want the Login
Information window to be displayed upon startup.
4. Under IED Manager Suite and Authentication Certificate, you will find settings that
are specific to IMS authentication, which is not covered by this manual. Refer to the
IED Manager Suite documentation for more information about this settings and IMS
authentication.
5. Under SMP Device List, you can change the name and the location of the file containing
the list of SMP Devices that are currently displayed in SMP Manager. This file has a VEP
extension.

27.2. SMP Loader


Important: Starting at version 8.1, we stopped the support of the SMP 16 platform in
SMP Config, meaning that the Software and Tools 8.1R1 and later cannot be installed on
an SMP 16 platform. However, SMP Manager can still manage SMP 16 platforms running
versions 8.0 or older. We have decided to keep the section related to SMP Loader, even if
this tool can be used only with the SMP 16 automation platform, for the benefit of customers
that are still using SMP 16 automation platforms.

SMP Loader should be used for the following purposes:


• To update the bootstrap programs.
• You can, in fact, load Windows CE and the resident diagnostics with SMP Loader, but you
should use SMP Manager unless there is a problem.

Note: SMP Loader can only be used with SMP Gateways from the SMP 16 series.
When you are in a situation where you need to load files to your SMP 16 using SMP
Loader, contact Eaton support and they will provide the files to be transferred to your SMP
Gateway.

When the SMP Gateway is powered up or reset, the following components are started up, in the
order listed:
• The primary bootstrap program.
• The secondary bootstrap program.
• Windows CE.

In order to use SMP Loader, you need to interrupt the startup process before it reaches
Windows CE startup. You accomplish this by putting the SMP Gateway into Command mode.

User Manual | page 288 Eaton


27 - Miscellaneous SMP Tool features

27.2.1. Setting up SMP Loader

To set up and start SMP Loader :

1. Connect your PC to the SMP Gateway CONSOLE port. Connect one of the communications
ports of your PC to the SMP Gateway CONSOLE port, using a standard RS-232 direct cable
equipped with a DB9 male connector at one end and a DB9 female connector at the other
end.

Note: If you are using a portable computer that does not have an external serial
port, you will need to use an USB-to-RS-232 serial converter.

2. Start up a terminal session to put the SMP Gateway into Configuration mode. (See
instructions in the SMP 16 Installation Guide)
3. To access the SMP 16 Configuration mode (refer to the SMP 16 Installation Guide for more
details, if needed):
a. Power off the SMP 16 and power it up again.
b. Pay attention to the traces in the terminal window, you will be asked to press Enter to
access the Configuration mode.
c. Once in the Configuration mode, select U (Update Firmware)
4. Start SMP Loader within the time restriction displayed in the terminal window.
5. To start SMP Loader:
a. Click Start on the Windows taskbar.
b. Point to All Programs, then to Eaton SMP Tools.
c. From the Eaton SMP Tools menu, choose SMP Loader.
d. From the Connection menu, choose Communication Settings to display the
Communication Settings window. Most of the communication settings are unavailable, as
they cannot be changed.
e. Select the communications port that will be used on your PC (ex. COM1).
f. Specify 115,200 bps as the file transfer speed. If your computer does not support the
specified speed, try a lower value for this setting.
g. Click OK.
h. Do not close SMP Loader: it will connect to the SMP Gateway automatically when the
latter will enter Command mode.
Result:
SMP Loader will automatically connect to the SMP Gateway, as described in the
previous section. SMP Loader window will show the files that are currently loaded on the
SMP Gateway as soon as the latter will complete its startup into Command mode.

Eaton User Manual | page 289


27 - Miscellaneous SMP Tool features

27.2.2. Main window


The SMP Loader main window is shown next, for an SMP 16/SG.

As you can see, the display only shows Windows CE. It is important to note that the display area
does not list the bootstrap programs, even though these do indeed reside on the SMP Gateway.
However, the secondary bootstrap version is shown at the bottom right of the window, on the
status bar.
To view the bootstrap programs’ version numbers:
• From the Connection menu, choose Bootstrap Versions. A dialog box appears, showing
the versions of both bootstrap programs.

Note: The dialog box indicates that the primary bootstrap version is unavailable since it
resides in the ROM and cannot be modified in the field.

27.2.3. Transferring files to the SMP Gateway

You can transfer one or more files to the SMP Gateway, and you can choose the files
individually. An Eaton representative, will provide the files that you need.
To transfer files to the SMP Gateway you can use:
• Windows Explorer, drag and drop the files in your SMP Loader main screen display.
• SMP Loader

If you chose to use SMP Loader, follow these steps:

1. Choose Send from the File menu.


Result:

User Manual | page 290 Eaton


27 - Miscellaneous SMP Tool features

2. Point to SMP Tools\Version Pack\<version number>\SMP Firmware Libraries, and


then to the SMP 16 or SMP 16 PM folder, depending on the model of SMP Gateway. An
Eaton representative, will provide the files that you need.
3. Choose SMP Loader Files (*.smp) in the Files of type drop-down list. This will display one or
more files with the SMP extension. Select the file you want to send, and click Open.
Result:
The File Information dialog box appears, giving you a description of each file, within the .VL
file, that you are about to transfer and asking you to confirm your intention to carry out the
transfer.

The transfer takes place once you have responded to the question for all the files that were
listed; a dialog box shows you the progress of the operation.
4. Remove the cable that you connected between the SMP Gateway CONSOLE port and the
PC when you used SMP Loader.
5. Start SMP Manager, and monitor the progress of the reset operation.

Note:
• The SMP Gateway will not use the transferred files until next reset.
• If you transferred a bootstrap program, it will not appear in the list even though the file has
indeed been transferred. Furthermore, if you look at the bootstrap version numbers (by
choosing Bootstrap Versions from the Connection menu), you will see that the secondary
bootstrap number has not been updated. The version number will be updated on next
reset of the SMP Gateway.

Eaton User Manual | page 291


27 - Miscellaneous SMP Tool features

27.2.4. Viewing the log file


SMP Loader records every significant event until you exit the application, including startup, file
transfers, file deletions, requests for bootstrap programs version numbers, communications port
settings, transfer cancellations, refreshes, communication errors, and so on.
The log file, which can be read using the Notepad application, is located in the following folder,
under the name Loader.log: SMP Tools\Version Pack\<version number>\Manager\SMP
Firmware Libraries

Note: Each time you start the application, SMP Loader overwrites the information
contained in the file.

27.2.5. Updating bootstraps under unusual circumstances


Unexpected events, such as a blackout during a bootstrap program file transfer, could cause the
secondary bootstrap program to become corrupted.
If the secondary bootstrap of your SMP Gateway is corrupted, contact Eaton’s Technical
Support (see Getting assistance (page 17)).

User Manual | page 292 Eaton


28. SMP Console functions
Console access to the SMP Gateway provides you with a command line prompt for running
tools and low-level commands on the SMP Gateway.
Console tools are gradually being replaced by Windows-based tools. However, if you must use
the command line interface, you can use the following console commands:
• FirewallMgr (Firewall Manager)
• Time and Date
• TCP/IP address and RAS setup, as described in the installation manual of each device
• SnmpMgr (SNMP Manager), as described in section Configuring the SNMP server (page 260)
• ClockMgr (Clock Manager)

28.1. Starting SMP Console


All the SMP Console commands can be called on the SMP Console command line.

To start SMP Console:

1. In SMP Manager, select your SMP Gateway.


2. From the Tools menu, choose SMP Console.
3. In the console window, type the username and password of a user account that has the
System Management privilege.

You can now execute any of the console commands that are described in the following sections.

28.2. Firewall Manager


Since version 4 of the SMP Gateway Software & Tools, the firewall is configured using
SMP Config. Firewall Manager can now only be used to view the current status and custom
rules of the firewall.
If you have setup a firewall using a previous version of the SMP Gateway software, you can still
use Firewall Manager to set up rules. However, these rules will be overridden if you set up a
firewall instance using SMP Config (see The SMP Gateway integrated firewall (page 190)).
To use Firewall Manager:
• In the console window, type the following command at the prompt: firewallmgr. Firewall
Manager displays the list of available commands, as the following shows:

Eaton User Manual | page 293


28 - SMP Console functions

Table 26 - SMP Console, Firewall Manager commands


Firewall Manager

Available commands (case insensitive):

Note: Use "SMP Config" to change the firewall configuration.

R Show custom firewall rules.

S Show the current firewall and VPN status.

H Display the list of available commands.

Q Quit

The commands are described in the following sections.

28.2.1. R Command
The R command displays the list of firewall rules you have set-up.

28.2.2. S Command
The S command shows the current status of the firewall and VPN connections.
Example:
Table 27 - Firewall Manager, S command
Firewall: disable

Firewall log: enable

VPN connections: 2

28.2.3. H Command
The H command displays the list of available commands, as shown at the beginning of this
section.

28.2.4. Q Command
The Q command is used to exit the firewall manager.

User Manual | page 294 Eaton


28 - SMP Console functions

28.3. Time and date


You can now set the SMP Gateway time and date using SMP Manager, as described in section
Setting the SMP Gateway internal clock (page 263). The Time and Date console commands are
still available for that matter.
To set the SMP Gateway time:
• In the console window, type the following command at the prompt: time

The current UTC time is displayed, followed by a prompt for the new time. For example:
Table 28 - SMP Console, set time
The current time is: 3:22:40 PM

Enter the new time (hh:mm:ss):

• Type the new UTC time in the requested format and press ENTER.

To set the SMP Gateway date:


• In the console window, type the following command at the prompt: date

The current time is displayed, followed by a prompt for the new time. For example:
Table 29 - SMP Console, set date
The current date is: Tuesday, June 10, 2008

Enter the new date (mm-dd-[yy]yy):

• Type the new date in the requested format (year can be specified using two digits) and press
ENTER.

Note: For both commands, the time/data will remain unchanged if you do not type
anything and press ENTER

28.4. Clock Manager


Clock Manager was used for time adjustment setup. It has been replaced by SMP Config since
version 4 of the SMP Gateway Software & Tools. It is now mainly used to get an overview of the
GPS clock settings; for more details, refer to the Satellite-synchronized clock (GNSS) option -
Installation Guide.
To use Clock Manager:
• In the console window, type the following command at the prompt: clockmgr. Clock Manager
displays the list of available commands, as the following shows:

Eaton User Manual | page 295


28 - SMP Console functions

Table 30 - SMP Console, Clock Manager commands


Clock Manager.

Available commands (case insensitive):

Note: Use "SMP Config" to change the clock configuration.

D Display the current settings.

H Display the list of available commands.

Q Quit.

The commands are described in the following sections.

28.4.1. D Command
The D command shows the current settings of the optional GPS clock.
Example:
Table 31 - SMP Console, Clock Manager, D Command
GPS Cable length: 0 m

IRIG-B distribution format for the IRIG-BXX0 IEEE 1344


GPS:

Always distribute the IRIG-B signal: No

28.4.2. H Command
The H command displays the list of available commands, as shown at the beginning of this
section.

28.4.3. Q Command
The Q command is used to exit the clock manager.

User Manual | page 296 Eaton


29. Troubleshooting
The SMP Gateway is a highly reliable substation-grade device. Most operational problems
result from configuration errors, and there are a few simple steps you can take to identify and
solve these problems.
This section discusses the following types of problems:
• Startup problems.
• Communications problems.
• Problems with data validity.
• Problems executing control operations.
• Firewall-related problems.

In the upcoming sections, we will take you through the steps required to solve your problems.

29.1. Creating an SMP Gateway report file


If after going through all the required procedures, you find that you need to contact Eaton’s
Technical Support, you will need to create a report file. This file will help the technical support
team in identifying and solving the problem.
SMP Gateway report files are stored in Reports folder of SMP Manager. Each time a report is
generated, SMP Manager creates an event log file, indicating all operations performed during
the report generation. The event log file is also stored in the Reports folder.
To create an SMP Gateway report file:

1. In SMP Manager, select all SMP Devices for which you want to create a report file (one
report per gateway).
2. From the SMP Device menu, choose Make Report.

Note: The Make Report command is only available if the selected SMP Devices is
online.

Result:

Eaton User Manual | page 297


29 - Troubleshooting

3. Click the Tell me more button to display the information that will be collected from the
SMP Devices.
4. Type additional information in the text box, such as the problem description, or the reason
why you are requesting technical support.
5. The syntax of the name of each report file is as follows:
<label><name><serial><datetime> where:
• <label> is an optional label that you can specify in the corresponding box
• <name> is the name of the SMP Device as specified in SMP Manager
• <serial> is the serial number of the SMP Device
• <date time> is the current date and time
6. Select Extract Automatically if you want to see where the report is located as soon as SMP
Manager has finished retrieving the report information. The information will be displayed in a
Windows Explorer window.
7. Click OK.
8. In the Browse for Folder window, select the folder where you want to save the report files.
9. Click OK to start the report generation.
Result:
SMP Device Report progress windows appear (one for each report/device), showing each
operation performed and when report generation is complete.
10. Once report generation is complete, you can click Details to display the event log for this
specific report generation (useful if errors occurred during the process), or simply click Close
to exit the SMP Device Report window. If you selected Extract Automatically, the entire
file content of the report will be shown in a Windows Explorer window, providing information
about the data points, crashes, logs, and so on.
11. The report is saved as GRF file, which is in fact a zipped file that contains the files and
folders discussed above.

Note: The Extract Automatically option actually shows the content of the GRF file. A
quick way to reach the GRF file is to move one folder up from that location.

User Manual | page 298 Eaton


29 - Troubleshooting

29.1.1. Viewing an SMP Device report file


At the time you generate a report, you can choose to see the report immediately. However, at all
times, you can view an existing report for any SMP Device.

To view an SMP Device report file:

1. In SMP Manager, select the SMP Device.


2. From the File menu, choose Extract SMP Device Report.
3. In the Open dialog box, choose the desired GRF file and click Open.
Result:
A Windows Explorer window opens. You will now see a group of files and folders. Open the
desired items to view the information they contain.

29.2. Restoring the factory settings of the


SMP Device
When the SMP Gateway becomes unresponsive (even following multiple restart operations)
or when you forgot the administrator account password, there is no choice but to restore the
factory settings of the SMP Device.
Restoring the factory settings of an SMP Device it is simply called “Factory Reset”. This
operation is launched from SMP Manager using the Update –> Restore Factory Settings
option.

Note: It is also recommended to perform a factory reset operation when you need to
downgrade the SMP Gateway to an earlier version of the SMP Gateway software.

A factory reset operation erases all the sensitive content of the SMP Gateway non-volatile
memory, including:
• the SMP Gateway application and related components
• all SMP Gateway configuration (PAR) files
• the content of all log folders
• the SMP Gateway local security database
• event files stored in local system folders
• the SMP Gateway SoftPLC application, if CODESYS is used with this SMP Gateway

Note: The factory reset operation does not delete the bootstrap program and the
Windows CE operating system files. Network adapter settings (notably the TCP/IP address
of the SMP Gateway) are also erased.

To learn how to restore the factory settings of a specific SMP Gateway automation platform,
refer to the “Troubleshooting” section of the corresponding installation guide (ex. SMP 4/DP
Installation Guide, for the SMP 4/DP).

Eaton User Manual | page 299


29 - Troubleshooting

29.3. Startup problems


When you start the SMP Gateway or reset it using SMP Manager, it goes through a sequence of
steps, after which you should see Started in the Status column of the SMP Manager application
window. However, if the SMP Gateway software detects a problem during startup, you may see
something else in the Status column.
Here are some suggestions for troubleshooting the problem. If the problem persists, do not
hesitate to contact our technical support team.

29.3.1. No configuration file


If the status is No configuration file, you have not loaded a configuration file on the
SMP Gateway.
To correct the problem:
• Create a configuration file using SMP Config, if you have not already done so.
• Use SMP Manager to send the file to the SMP Gateway.
• Restart the SMP Gateway using SMP Manager, in order to activate the configuration.

29.3.2. Protocols failed


If the status is Protocols failed, it may be due to one of the following reasons:
• You changed the SMP Gateway license, but did not update the SMP Gateway application.
• There is a problem with a master or slave protocol instance.
• There is an incompatibility in the settings.

To correct the problem:


• If you have changed the SMP Gateway license without updating your SMP Gateway
application, update the SMP Gateway application using SMP Manager, as some components
may be missing. See Updating the SMP Gateway application (page 283).
• Otherwise, start SMP Log and examine the startup log.
• Make sure you are using the correct configuration file:
◦ If you are using the wrong configuration file, use SMP Manager to send the correct file to
the SMP Gateway.
◦ If you are using the correct configuration file, but it contains errors, fix them all using
SMP Config, and then send the file to the SMP Gateway using SMP Manager.
• Make sure you have described your hardware correctly. For example, you may have
specified the wrong SMP Gateway model in SMP Config.
• Check the protocol settings. The log will show you the startup actions of each protocol
instance. You will see which one failed to load or did not start up properly. Check its
parameter settings. Make sure you have associated the protocol instance with an existing
serial port (the number of available ports depends on the hardware configuration settings).
• Check the version numbers of the SMP Gateway software. A component may not be up-to-
date:

User Manual | page 300 Eaton


29 - Troubleshooting

◦ Send an updated version of the SMP Gateway application to the SMP Gateway, using
SMP Manager.
◦ If the application update does not work, you probably need to have SMP Config convert
your configuration file, after which you can send the file to the SMP Gateway.
• If the problem persists after the SMP Gateway has restarted, try using a reduced version of
the configuration file, in an attempt to isolate the problem. For example, use a configuration
file that has only one device and one protocol instance.

29.3.3. Critical components missing


If the status is Critical components missing, there is a missing component in the SMP Gateway
application. This situation can arise if you change your license without updating the
SMP Gateway application.
• Update the SMP Gateway application using SMP Manager. See Updating the SMP Gateway
application (page 283).
• If the problem persists, contact Eaton’s Technical Support (Getting assistance (page 17)).

29.4. Communication problems


Communication problems always occur in one of the following layers:

Figure 19 - Network layers where most communication problems occur

SMP Trace and SMP Stats are the ideal tools for you to troubleshoot a communication problem
and determine in which layer the problem occurred.
SMP Trace shows you the information that was sent back and forth between the SMP Gateway
and the device, while SMP Stats supplies you with statistics that can help you detect an
anomaly. For example, the statistics may show you that there were no exchanges whatsoever
on a particular connection or the trace may show you that the SMP Gateway never got
responses when it polled a particular device.

Eaton User Manual | page 301


29 - Troubleshooting

29.4.1. Physical layer


The physical connection between the SMP Gateway and a device is often at the root of a
problem.
You should therefore ask yourself the following questions:
• Am I using the correct type of cable?
◦ Do I need to use a cable for RS-232 or for RS-485 communications?
◦ Should I be using a 2-wire or a 4-wire cable for RS-485 communications?
• Is the device connected properly? Make sure the cable is connected to the correct port.
• Do I need an adapter?
◦ For example, do I need a null-modem adapter for RS-232 communications?
• Are the connection settings configured correctly? Use SMP Config to check the
Asynchronous settings, under Connections\Serial Ports:
• If I’m using RS-485 4-wire or 2-wire, did I choose RS-485?

29.4.2. Link layer


Problems in the link layer are often related to the settings of the communications component.
Here are examples of settings that can cause problems:
• The baud rate, parity, start and stop bit settings of both the SMP Gateway and the device, for
serial communications.
• The TCP/IP address and port configuration, for TCP/IP communications.

To correct this problem:


• Examine the link layer byte exchanges, using SMP Trace and SMP Stats.
• Using SMP Config, look at the Connections settings:
◦ If your SMP Gateway communicates with the device over a serial link, check the
communications settings of the link used to communicate with the device, such as baud
rate and parity. These settings must be configured identically at both ends.
◦ If your SMP Gateway communicates with the device over a WAN or LAN, make sure you
have specified the correct TCP/IP address and port number.

29.4.3. Protocol layer


Protocol problems are directly related to the settings of the protocol instance used to
communicate with the device.
You should proceed as follows:
• Examine the protocol layer byte exchanges, using SMP Trace and SMP Stats.
• Using SMP Config, make sure you have specified the correct protocol.
• Look at the SMP Config general settings:
◦ Check the settings of the protocol instance, such as packet size.
◦ Make sure the device or link address is correct.

User Manual | page 302 Eaton


29 - Troubleshooting

◦ Check the polling parameters. Some devices are not able to respond to rapid polling
requests because they process the information very slowly. Other devices only allow slow
communications links - 9600 baud or less. If you poll too quickly, the request will arrive
before the last block of data is read, thereby causing communications problems.

29.5. Problems with data validity


When all the exchanges are taking place correctly and there are no protocol errors reported in
the statistics, but some of the acquired values are erroneous or incoherent. Using SMP Config,
examine the following settings for the points that are invalid:
• Data point address: Is the address of the physical data point correct? Some devices have
flexible configuration options, so you have to compare the SMP Config values with the values
set by the device manufacturer’s software.
• Conversion factors: For physical analog data points, are the scale and offset factors
correct?
• Polarity: For physical binary input points, is the polarity set correctly?
• Warning messages: Are there any warning messages in the message pane, regarding the
data points that have erroneous values?

29.6. Problems executing a control operation


When a control operation fails:
• Use SMP Log to look in the Control log. All control operations are recorded in this log.
• Use SMP Trace to see the data exchanges.

Note: You have to be connected to the SMP Gateway to view a control operation in
real time.

• Make the following checks to determine the cause of the failure:


◦ Using SMP Log, look at the control log and make sure the SCADA is sending the correct
sequence (direct operate, select before operate) of messages.
◦ Using SMP Config, check the general settings of both the master and the slave protocol
instances. Make sure that for each of them, the Control Enabled check box is selected.
◦ Using SMP Config, make sure the binary and analog physical output points are set up
correctly. For example, for the DNP3 protocol, Control Type requires a value other than
“Not supported”. See the device manufacturer’s documentation for the required setup and
refer to the appropriate Eaton protocol documentation.
◦ Refer to the device manufacturer’s documentation to check whether the device allows
for a polling message to be sent between a select operation and an operate operation,
or whether polling has to wait until after the select and operate have completed. Some
manufacturers deselect the device if a polling message is sent between a select operation
and an operate operation. If polling has to wait, use SMP Config to make sure that the Tx
During SBO check box is selected in the master protocol general parameters.

Eaton User Manual | page 303


29 - Troubleshooting

◦ Using the Web browser, make sure the point called _smp___localControl is set either
to 0 to enable commands from the SCADA or to 1, to enable commands from Visual
T&D. If the value is not set properly, send either an open command to the point called
_smp___setLocalControl to set the value to 0, or a close command to set the value to 1.
◦ Using the Web browser, check whether the point is set to inhibit operations. If so, remove
the inhibition.

29.7. Firewall-related problems


If, for some reasons, access to the SMP Gateway management port (TCP/UDP 6650) is
restricted in the integrated firewall, you may no longer be able to connect to the SMP Gateway
using any SMP Tools: this situation is called a “firewall lockout”.
Since the firewall configuration is specified in the SMP Gateway configuration file (PAR), it is
possible to recover from a firewall lockout if you have physical access to the SMP Gateway.
The recovery procedure is different for the SMP 4/DP and SMP SG-42xx platforms.
Furthermore, for these platforms, the procedure is simplified if the user can connect the
computer that host SMP Manager to the SMP Gateway directly, via the Console port (USB).

29.7.1. Recovering from a firewall lockout on an SMP 4/DP


To recover from a firewall lockout with an SMP 4/DP:

1. If it is not possible to connect the computer hosting SMP Manager directly to the SMP 4/DP
via the Console port (USB), follow these sub-steps:
a. The SMP 4/DP needs to reset and enter the maximum safe mode. Restrictions over the
SMP Gateway management port are not effective in Maximum Safe Mode. Power off the
SMP 4/DP and then power it up again.
b. At startup, when the Watchdog and SYNC LED flash at the same time, press the LED
test push button. To press the button, insert a pointed object in the hole and apply
pressure.
Result:
The SMP 4/DP is in Maximum Safe Mode if the Watchdog LED flashes red.
2. Otherwise, connect the computer hosting SMP Manager to the SMP 4/DP Console port. SMP
Manager will detect the SMP 4/DP automatically and add it to the list; SMP Manager names
de SMP Gateway and assigns it the IP address of its USB adapter (172.31.0.1).
3. In both situations, the device is in maximum safe mode or the computer is connected to its
console port, from SMP Manager:
a. Open SMP Config and, under the Security > Firewall > Rules branch, modify the
Management port accessibility to allow your computer to access the SMP Tools from the
network.
b. Save the SMP Config file.
c. Select the newly added SMP 4/DP in SMP Manager and, from the top menu select
Update > Send Configuration file.
d. Browse to select the Configuration file with the updated firewall rules.

User Manual | page 304 Eaton


29 - Troubleshooting

e. Restart the SMP 4/DP. If the computer was connected to the Console port, disconnect it
and reconnect the computer to the usual network.
Result:
The SMP 4/DP will restart normally and it should be available through the network.

29.7.2. Recovering from a firewall lockout with an SMP SG-42xx


platform
To recover from a firewall lockout with an SMP SG-42xx platform:

1. If it is not possible to connect the computer hosting SMP Manager directly to the SMP
SG-42xx platform via the Console port (USB), follow these sub-steps:
a. The SMP SG-42xx platform needs to reset and enter the maximum safe mode.
Restrictions over the SMP Gateway management port are not effective in Maximum Safe
Mode. Power off the SMP SG-42xx platform and then power it up again.
b. At startup, when the Watchdog and the ST1 LED flash at the same time, press the Select
push button. The SMP SG-42xx platform is in Maximum Safe Mode if the Watchdog LED
flashes red and the ST1 LED illuminates red.
2. Otherwise, connect the computer hosting SMP Manager to the SMP SG-42xx platform
Console port. SMP Manager will detect the SMP SG-42xx platform automatically and add it
to the list; SMP Manager names of SMP Gateway and assigns it the IP address of its USB
adapter (172.31.0.1).
3. In both situations, the device is in maximum safe mode or the computer is connected to its
console port, from SMP Manager:
a. Open SMP Config and, under the Security > Firewall > Rules branch, modify the
Management port accessibility to allow your computer to access the SMP Tools from the
network.
b. Save the SMP Config file.
c. Select the newly added SMP SG-42xx platform in SMP Manager and, from the top menu
select Update à Send Configuration file.
d. Browse to select the Configuration file with the updated firewall rules.
e. Restart the SMP SG-42xx platform. If the computer was connected to the Console port,
disconnect it and reconnect the computer to the usual network.
Result:
The SMP SG-42xx platform will restart normally and it should be available through the
network.

29.8. Diagrams problems


If an animation error occurs over an SMP Gateway HMI Diagram, a dark red or light red
question mark will appear on the diagram, beside the corresponding shape.
A dark red mark indicates that an operand is missing in the animation expression.
A light red mark indicates that an invalid value was received for one of the operand of the
animation expression.

Eaton User Manual | page 305


29 - Troubleshooting

29.8.1. Missing Operand (dark red question mark)


Most of the times, this error occurs when:
• An animation expression uses a function that is not supported by the SMP Gateway HMI
feature (i.e. this function is only intended for use within Visual T&D diagrams).
• An animation expression refers to a data point that is not present in the SMP Gateway
configuration file.

In both scenarios, these errors are typically mentioned while exporting a diagram from
Visual T&D Diagram Editor to the SMP Gateway HMI Package file (.hmi) format. This will
probably not happen with the Front Panel diagrams while only SMP Diagram Editor is used to
design the diagrams.
Try to fix the errors and re-export the diagram again.
References to unused data points
This error also occurs when an animation expression refers to an SMP Gateway data point that
never gets updated (its point quality is set to “Unknown” at startup and never changes).
If this is the case, make sure that all data points used in animation expression are properly
configured in their respective master protocol instances.

29.8.2. Invalid Operand Value (light red question mark)


This type of error occurs when an animation expression uses:
• A calculated data point value that is invalid (for example, if the data point value is the result of
a divide-by-zero operation from the Logic Processor);
• A retrieved data point value that is invalid (ex. Infinite or not-a-number values).

Modify the animation expression to ensure that these error scenarios are properly handled using
conditional logic. You can also try to filter such invalid values.

User Manual | page 306 Eaton


30. Appendices
This section includes the system data point list and the RTDX status flags.

30.1. System data points


The SMP Gateway has system points for various purposes and features, such as remote
access, security, time adjustment and redundancy. When they are present on an SMP Gateway,
they can be visualized using the SMP Gateway HMI. When an SMP Gateway slave protocol
subscribes to them, they provide useful information to the SCADA.
The following list describes all available system data points:
Table 32 - System data points
Data Point Name Description

System

_smp___battery_ok If set to 1, this binary input point indicates that the clock battery is
operational.

_smp___serialNumber This analog input point states the serial number of the SMP Gateway.

_smp___started This analog input point indicates the status of the SMP Device at
startup.
• Is set to 0.0 during device startup
• Is set to 1.0 when the device has successfully started
• Is set to -1.0 when the device failed after startup

Note: The point stays at 0.0 if the SMP Device fails to start.

_smp___temperature This analog input point states the internal temperature of the SMP
Gateway, in Celsius degrees.

_smp___temp_ok This binary input point is used for monitoring the internal temperature
of the SMP Gateway. It indicates if the internal temperature is below
or over the predefined temperature threshold of 85 °C.

Note: The threshold setting of 85 °C is not configurable.

• Is set to 1 when the internal temperature is below the threshold


• Is set to 0 when the internal temperature is over the threshold

_smp___activateOut2Relay This binary output point allows you to open and close
the SMP SG-42xx platform OUT2 (NO contact) relay.
(available on the SMP SG-42xx platform)
_smp___out2RelayActive indicates the actual state of the relay.

Eaton User Manual | page 307


30 - Appendices

Data Point Name Description

_smp___out2RelayActive This binary input point indicates the actual state of the SMP SG-42xx
platform OUT2 (NO contact) relay.
(available on the SMP SG-42xx platform)

_smp___restartSystem This binary output point allows you to restart the SMP Gateway.

Power Status

_smp___voltage_ok If set to 1, this binary input point indicates that the voltage of the
SMP Gateway power supply is within its normal range of operation.
(available on the SMP 4/DP platform)

Power Status (present on the SMP SG-4260 only)

Note: These point are related to the use of the optional dual power supply but are present on the SMP
SG-4260 with a standard power supply which correspond to Power Supply 1 (PSU1).

__powerSupply1Present If set to 1, this binary input point indicates that the power supply 1
was detected, it is present in the enclosure.
Value when SMP device is setup with a single power supply: 1

__powerSupply2Present If set to 1, this binary input point indicates that the power supply 2
was detected, it is present in the enclosure.
Value when the SMP device is setup with a single power supply: 0

__powerSupply1PowerGood Indicates the power quality of the power supply 1


If set to 1, this binary input point indicates that the power supply 1 is
producing proper voltage, it does receive adequate power from the
power source it is connected to.
This information is available only if the power supply is present in the
enclosure.
Value when the SMP device is setup with a single power supply: 1

__powerSupply2PowerGood Indicates the power quality of the power supply 2


If set to 1, this binary input point indicates that the power supply 2 is
producing proper voltage, it does receive adequate power from the
power source it is connected to.
This information is available only if the power supply is present in the
enclosure.
Value when the SMP device is setup with a single power supply: 0

User Manual | page 308 Eaton


30 - Appendices

Data Point Name Description

__powerSupply1FaultDeclared If set to 1, this binary input point indicates that the power supply 1 is
faulty.
The fault condition is independent from the power source energizing
the power supply; the power supply is declared faulty when the last
activation tentative failed.
This information is available only if the power supply is present in the
enclosure.
Value when the SMP device is setup with a single power supply: 0 (in
this situation, it is not possible to detect a faulty power supply using
this point, you will notice the problem because the SMP device is
powered off).

__powerSupply2FaultDeclared If set to 1, this binary input point indicates that the power supply 2 is
faulty.
The fault condition is independent from the power source energizing
the power supply; the power supply is declared faulty when the last
activation tentative failed.
This information is available only if the power supply is present in the
enclosure.
Value when the SMP device is setup with a single power supply: 0 (in
this situation, it is not possible to detect a faulty power supply using
this point, you will notice the problem because the SMP device is
powered off).

__powerSupply1Selected If set to 1, this binary input point indicates that the power supply 1 is
the active power supply. This binary input point is always set to 1 for
an SMP SG-4260 with a standard power supply.
Default value when the SMP device is setup with a single power
supply: 1

__powerSuppliesMainBackupMode This binary input point represents the dual power supplies
redundancy operating mode.
• Is set to 1 when the dual power supplies redundancy operating
mode is set to Main - Backup (default). The control switch inside
the bottom panel enclosure of the SMP SG-4260 is at the ON
position.
• Is set to 0 when the dual power supplies redundancy operating
mode is set to Alternate. The control switch inside the bottom
panel enclosure of the SMP SG-4260 is at the OFF position.

Note: On an SMP SG-4260 with standard power supply, where there


is no operating mode nor control switches at the bottom panel, this
binary input is always set to 1.
Value when the SMP device is setup with a single power supply: 1

Eaton User Manual | page 309


30 - Appendices

Data Point Name Description

__powerSupply1UseCount This integer input indicates the number of times the power supply 1
became active on the present power cycle.
This information is available only if the power supply is present in the
enclosure.

__powerSupply2UseCount This integer input indicates the number of times the power supply 2
became active on the present power cycle.
This information is available only if the power supply is present in the
enclosure.

CPU

_smp___avgCpuLoad This analog input point states the average load of the SMP Gateway
CPU, in percentage.

_smp___cpuLoad This analog input point states the load of the SMP Gateway CPU, in
percentage.

_smp___cpuSpeed This analog input point states the speed of the SMP Gateway CPU, in
megahertz.

Memory

_smp___memoryLoad This analog input point states the memory load of the SMP Gateway,
in percentage.

_smp___memorySize This analog input point states the memory capacity of the
SMP Gateway, in megabytes.

Clock-Related Information

_smp___clockYear This analog input point states the year information of the
SMP Gateway internal clock.

_smp___clockMonth This analog input point states the month information of the
SMP Gateway internal clock.

_smp___clockDay This analog input point states the day information of the
SMP Gateway internal clock.

_smp___clockHour This analog input point states the hour information of the
SMP Gateway internal clock, using the 24-hour notation.

_smp___clockMinute This analog input point states the minute information of the
SMP Gateway internal clock.

_smp___clockSecond This analog input point states the second information of the
SMP Gateway internal clock.

User Manual | page 310 Eaton


30 - Appendices

Data Point Name Description

_smp___clockSynchronized If set to 1, this binary input point indicates that the internal clock of the
SMP Gateway is actually synchronized with a time synchronization
source, such as Satellite-synchronized clock (GNSS) option or IRIG-
B.
For an SMP SG-42xx platform:
If set to 1, this binary input point indicates that the SMP ¨SG-42xx
platform’s internal clock is currently synchronized with a time
synchronization source; if a Minimal Time Quality Requirement is
specified in the SMP Gateway configuration file, this source meets
the requirement.

_smp___clockSyncQuality_ok If set to 1, this binary input point indicates that the SMP SG-42xx
platform’s internal clock is currently providing time information that
(available on the SMP SG-42xx platform)
meets the Minimal Time Quality Requirement that is specified in the
SMP Gateway configuration file.

Software Version Information

_smp___versionMajor This analog input point states the major version number of the
software installed on the SMP Gateway.
For example, for version 7.0R1 of the software, the major version
number is 7.

_smp___versionMinor This analog input point states the minor version number of the
software installed on the SMP Gateway.
For example, for version 7.0R1 of the software, the minor version
number is 0.

_smp___versionRev This analog input point states the revision version number of the
software installed on the SMP Gateway.
For example, for version 7.0R1 of the software, the revision version
number is 1.

_smp___versionType This analog input point states the version type of the software
installed on the SMP gateway.
The point can takes one of the following values:
• 0 to 2: Development and test versions.
• 3: Beta version (ex. 7.0B1).
• 4: Candidate version (ex. 7.0C1)
• 5: Project release version (ex. 7.0P1)
• 6: Official release version (ex. 7.0R1)

Local Control

Eaton User Manual | page 311


30 - Appendices

Data Point Name Description

_smp___setLocalControl This binary output point allows you to switch from local control
operation mode (by the SMP Gateway local HMI only) to remote
control operation mode (by the SCADA or the SMP Gateway HMI).
_smp___localControl indicates the current control operation mode
state of the SMP Gateway.
Important Note: When in local control operation mode, the only way
to set the control operation mode to remote is from the station’s local
HMI.

_smp___localControl If set to 1, this binary input point indicates that the SMP Gateway is
actually controlled locally, by the SMP Gateway local HMI.
If this point is set to 0, the gateway is currently controlled by the
SCADA or locally by the SMP Gateway HMI (local or remote).
When the SMP Gateway starts up for the first time, this point is set
to 0. The value of this point is persisted, i.e. its value is stored in
non-volatile memory and is not reset to 0 when the SMP Gateway
restarts.

SMP Gateway HMI (Alarms)

_annunciator___alarmActiveCount This analog input point states the number of active alarms.

_annunciator___alarmBlockedCount This analog input point states the number of blocked alarms.

_annunciator___alarmConfigCount This analog input point states the number of data points configured to
trigger alarms.

_annunciator___alarmToAckCount This analog input point states the number of alarms that require
acknowledgment.

_annunciator___alarmToClearCount This analog input point states the number of alarms that have been
acknowledge and that may be cleared.

_annunciator___generalAlarm If set to 1, this binary input point indicates that at least one alarm is
currently active.

SMP Gateway HMI

_smp___commissioningActivated This binary input indicates that commissioning has been activated.

_smp___commissioningInProgress This binary input indicates that the commissioning session has been
started.

Security

_smp___securityAccountLocked This binary input point shows if there is an account locked on the
SMP Gateway.

_smp___securityLogonFailureCount This analog input point states the number of unsuccessful user logon
attempts.

User Manual | page 312 Eaton


30 - Appendices

Data Point Name Description

_smp___securityLogonFailure This binary input point indicates if a user logon attempt failed since
last _smp___secLogFailCnt counter reset.

_smp___securityLogonFailureCountReset This binary output point allows you to reset the


_smp___secLogFailCnt analog input point to 0. It also resets the
_smp___secLogFail binary input point to 0.

Remote Access

_smp___dialupEnable This binary output point allows you to accept or block all incoming
RAS dial up connections to the SMP Gateway. Set it to 1 to accept all
(available on the SMP 4/DP platform)
incoming RAS dial up connections. _smp__dialupEnabled indicates
the resulting state.

_smp___dialupEnabled This binary input point indicates if all incoming RAS dialup
connections to the SMP Gateway are accepted of blocked. If set to 1,
(available on the SMP 4/DP platform)
all connections are accepted.

_smp___dialupInUse This binary input point indicates whether or not there is actually
communication in progress via an incoming RAS dialup connection.
(available on the SMP 4/DP platform)

Passthrough (for each passthrough connection named <connection>)

_smp___<connection>Enable This binary output point allows you to lock or unlock the
passthrough connection. Set it to 0 to lock the connection.
_smp___<connection>Enabled indicates if the connection is locked or
not.

_smp___<connection>Enabled This binary input point indicates the passthrough connection lock
state. If set to 0, the connection is locked and cannot be used.

_smp___<connection>InUse If set to 1, this binary input point indicates that the passthrough
connection is currently active.

Redundancy - Available only on the SMP SG-42xx platform

_smp___rsLocal_ok If set to 1, this binary input point indicates that the SMP Gateway is
currently operational.
This point is mirrored in the _smp___rsRemote_ok binary input point
of the other SMP Gateway of the group.

_smp___rsRemote_ok If set to 1, this binary input point indicates that the other
SMP Gateway of the group is currently operational.
This point is mirrored in the _smp___rsLocal_ok binary input point of
the other SMP Gateway.

_smp___rsLocal_active If set to 1, this binary input point indicates that the SMP Gateway is
active.
If set to 0, it indicates that the SMP Gateway is on standby.

Eaton User Manual | page 313


30 - Appendices

Data Point Name Description

_smp___rsRemote_standby If set to 1, this binary input point indicates that the other
SMP Gateway of the group is on standby.
If set to 0, it indicates that the other SMP Gateway of the group is
active.

_smp___rsRemote_hotStandby If set to 1, this binary input point indicates that the other
SMP Gateway of the group is on hot standby.
For more information about Hot-Standby, refer to section Hot Standby
(page 252).

_smp___rsFirstConnection_ok If set to 1, this binary input point indicates that the first link between
the redundant SMP Gateways is operational.

_smp___rsSecondConnection_ok If set to 1, this binary input point indicates that the second link
between the redundant SMP Gateways is operational.

_smp___rsSynchronized If set to 1, this binary input point indicates that the RTDX databases
of both SMP Gateways of a group are synchronized.

_smp___rsLan_ok If set to 1, this binary input point indicates that SMP Gateway access
to the LAN is operational. This point state can be used as a failover
condition.

_smp___rsTemp_ok If set to 1, this binary input point indicates that the internal
temperature of the SMP Gateway is within an acceptable range. This
point state can be used as a failover condition.

_smp___rsMem_ok If set to 0, this binary input point indicates that the SMP Gateway is
running low on memory. This point state can be used as a failover
condition.

_smp___rsGroupAddress_ok If set to 0, this binary input point indicates that the public IP address
defined for the group conflicts with another device that uses the same
address. This point state can be used as a failover condition.

_smp___rsGatewayA If set to 1, this binary input indicates that this is the SMP Gateway A
of the redundancy group.
If set to 0, it indicates that this is the SMP Gateway B of the group.

Soft PLC

_smp___plcProgramRunning If set to 1, the binary input point indicates that a Soft PLC automation
script is currently running on the SMP Gateway.

Built-in Ethernet Ports

_smp___ENET1_LinkState If set to 1, this binary input point indicates that the Built-in Ethernet
port 1 is connected to an Ethernet cable.

_smp___ENET2_LinkState If set to 1, this binary input point indicates that the Built-in Ethernet 2
port is connected to an Ethernet cable.

User Manual | page 314 Eaton


30 - Appendices

Data Point Name Description

Communication Modules’ Ethernet Ports: Available only on the SMP SG-42xx platform

Important: The following points exist only if the Communication Modules’ ENET Cards,
located in slot C or D, are installed and enabled in the SMP Config Hardware configuration.

_smp___ENETC1_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot C1is connected to an Ethernet
cable.

_smp___ENETC2_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot C2 is connected to an Ethernet
cable.

_smp___ENETC3_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot C3 is connected to an Ethernet
cable.

_smp___ENETC4_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot C4 is connected to an Ethernet
cable.

_smp___ENETD1_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot D1is connected to an Ethernet
cable.

_smp___ENETD2_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot D2 is connected to an Ethernet
cable.

_smp___ENETD3_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot D3 is connected to an Ethernet
cable.

_smp___ENETD4_LinkState If set to 1, this binary input point indicates that the Communication
Module’s Ethernet port located in Slot D4 is connected to an Ethernet
cable.

30.2. RTDX status flags


Each data point value that is stored in the real-time database (RTDX) of an SMP Gateway is
tagged with a quality attribute called “RTDX status”. This attribute gives additional information
about the precision of the value, the state of the IED that provided the value or the quality of the
corresponding timestamp.
The RTDX status attribute consists in a 16-bit value divided into flags. The 12 less significant
bits are used to define the quality of the value, while the 4 most significant bits define the quality
of the corresponding timestamp. Each status bit (flag) is independent of the others (except for
the timestamp status flags), which means that a given value can be tagged with more than one
status flags at the time.

Eaton User Manual | page 315


30 - Appendices

The following table presents the RTDX status flags that are currently supported by the
SMP Gateway software and tools:
Table 33 - RTDX status flags
RTDX Status Flag Value Description

OK / Good 0x0000 Indicates that the value is valid.

Unknown 0x0001 Indicates that the corresponding data point exists within RTDX,
but that it was never updated by a master or system component.

Restart 0x0002 Indicates that either the originating IED or some other device
along the reporting path is currently being restarted. This implies
that no valid status was retrieved for the corresponding data
point since the last SMP Gateway reset.

Note: This status flag is DNP3-specific.

Communication failure 0x0004 Indicates that the connection with the originating IED is currently
lost, which implies that the value that is stored in RTDX for the
corresponding data point is the last reported value.

Forced 0x0008 Indicates that the reported value was not retrieved through
normal acquisition or by exception, but was forced by a human
operator or by some automated process to provide “to the best
of our knowledge” type information with no other guarantee.

Bad hardware 0x0010 Indicates that the reported value is of a doubtful nature due to
known hardware problems. The value might be valid, but cannot
be guaranteed.

Over range 0x0020 Indicates that the reported value is outside its normal range.
This may be a direct indication from the D/A converter, or from a
software component that detected that the value has reached its
maximum possible value (positive or negative).

Note: This status flag is reserved for analog input and


output points.

Bad reference 0x0040 Indicates that the reported value provides from an analog
acquisition chain containing at least one invalid reference
channel. Best case is that the reported value is valid, but not
accurate.

Note: This status flag is reserved for analog input and


output points.

Reserved 0x0080 Reserved for internal use.

User Manual | page 316 Eaton


30 - Appendices

RTDX Status Flag Value Description

Inhibited 0x0100 Indicates that the corresponding data point was logically
inhibited by a human operator or an automation process.
An inhibited input point will no longer be reported, as long as it
remains inhibited, and the current value is the last one that was
reported prior to the inhibition.
An inhibited output point cannot be operated, as long as it
remains inhibited.

Out of range. 0x0200 Indicates that the value is outside an expected range of values
based on intrinsic hardware limitations.
For example, consider a sensor that produces a ±4 V signal,
although the actual limitation of the hardware is ±5 V. No status
flag would be raised for a 3.9 V value; however, a 4.1 V value
would raise the “Out of range” flag, while a 5.0 V value would
raise both the “Out of range” and “Over range” status flags.
An out-of-range value should be considered with caution, since
this is an abnormal condition that usually points to a sensor
defect or a physical installation issue.

CAUTION: This status flag should be confused with


alarm and warning threshold that may be defined by users
and operators. Based on the example above, the user may
decide that any value larger than 3.0 V should trigger an
alarm. That does not necessarily means that the value is
incorrect, but that the operators should have a closer look to
the originating device.

Note: This status flag is reserved for analog input and


output points.

Simulated 0x0400 Indicates that the reported value was not retrieved through
normal acquisition or by exception, but was simulated by a
human operator using the Commissioning tool.
This status flag is similar to the Forced status flag, although
simulated values cannot be persisted, which means that they
will not be preserved when the SMP Gateway restarts, even if
persistence is configured for the corresponding data points.

Timestamp from unsynchronized 0x2000 Indicates that the timestamp of the value was generated
device by a device that was not properly synchronized with a time
synchronization source.

Eaton User Manual | page 317


30 - Appendices

RTDX Status Flag Value Description

Original timestamp 0xC000 Indicates that the timestamp was generated by the device along
with the value.
If this status flag is not asserted, it means that the timestamp
was generated by the SMP Gateway during the scan operation
that retrieved the value (i.e. the timestamp is actually the
acquisition time).

Note: This status flag is always asserted for


SMP Gateway system data points values.

User Manual | page 318 Eaton

You might also like