SIMATIC Energy Suite V19.

0
Preface

Basics of the SIMATIC

Energy Suite 1

2
SIMATIC Supply energy data

Process energy data 3

SIMATIC Energy Suite V19.0 Buffering and archiving
4
energy data

Generate energy program 5

Function Manual
Visualizing and evaluating
energy data 6
Optimizing energy
consumptions 7

Energy Efficiency Monitor 8

Energy Suite blocks -
Acquisition A
Energy Suite blocks - Load
management B
Energy Suite blocks -
Energy Efficiency Monitor C

Service & Support D

12/2023
A5E36824823-AH
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.

DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION
indicates that minor personal injury can result if proper precautions are not taken.

NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualified personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:

WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks
All names identified by ® are registered trademarks of Siemens Aktiengesellschaft. The remaining trademarks in
this publication may be trademarks whose use by third parties for their own purposes could violate the rights of
the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.

Siemens Aktiengesellschaft A5E36824823-AH Copyright © Siemens 2023.

Digital Industries Ⓟ 01/2024 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Preface

Purpose of the documentation

This documentation supports you in the configuration and commissioning of the energy
management functions of SIMATIC Energy Suite in STEP 7 (TIA Portal).

Basic knowledge required

The following knowledge is required in order to understand the documentation:
• Proficiency with STEP 7 (TIA Portal) and WinCC (TIA Portal)
• Proficiency with handling measurement hardware for provision of energy data

Validity of the documentation

This documentation is valid for SIMATIC Energy Suite V19.0.

Conventions
Read also the following highlighted information:

Note
The notes contain important information on the product described in the documentation, on
the handling of the product or on the part of the documentation to which particular attention
should be paid.

Additional assistance
• Information about the technical support available can be found in the appendix to this
documentation.
• The range of technical documentation for the individual SIMATIC products and
automation systems is available on the Internet
(http://www.siemens.com/simatic-tech-doku-portal).
• The online catalog and the ordering system are available on the Internet
(https://mall.industry.siemens.com).

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 3
Preface

Cybersecurity information
Siemens provides products and solutions with industrial cybersecurity functions that support
the secure operation of plants, systems, machines, and networks.
In order to protect plants, systems, machines, and networks against cyber threats, it is
necessary to implement – and continuously maintain – a holistic, state-of-the-art industrial
cybersecurity concept. Siemens’ products and solutions constitute one element of such a
concept.
Customers are responsible for preventing unauthorized access to their plants, systems,
machines and networks. Such systems, machines and components should only be connected
to an enterprise network or the internet if and to the extent such a connection is necessary
and only when appropriate security measures (e.g. firewalls and/or network segmentation)
are in place.
For more information on protective industrial cybersecurity measures for implementation,
please visit (https://www.siemens.com/global/en/products/automation/topic-areas/industrial-
cybersecurity.html).
Siemens' products and solutions undergo continuous development to make them more
secure. Siemens strongly recommends that product updates are applied as soon as they are
available and that the latest product versions are used. Use of product versions that are no
longer supported, and failure to apply the latest updates may increase customers' exposure to
cyber threats.
To stay informed about product updates at all times, subscribe to the Siemens Industrial
Cybersecurity RSS Feed under
(https://new.siemens.com/global/en/products/services/cert.html).

Data protection
Siemens observes the principles of data protection, in particular the principle of data
minimization (privacy by design). This means for this SIMATIC product, the product does not
process / save any personal information.

SIMATIC Energy Suite V19.0

4 Function Manual, 12/2023, A5E36824823-AH
Table of contents

Preface ............................................................................................................................................................. 3
1 Basics of the SIMATIC Energy Suite ..................................................................................................... 13
1.1 Energy Management with SIMATIC Energy Suite................................................................. 13
1.2 SIMATIC Energy Suite operations and components ............................................................. 14
1.3 Procedural overview........................................................................................................... 18
1.4 Performance features and conventions............................................................................... 21
2 Supply energy data .............................................................................................................................. 24
2.1 Energy Management with SIMATIC Energy Suite................................................................. 24
2.2 Important information on energy data ............................................................................... 26
2.3 Energy data from measurement hardware.......................................................................... 28
2.4 Energy data from the process image or bit memory area of the S7-CPU............................... 31
2.5 Energy data from data blocks ............................................................................................. 33
3 Process energy data............................................................................................................................. 34
3.1 Acquisition objects and energy acquisition program ........................................................... 34
3.2 Creating an acquisition object table.................................................................................... 36
3.3 Adding acquisition objects for acquisition object tables....................................................... 37
3.4 Setting the properties of the acquisition objects ................................................................. 39
3.4.1 Configuring an acquisition object ....................................................................................... 39
3.4.2 Basic settings ..................................................................................................................... 40
3.4.3 Project information ............................................................................................................ 40
3.4.4 Identification & Maintenance ............................................................................................. 41
3.4.5 Change the enable for acquisition objects for the energy program ...................................... 41
3.4.6 Energy data source ............................................................................................................ 42
3.4.6.1 Assign energy data source.................................................................................................. 42
3.4.6.2 Energy data source ............................................................................................................ 44
3.4.6.3 Energy data type ................................................................................................................ 46
3.4.7 Periodic energy values ....................................................................................................... 49
3.4.7.1 Setting energy values for periodic archiving ....................................................................... 49
3.4.7.2 Periodic energy data .......................................................................................................... 50
3.4.8 Processing ......................................................................................................................... 52
3.4.8.1 General processing settings................................................................................................ 52

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 5
Table of contents

4 Buffering and archiving energy data .................................................................................................. 54

4.1 Defining archiving periods ................................................................................................. 54
4.2 Archiving periods ............................................................................................................... 56
4.3 Setting the archiving on a S7-CPU (SIMATIC Memory Card) ................................................. 58
4.4 Archiving and buffering (S7-CPU) ....................................................................................... 59
4.5 Example for archiving (S7 CPU) .......................................................................................... 60
4.6 Setting the archiving on a PC station with WinCC Professional/WinCC Unified (Data Log) ..... 61
4.7 Archiving and buffering (WinCC Professional/WinCC Unified) .............................................. 62
4.8 Examples of archiving and buffering (WinCC Professional/WinCC Unified) ........................... 66
5 Generate energy program ................................................................................................................... 68
5.1 Making general settings for the energy program ................................................................ 68
5.2 General settings................................................................................................................. 69
5.3 Runtime licenses for Energy Suite....................................................................................... 70
5.4 Support for Modbus devices ............................................................................................... 72
5.5 Generate energy program .................................................................................................. 74
5.6 Structure of the energy program ........................................................................................ 78
5.6.1 Structure of the energy program ........................................................................................ 78
5.6.2 EnS - block types ................................................................................................................ 79
5.6.3 EnS - program blocks ......................................................................................................... 81
5.6.4 Acquisition objects............................................................................................................. 84
5.6.5 Energy Suite - data types.................................................................................................... 85
5.6.6 Driver blocks for measurement hardware ........................................................................... 86
5.6.6.1 Structure of the energy program for measurement hardware ............................................. 86
5.6.6.2 Energy data processing based on the "IPO" principle ........................................................... 87
5.6.6.3 Area: Input ........................................................................................................................ 88
5.6.6.4 Area: Processing ................................................................................................................ 88
5.6.6.5 Area: Output...................................................................................................................... 91
5.7 Compiling and downloading the PLC program .................................................................... 93
5.8 Testing the energy program ............................................................................................... 94
5.9 Editing the PLC program without installation of Energy Suite .............................................. 95
5.10 PLC program without measurement hardware library with driver blocks ............................. 96
6 Visualizing and evaluating energy data .............................................................................................. 97
6.1 Procedural overview of archiving and visualization with WinCC Professional/WinCC
Unified .............................................................................................................................. 97
6.2 Energy values on PC station with WinCC Professional/WinCC Unified ................................... 99
6.3 Displaying energy values for archiving in WinCC Professional/WinCC Unified ..................... 100
6.4 Overview of energy data .................................................................................................. 102
6.5 Create archiving structure for energy values ..................................................................... 103
6.6 Data log and segmentation for Energy Suite ..................................................................... 108

SIMATIC Energy Suite V19.0

6 Function Manual, 12/2023, A5E36824823-AH
 Table of contents

6.7 Archiving energy data ...................................................................................................... 109

6.8 Create screens for Energy Suite with SiVArc ...................................................................... 110
6.8.1 Create SiVArc screen rules and copy rules for Energy Suite ................................................ 110
6.8.2 Create screens for Energy Suite ........................................................................................ 112
6.8.3 Visualization screens for acquisition objects and load management .................................. 113
6.9 Visualize energy data with WinCC Online Trend View........................................................ 147
6.10 Evaluate energy data with Energy Suite Export Tool.......................................................... 148
6.11 Using Conversion tool ...................................................................................................... 155
6.12 Using Data Transfer Tool .................................................................................................. 156
7 Optimizing energy consumptions ..................................................................................................... 157
7.1 Load management with Energy Suite ............................................................................... 157
7.2 Procedural overview for load management....................................................................... 160
7.3 Performance features and conventions............................................................................. 162
7.4 Optimize energy consumptions ........................................................................................ 165
7.4.1 Energy program for load management ............................................................................. 165
7.4.2 Activating forecast feature of an acquisition object ........................................................... 167
7.4.3 Creating a load management system................................................................................ 169
7.4.4 Setting the properties of a load management system ....................................................... 170
7.4.4.1 Configuring a load management system .......................................................................... 170
7.4.4.2 General settings............................................................................................................... 171
7.4.5 Adding an actuator .......................................................................................................... 172
7.4.6 Setting the properties of the actuator ............................................................................... 173
7.4.6.1 Configuring an actuator ................................................................................................... 173
7.4.6.2 General settings............................................................................................................... 174
7.5 Generate energy program for load management .............................................................. 176
7.5.1 Generate energy program ................................................................................................ 176
7.5.2 Structure of energy program ............................................................................................ 180
7.5.2.1 Structure of energy program ............................................................................................ 180
7.5.2.2 EnS - block types .............................................................................................................. 180
7.5.2.3 Acquisition objects ........................................................................................................... 182
7.5.2.4 EnS - program blocks ....................................................................................................... 183
7.5.2.5 LMGT - systems ................................................................................................................ 184
7.5.2.6 Energy Suite data types .................................................................................................... 185
7.5.3 Configuring load management parameters with library elements ..................................... 187
8 Energy Efficiency Monitor ................................................................................................................. 190
8.1 Basic information of Energy Efficiency Monitor ................................................................. 190
8.2 Configuring the Energy Efficiency Monitor system ............................................................ 191
8.3 Generate energy program for Energy Efficiency Monitor ................................................... 192
8.4 Structure of energy program ............................................................................................ 196
8.4.1 Structure of energy program for energy efficiency monitor ............................................... 196
8.4.2 EnS - block types .............................................................................................................. 197
8.4.3 Acquisition objects ........................................................................................................... 198
8.4.4 EnS - program blocks ....................................................................................................... 198
8.4.5 Energy efficiency monitor - systems ................................................................................. 199

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 7
Table of contents

8.4.6 Energy Suite data types.................................................................................................... 199

8.5 Visualizating screens for Energy Efficiency Monitor........................................................... 200
8.5.1 Configuring the system for visualizing screens.................................................................. 200
8.5.2 Visualization screens overview ......................................................................................... 204
A Energy Suite blocks - Acquisition ...................................................................................................... 207
A.1 Overview of Energy Suite blocks for acquisition ................................................................ 207
A.2 Function blocks (FBs) ....................................................................................................... 211
A.2.1 EnS_ArchiveDataLog: Write energy values to data logs ..................................................... 211
A.2.1.1 Description of EnS_ArchiveDataLog .................................................................................. 211
A.2.1.2 Parameters of EnS_ArchiveDataLog .................................................................................. 213
A.2.1.3 Parameter status.............................................................................................................. 215
A.2.1.4 Alarms of EnS_ArchiveDataLog......................................................................................... 218
A.2.2 EnS_ArchiveHMI: Write energy values to data logs............................................................ 221
A.2.2.1 Description of EnS_ArchiveHMI ........................................................................................ 221
A.2.2.2 WinCC Professional component........................................................................................ 223
A.2.2.3 Parameters of EnS_ArchiveHMI ........................................................................................ 224
A.2.2.4 Parameter status.............................................................................................................. 225
A.2.2.5 Alarms of EnS_ArchiveHMI ............................................................................................... 227
A.2.3 EnS_BufferRead: Reading energy values from data blocks ................................................. 229
A.2.3.1 Description of EnS_BufferRead ......................................................................................... 229
A.2.3.2 Parameters of EnS_BufferRead ......................................................................................... 230
A.2.3.3 Parameter status.............................................................................................................. 230
A.2.4 EnS_BufferWrite: Write energy values to data blocks......................................................... 231
A.2.4.1 Description of EnS_BufferWrite ........................................................................................ 231
A.2.4.2 Parameters of EnS_BufferWrite......................................................................................... 232
A.2.4.3 Parameter status.............................................................................................................. 233
A.2.5 EnS_CalcEnergyData: Calculating energy values ............................................................... 234
A.2.5.1 Description of EnS_CalcEnergyData .................................................................................. 234
A.2.5.2 Parameters of EnS_CalcEnergyData .................................................................................. 238
A.2.5.3 Parameter status.............................................................................................................. 238
A.2.6 EnS_DrvAnalogValue: Acquire power values of the REAL type ........................................... 240
A.2.6.1 Description of EnS_DrvAnalogValue ................................................................................. 240
A.2.6.2 Parameters of EnS_DrvAnalogValue ................................................................................. 240
A.2.6.3 Parameter status.............................................................................................................. 241
A.2.6.4 Alarms of EnS_DrvAnalogValue ........................................................................................ 241
A.2.7 EnS_DrvCounterLInt: Acquire energy counter values of the LINT type................................ 242
A.2.7.1 Description of EnS_DrvCounterLInt................................................................................... 242
A.2.7.2 Parameters of EnS_DrvCounterLInt ................................................................................... 242
A.2.7.3 Parameter status.............................................................................................................. 243
A.2.7.4 Alarms of EnS_DrvCounterLInt ......................................................................................... 243
A.2.8 EnS_DrvCounterLReal: Acquire energy counter values of the LREAL type ........................... 244
A.2.8.1 Description of EnS_DrvCounterLReal ................................................................................ 244
A.2.8.2 Parameters of EnS_DrvCounterLReal................................................................................. 244
A.2.8.3 Parameter status.............................................................................................................. 245
A.2.8.4 Alarms of EnS_DrvCounterLReal ....................................................................................... 245
A.2.9 EnS_DrvPulse: Acquiring pulse signals .............................................................................. 246
A.2.9.1 Description of EnS_DrvPulse............................................................................................. 246
A.2.9.2 Parameters of EnS_DrvPulse ............................................................................................. 246
A.2.9.3 Parameter status.............................................................................................................. 247
A.2.9.4 Alarms of EnS_DrvPulse ................................................................................................... 247

SIMATIC Energy Suite V19.0

8 Function Manual, 12/2023, A5E36824823-AH
 Table of contents

A.2.10 EnS_EnergyDataAdv: Providing advanced energy values ................................................... 248

A.2.10.1 Description of EnS_EnergyDataAdv................................................................................... 248
A.2.10.2 Parameters of EnS_EnergyDataAdv................................................................................... 248
A.2.10.3 Parameter status .............................................................................................................. 248
A.2.11 EnS_EnergyDataAdvMinMax: Providing advanced minimum and maximum values............ 249
A.2.11.1 Description of EnS_EnergyDataAdvMinMax ...................................................................... 249
A.2.11.2 Parameters of EnS_EnergyDataAdvMinMax ...................................................................... 249
A.2.11.3 Parameter status .............................................................................................................. 249
A.2.12 EnS_EnergyDataBasic: Providing metadata and energy values........................................... 250
A.2.12.1 Description of EnS_EnergyDataBasic ................................................................................. 250
A.2.12.2 Parameters of EnS_EnergyDataBasic ................................................................................. 250
A.2.12.3 Parameter status .............................................................................................................. 252
A.2.12.4 Alarms of EnS_EnergyDataBasic ....................................................................................... 252
A.2.13 EnS_Organization: Providing organizational data .............................................................. 255
A.2.13.1 Description of EnS_Organization ...................................................................................... 255
A.2.13.2 Parameters of EnS_Organization ...................................................................................... 255
A.2.14 EnS_TimeSync: Synchronize timers................................................................................... 256
A.2.14.1 Description of EnS_TimeSync ........................................................................................... 256
A.2.14.2 Parameters of EnS_TimeSync ........................................................................................... 258
A.2.14.3 Parameter status .............................................................................................................. 259
A.2.14.4 Alarms of EnS_TimeSync .................................................................................................. 262
A.2.15 EnS_EnergyDataAdd: Linking the additional data .............................................................. 263
A.2.15.1 Description of EnS_EnergyDataAdd .................................................................................. 263
A.2.15.2 Parameters of EnS_EnergyDataAdd .................................................................................. 264
A.2.15.3 Parameter status .............................................................................................................. 264
A.3 Data blocks (DBs) ............................................................................................................. 265
A.3.1 EnS_BufferDB................................................................................................................... 265
A.3.1.1 Description of EnS_BufferDB ............................................................................................ 265
A.3.1.2 Structure of EnS_BufferDB................................................................................................ 265
A.3.2 EnS_BufferWorkDB........................................................................................................... 266
A.3.2.1 Description of EnS_BufferWorkDB..................................................................................... 266
A.3.2.2 Structure of EnS_BufferWorkDB........................................................................................ 266
A.4 User-defined data types (UDTs) ........................................................................................ 267
A.4.1 EnS_typeAnalogValue ...................................................................................................... 267
A.4.1.1 Description of EnS_typeAnalogValue ................................................................................ 267
A.4.1.2 Structure of EnS_typeAnalogValue ................................................................................... 267
A.4.2 EnS_typeBufferReadCtrl ................................................................................................... 267
A.4.2.1 Description of EnS_typeBufferReadCtrl ............................................................................. 267
A.4.2.2 Structure of EnS_typeBufferReadCtrl ................................................................................ 267
A.4.3 EnS_typeBufferReadStat................................................................................................... 268
A.4.3.1 Description of EnS_typeBufferReadStat............................................................................. 268
A.4.3.2 Structure of EnS_typeBufferReadStat ................................................................................ 268
A.4.4 EnS_typeBufferWork ........................................................................................................ 268
A.4.4.1 Description of EnS_typeBufferWork .................................................................................. 268
A.4.4.2 Structure of EnS_typeBufferWork ..................................................................................... 269
A.4.5 EnS_typeBufferWriteCtrl................................................................................................... 270
A.4.5.1 Description of EnS_typeBufferWriteCtrl............................................................................. 270
A.4.5.2 Structure of EnS_typeBufferWriteCtrl ................................................................................ 270
A.4.6 EnS_typeBufferWriteStat .................................................................................................. 270
A.4.6.1 Description of EnS_typeBufferWriteStat ............................................................................ 270
A.4.6.2 Structure of EnS_typeBufferWriteStat ............................................................................... 270

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 9
Table of contents

A.4.7 EnS_typeEnergyAdv ......................................................................................................... 271

A.4.7.1 Description of EnS_typeEnergyAdv ................................................................................... 271
A.4.7.2 Structure of EnS_typeEnergyAdv ...................................................................................... 271
A.4.8 EnS_typeEnergyBasic ....................................................................................................... 272
A.4.8.1 Description of EnS_typeEnergyBasic ................................................................................. 272
A.4.8.2 Structure of EnS_typeEnergyBasic .................................................................................... 272
A.4.9 EnS_typeEnergyCounter .................................................................................................. 273
A.4.9.1 Description of EnS_typeEnergyCounter ............................................................................ 273
A.4.9.2 Structure of EnS_typeEnergyCounter................................................................................ 273
A.4.10 EnS_typeEnergyMeta ....................................................................................................... 274
A.4.10.1 Description of EnS_typeEnergyMeta................................................................................. 274
A.4.10.2 Structure of EnS_typeEnergyMeta .................................................................................... 274
A.4.11 EnS_typeHMIWriteCtrl...................................................................................................... 277
A.4.11.1 Description of EnS_typeHMIWriteCtrl................................................................................ 277
A.4.11.2 Structure of EnS_typeHMIWriteCtrl................................................................................... 277
A.4.12 EnS_typeHMIWriteStat ..................................................................................................... 278
A.4.12.1 Description of EnS_typeHMIWriteStat ............................................................................... 278
A.4.12.2 Structure of EnS_typeHMIWriteStat .................................................................................. 278
A.4.13 EnS_typeOrgData............................................................................................................. 279
A.4.13.1 Description of EnS_typeOrgData ...................................................................................... 279
A.4.13.2 Structure of EnS_typeOrgData.......................................................................................... 279
A.4.14 EnS_typeSync .................................................................................................................. 279
A.4.14.1 Description of EnS_typeSync ............................................................................................ 279
A.4.14.2 Structure of EnS_typeSync ............................................................................................... 279
A.4.15 EnS_typeValue................................................................................................................. 280
A.4.15.1 Description of EnS_typeValue........................................................................................... 280
A.4.15.2 Structure of EnS_typeValue .............................................................................................. 280
A.4.16 EnS_typeEnergyAdd......................................................................................................... 280
A.4.16.1 Description of EnS_typeEnergyAdd................................................................................... 280
A.4.16.2 Structure of EnS_typeEnergyAdd...................................................................................... 280
A.4.17 Ens_typeEnergyAddValue ................................................................................................ 281
A.4.17.1 Description of Ens_typeEnergyAddValue .......................................................................... 281
A.4.17.2 Structure of Ens_typeEnergyAddValue.............................................................................. 281
A.5 Definition of enumerations .............................................................................................. 282
A.5.1 Enumeration for the connection type of the measuring device ......................................... 282
A.5.2 Enumeration for units ...................................................................................................... 283
B Energy Suite blocks - Load management .......................................................................................... 284
B.1 Energy Suite blocks for peak load management................................................................ 284
B.1.1 Overview of Energy Suite blocks for load management..................................................... 284
B.1.2 Function blocks ............................................................................................................... 288
B.1.2.1 EnS_LmgtForecast_x ........................................................................................................ 288
B.1.2.2 EnS_LmgtControl_Peak .................................................................................................... 290
B.1.2.3 EnS_LmgtActuator_x........................................................................................................ 297
B.1.2.4 EnS_LmgtBackupRestore .................................................................................................. 316
B.1.3 Data blocks ...................................................................................................................... 322
B.1.3.1 EnS_LmgtGeneralData ..................................................................................................... 322
B.1.3.2 EnS_LmgtActuatorList ...................................................................................................... 323
B.1.4 User-defined data types (UDTs) ........................................................................................ 324
B.1.4.1 EnS_typeLmgtActuatorElement........................................................................................ 324
B.1.4.2 EnS_typeLmgtActuatorMeta............................................................................................. 325
B.1.4.3 EnS_typeLmgtActuatorParameter..................................................................................... 325

SIMATIC Energy Suite V19.0

10 Function Manual, 12/2023, A5E36824823-AH
 Table of contents

B.1.4.4 EnS_typeLmgtActuatorParameterSet ................................................................................ 326

B.1.4.5 EnS_typeLmgtActuatorStatus ........................................................................................... 327
B.1.4.6 EnS_typeLmgtActuatorStatusInOut .................................................................................. 328
B.1.4.7 EnS_typeLmgtAlarmElement ............................................................................................ 329
B.1.4.8 EnS_typeLmgtControlLimitConfig..................................................................................... 329
B.1.4.9 EnS_typeLmgtControlParameters ..................................................................................... 330
B.1.4.10 EnS_typeLmgtControlParameterSet .................................................................................. 331
B.1.4.11 EnS_typeLmgtControlTimeConfig ..................................................................................... 331
B.1.4.12 EnS_typeLmgtEnergyDiagram .......................................................................................... 332
B.1.4.13 EnS_typeLmgtForecastValues ........................................................................................... 332
B.1.4.14 EnS_typeLmgtGeneralData............................................................................................... 333
B.1.4.15 EnS_typeLmgtJobRequestElement.................................................................................... 334
B.1.4.16 EnS_typeLmgtJobRequestStack ........................................................................................ 335
B.1.4.17 EnS_typeLmgtJobTaskElement ......................................................................................... 335
B.1.4.18 EnS_typeLmgtJobTaskStack.............................................................................................. 336
B.1.4.19 EnS_typeLmgtOrganisation .............................................................................................. 336
B.1.4.20 EnS_typeLmgtTriggerBR ................................................................................................... 337
B.1.4.21 EnS_typeLmgtVisualization .............................................................................................. 338
B.1.4.22 EnS_typeLmgtStorageElement ......................................................................................... 339
B.1.4.23 EnS_typeLmgtStorageParameter ...................................................................................... 340
B.1.4.24 EnS_typeLmgtStorageParameterSet ................................................................................. 340
B.1.4.25 EnS_typeLmgtStorageMeta .............................................................................................. 342
B.1.4.26 EnS_typeLmgtStorageStatus ............................................................................................ 343
B.1.4.27 EnS_typeLmgtStorageStatusInOut .................................................................................... 344
B.2 Energy Suite blocks for base load management ................................................................ 345
B.2.1 Overview of Energy Suite blocks for base load management ............................................. 345
B.2.2 Function blocks................................................................................................................ 347
B.2.2.1 EnS_BaseLmgt_AvgPower ................................................................................................ 347
B.2.2.2 EnS_BaseLmgt_Control .................................................................................................... 348
B.2.2.3 EnS_BaseLmgtActuator_x................................................................................................. 352
B.2.2.4 EnS_BaseLmgtBackupRestore ........................................................................................... 365
B.2.3 Data blocks ...................................................................................................................... 370
B.2.3.1 EnS_BaseLmgtGeneralData .............................................................................................. 370
B.2.3.2 EnS_BaseLmgtActuatorList ............................................................................................... 371
B.2.4 User-defined data types (UDTs) ........................................................................................ 372
B.2.4.1 EnS_typeBaseLmgtActuatorElement ................................................................................. 372
B.2.4.2 EnS_typeBaseLmgtActuatorStatus .................................................................................... 373
B.2.4.3 EnS_typeBaseLmgtControlLimitConfig.............................................................................. 374
B.2.4.4 EnS_typeBaseLmgtControlParameters .............................................................................. 375
B.2.4.5 EnS_typeBaseLmgtControlParameterSet ........................................................................... 375
B.2.4.6 EnS_typeBaseLmgtControlTimeConfig .............................................................................. 376
B.2.4.7 EnS_typeBaseLmgtGeneralData........................................................................................ 376
B.2.4.8 EnS_typeBaseLmgtJobRequestElement............................................................................. 377
B.2.4.9 EnS_typeBaseLmgtJobRequestStack ................................................................................. 378
B.2.4.10 EnS_typeBaseLmgtJobTaskElement .................................................................................. 379
B.2.4.11 EnS_typeBaseLmgtJobTaskStack....................................................................................... 380
B.2.4.12 EnS_typeBaseLmgtVisualization ....................................................................................... 381
B.2.4.13 EnS_typeBaseLmgtAvgValues ........................................................................................... 382
B.2.4.14 EnS_typeBaseLmgtStorageElement .................................................................................. 383
B.2.4.15 EnS_typeBaseLmgtStorageStatus ..................................................................................... 384

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 11
Table of contents

C Energy Suite blocks - Energy Efficiency Monitor ............................................................................... 385

C.1 Function blocks(FBs) ........................................................................................................ 385
C.1.1 EnS_EEm_FunctionCall..................................................................................................... 385
C.1.1.1 Description of EnS_EEm_FunctionCall .............................................................................. 385
C.1.1.2 Parameters of EnS_EEm_FunctionCall............................................................................... 385
C.2 Data blocks(DBs) .............................................................................................................. 386
C.2.1 EnS_EEmData .................................................................................................................. 386
C.2.1.1 Description of EnS_EEmData ............................................................................................ 386
C.2.1.2 Parameters of EnS_EEmData ............................................................................................ 386
C.3 User-defined data types(UDTs) ......................................................................................... 387
C.3.1 EnS_typeEEmData............................................................................................................ 387
C.3.1.1 Description of EnS_typeEEmData ..................................................................................... 387
C.3.1.2 Parameters of EnS_typeEEmData...................................................................................... 387
C.3.2 EnS_typeEEmDataInternal................................................................................................ 388
C.3.2.1 Description of EnS_typeEEmDataInternal.......................................................................... 388
C.3.2.2 Parameters of EnS_typeEEmDataInternal .......................................................................... 388
C.3.3 EnS_typeEEHmiEnMProCommunication ........................................................................... 389
C.3.3.1 Description of EnS_typeEEHmiEnMProCommunication ..................................................... 389
C.3.3.2 Parameters of EnS_typeEEHmiEnMProCommunication ..................................................... 389
C.3.4 EnS_typeEEmMeasPointConfiguration.............................................................................. 390
C.3.4.1 Description of EnS_typeEEmMeasPointConfiguration........................................................ 390
C.3.4.2 Parameters of EnS_typeEEmMeasPointConfiguration........................................................ 390
C.3.5 EnS_EEm_typeComDiagnostics ........................................................................................ 391
C.3.5.1 Description of EnS_EEm_typeComDiagnostics .................................................................. 391
C.3.5.2 Parameters of EnS_EEm_typeComDiagnostics .................................................................. 391
C.3.6 EnS_EEm_typeCommunication ........................................................................................ 392
C.3.6.1 Description of EnS_EEm_typeCommunication .................................................................. 392
C.3.6.2 Parameters of EnS_EEm_typeCommunication................................................................... 392
C.3.7 EnS_EEm_typeEnMProComm ........................................................................................... 393
C.3.7.1 Description of EnS_EEm_typeEnMProComm ..................................................................... 393
C.3.7.2 Parameters of EnS_EEm_typeEnMProComm ..................................................................... 393
D Service & Support .............................................................................................................................. 394
D.1 Service & Support ............................................................................................................ 394
Index ........................................................................................................................................................... 397

SIMATIC Energy Suite V19.0

12 Function Manual, 12/2023, A5E36824823-AH
Basics of the SIMATIC Energy Suite 1
1.1 Energy Management with SIMATIC Energy Suite
Energy management
Globally rising energy costs as well as legal requirements for achieving global climate goals
increasingly motivate industrial enterprises to deal with energy data acquisition and energy
management. The first step to sustainable energy management is to identify the main energy
flows and energy consumers of a company or a production facility and to analyze their
consumption characteristics. This is referred to as "energy transparency".
Measures to improve energy efficiency are specified based on the acquired energy data. The
measures are subsequently implemented in the most effective sequence, technically and
economically. The order of implementation is mainly determined by the factors "savings
potential" and "implementation cost". This means measures with medium savings potential
and low cost may be preferred to measures with high potential and high costs.
Another aspect is legal requirements. These require regular monitoring and reporting of
emissions. The acquired energy data can be used to create company-wide energy
transparency and to form complete energy and material balancing.
In addition to acquisition, visualization, archiving, performance indicator calculation and
energy reporting of energy data are also important factors in energy management.
Additional to the energy management, optimizing of energy consumptions based on the
acquired energy data is becoming vital.

SIMATIC Energy Suite in STEP 7 and WinCC (TIA Portal)

The components of SIMATIC Energy Suite, which we simply refer to as the Energy Suite in the
following, enable you to integrate central functions of the energy management even down
to the level of your automation system. The configuration is made simply and conveniently
directly in the TIA Portal (STEP 7 and WinCC).
Energy Suite records, archives and provides the energy data in the CPU in standardized form.
You can then visualize the energy data and use the data in your automation program (e.g. for
monitoring).
In Energy Suite, you can additionally optimize energy consumption with the introduction of
load management blocks.
Template pictures and faceplates for visualizing the acquired energy data in WinCC
Professional or WinCC Basic, Comfort or Advanced, WinCC Unified are provided by Siemens
Industry Online Support .
In addition, you can process the energy data in SIMATIC Energy Manager:
• For performance indicator calculation, for example, energy costs per produced piece, CO2
emissions per year
• Convenient generation of energy reports, for example, to optimize energy purchasing

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 13
Basics of the SIMATIC Energy Suite
1.2 SIMATIC Energy Suite operations and components

Further processing energy data with SIMATIC Energy Manager

You can directly transfer configuration information from Energy Suite into SIMATIC Energy
Manager and save the additional configuration work involved. SIMATIC Energy Manager,
which we simply refer to as Energy Manager in the following, primarily offers functions for
commercial and enterprise-wide assessment of energy consumption. To optimize the energy
consumption, the relevant energy flows of all the company's energy media must be
transparent.
You use the Energy Manager to create energy and material balances or calculations of
performance indicators, for example. The performance indicators (Key Performance Indicator
(KPI)) enable you to evaluate and compare the energy used in various processes and plants.
The evaluation and comparison is also referred to as "benchmarking". The assignment of
energy costs to the actual consumers results in cost transparency and raising awareness of
employees in regard to the energy consumption of machinery, processes and plants.
You can find additional information about the Energy Manager at Siemens Industry Online
Support (https://support.industry.siemens.com/cs/ww/en/ps/14711).

1.2 SIMATIC Energy Suite operations and components

IPO principle
Energy data processing according to the "IPO" principle can be divided into "Input"
"Processing" and "Output":
• Input: Provision of the input data for processing, for example, by measurement hardware
or calculations within the S7 CPU
• Processing: Acquisition, calculation and provision of energy values for other systems by
acquisition objects in the S7 CPU
• Output: Visualization and archiving of energy values on connected HMI or SCADA systems

SIMATIC Energy Suite V19.0

14 Function Manual, 12/2023, A5E36824823-AH
 Basics of the SIMATIC Energy Suite
1.2 SIMATIC Energy Suite operations and components

Overview
The following figure shows the relationship of the individual Energy Suite components and
the processing steps:

Input measurement data

Raw energy data

Processed instantaneous energy values

Prepared periodic energy values with time stamp

Energy Suite blocks (prefix EnS)

Driver blocks for measurement hardware (prefix EnSL)

FB Function block
Process on an S7 CPU

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 15
Basics of the SIMATIC Energy Suite
1.2 SIMATIC Energy Suite operations and components

Components
The following table shows the components for energy data management with the Energy
Suite:

Area Component / pro- Description

cessing step
Input - Supply S7-CPU S7-1500 CPU configured in STEP 7 project (TIA Portal)
energy data Provides the input measurement data to the "Normalization" function block (FB)
(Page 24)
Measurement hard- Measurement capable hardware of Energy Suite
ware Provides the input measurement data to the "Communication driver" function
block (FB)
Processing - FB "Normalization" Includes the Energy Suite blocks with driver functionality for acquiring, pre-
Process energy processing and harmonization of input measurement data on raw energy data
data (Page 34) Provides the raw energy data for the "Preparation of the energy data" pro-
cessing step
The following Energy Suite blocks are used:
• EnS_DrvAnalogValue (Page 240)
• EnS_DrvCounterLInt (Page 242)
• EnS_DrvCounterLReal (Page 244)
• EnS_DrvPulse (Page 246)
FB "Communication Includes the function blocks with driver functionality (driver blocks) for the
driver" supported measurement hardware
The driver blocks for the measurement hardware are provided in the form of an
Energy Support Library (EnSL) (Page 28) on the SIMATIC Energy Suite product
DVD and must be installed separately (not part of the Energy Suite library).
Provides the raw energy data for the "Preparation of the energy data" pro-
cessing step
Acquisition objects An acquisition object in the Energy Suite is typically a measuring point (for
example, a measuring device or an analog value).
The acquisition object represents the central engineering component where all
settings are made (for example, the assignment of the archiving period and the
energy source data as well as settings for processing of raw energy data).
Preparation of energy Used for calculation, time synchronization and organization of raw energy data
data (for example, compression and periodic time stamping of the energy values)
Passes the prepared instantaneous energy values and prepared periodic energy
values with a time stamp to the "Provision of the energy values" processing step
The following Energy Suite blocks are used:
• EnS_CalcEnergyData (Page 234)
• EnS_TimeSync (Page 256)
• EnS_Organization (Page 255)

SIMATIC Energy Suite V19.0

16 Function Manual, 12/2023, A5E36824823-AH
 Basics of the SIMATIC Energy Suite
1.2 SIMATIC Energy Suite operations and components

Area Component / pro- Description

cessing step
Processing - Provision of the energy Provision of:
Process energy values
• Processed instantaneous energy values on "Visualization - HMI" and "Visuali-
data (Page 34)
zation - SCADA"
• Prepared periodic energy values with time stamp to "Buffering periodic
energy values"
The following Energy Suite blocks are used:
• EnS_EnergyDataBasic (Page 250)
• Ens_EnergyDataAdv (Page 248)
• Ens_EnergyDataAdvMinMax (Page 249)
Buffering of the peri- Buffering of the processed periodic energy values with a time stamp from sev-
odic energy values eral acquisition objects
Provides the energy values to:
• Archiving - WinCC Professional (Data Log) or
• Archiving - S7-CPUs (SIMATIC Memory Card)
The following data blocks (DBs) are used by the Energy Suite:
• EnS_BufferDB (Page 265)
• EnS_BufferWorkDB (Page 266)
• EnS_BufferRead (Page 229)
• EnS_BufferWrite (Page 231)
Output - Visual- Visualization - HMI Visualization of instantaneous energy values on a SIMATIC Comfort Panel or PC
izing and evalu- with WinCC applications (Basic, Comfort or Advanced)
ating energy Visualization - SCADA Visualization of instantaneous energy values or the buffered periodic energy
data (Page 97) values on the WinCC Professional SCADA system
Archiving - WinCC Archiving of buffered periodic energy values in the data log of the WinCC Pro-
Professional (Data Log) fessional SCADA system
The following Energy Suite block is used:
• EnS_ArchiveHMI (Page 221)
Archiving - S7-CPUs Archiving of buffered periodic energy values as data logs (CSV files) on the
(SIMATIC Memory SIMATIC memory card inserted in the S7-1500 CPU
Card) The following Energy Suite block is used:
• EnS_ArchiveDataLog (Page 211)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 17
Basics of the SIMATIC Energy Suite
1.3 Procedural overview

1.3 Procedural overview

Requirement
To perform the following configuration steps, the following requirements must be met in
STEP 7 (TIA Portal):
• The "SIMATIC Energy Suite" add-on package has been installed.
You can find additional information on this in the installation instructions for Energy Suite
on the DVD.
• The STEP 7 project has been created and configured with a CPU S7-1500.
• Valid EnergySuite license must be installed for configuring energy acquisition, and load
management program.
Additionally, when using measurement hardware as an energy data source:
• The Energy Support Library for using future measurement hardware has been installed.
You can find additional information on this in the product documentation for the
measurement hardware.
• The measurement hardware has been created and configured in the STEP 7 project.
You can find additional information on this in the product documentation for the
measurement hardware.
Additionally, for visualization or archiving to data logs:
• The PC station has been created and configured in the STEP 7 project with WinCC
Professional or WinCC Basic, Comfort or Advanced or WinCC Unified.

Configuration steps
The following table provides an overview of the most important configuration steps for
Energy Data Management with the Energy Suite components:

Topic Step Description

Supply energy 1 Supply energy data (Page 24) Create and configure connected measurement hardware
data and/or PLC tags (for example, values of data blocks and/or
from the process image) so that they can be later config-
ured as an energy source for the acquisition objects.
Process energy 2.1 Creating an acquisition object Acquisition object tables are used to create and manage the
data table (Page 36) acquisition objects. Several acquisition object tables enable
the mapping and structuring of the acquisition objects, for
example, based on the measurement hierarchy of your
production plant.
2.2 Adding acquisition objects for In order to acquire and process the energy data from a data
acquisition object tables source of energy, you need to create acquisition objects in
(Page 37) the acquisition object tables.

SIMATIC Energy Suite V19.0

18 Function Manual, 12/2023, A5E36824823-AH
 Basics of the SIMATIC Energy Suite
1.3 Procedural overview

Topic Step Description

Process energy 2.3 Setting the properties of the Each acquisition object represents a measuring point of
data acquisition objects (Page 39) your production plant and must be correspondingly config-
ured.
• Assign energy data source
• Set processing of the input measurement data
• Activate the energy values for archiving and assign the
archive period
• Check the enable of acquisition objects for the energy
program
Buffering and 3.1 Defining archiving periods From a central location, you manage the periodic time
archiving energy (Page 54) intervals (archiving periods) in which the raw energy data
data should be calculated to a prepared periodic energy value
with time stamp and archived.
Each acquisition object can be assigned a desired archiving
period.
3.2 Defining the buffering of peri- For buffering the periodic energy values, you specify the
odic energy values (Page 62) size of the data blocks (buffer DBs).
The number of buffer DBs corresponds to the number of
created acquisition object tables (one buffer DB for each
acquisition object table).
3.3 Setting the archiving on a Define the name, the number and size of data logs for ar-
S7-CPU (SIMATIC Memory Card) chiving the periodic energy values on a SIMATIC memory
(Page 58) card inserted in the S7 CPU. The energy values are entered
in the data logs.
3.4 Setting the archiving on a PC For archiving the periodic energy values in the data log of
station with WinCC Profession- WinCC Professional, select the appropriate check box in the
al/WinCC Unified (Data Log) energy program settings of Energy Suite.
(Page 61) The data logs of WinCC Professional must be set up for this
in the settings of WinCC Professional.
Generate energy 4.1 Making general settings for the Before generating the energy program, set the starting time
program energy program (Page 68) of the blocks in the energy program.
You also define the alarm suppression.
4.2 Check the enable of acquisition At the latest before generating the energy program, you
objects for the energy program need to decide which acquisition objects (and thus which
and adapt it if necessary measuring points) are to be included in the energy pro-
(Page 41) gram. You can easily enable/disable the acquisition objects
in the acquisition object tables.
4.3 Generate energy program You start the generation of the PLC program for energy data
(Page 74) acquisition and processing (or energy program for short)
from the project tree.
During the generating process, the required blocks and data
types from the Energy Suite Library and the measurement
hardware library are automatically used in the energy pro-
gram and interconnected according to the configured ac-
quisition objects.
The generated energy program is created below the S7 CPU
in the "Energy Suite - Program" subfolder of the "Program
blocks" folder.
4.4 Compiling and downloading the Once the energy program is generated, compile the com-
PLC program (Page 93) plete PLC program and download it to the S7-1500 CPU
target system.
4.5 Testing the energy program To check your settings, open the relevant data block of the
(Page 94) respective acquisition object in the energy program and
watch the online values with the "Monitor all" function.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 19
Basics of the SIMATIC Energy Suite
1.3 Procedural overview

Topic Step Description

Visualizing and 5.1 Configuring a PC station with A PC station with the SIMATIC "WinCC RT Professional" HMI
evaluating energy WinCC Professional application is required for the SCADA system.
data (Page 97) 5.2 Creating a connection to the To enable data transfer between the S7-1500 CPU and the
SCADA system SCADA system, configure an HMI connection to the PC
station with WinCC Professional in STEP 7 (TIA Portal).
5.3 Reading and displaying energy On the PC station with WinCC Professional, Energy Suite
values configured for archiving offers an overview of all acquisition objects and the periodic
on the engineering system on energy values that you have configured in the engineering
the PC station (Page 100) system for archiving in the data log of WinCC Professional.
With the "Refresh" function, synchronization is performed
with the engineering data of the S7-1500 CPUs that can be
reached by the PC station with WinCC Professional.
5.4 Configuring the SCADA system Configuring the PC station with WinCC Professional:
(Page 103)
• For data transfer to the SCADA system, generate the
HMI tags for the data blocks for buffering ("HMI tags"
folder).
• For archiving, generate the data log with the logging
tags (energy values) and set up the archive segments
for archiving (Page 108) of the periodic energy values
("Archive" folder).
• For visualization of the collected energy data in runtime,
you can integrate the template screens and screen ele-
ments from the Siemens Industry Online Support into
the WinCC application ("Screens" folder).
5.5 Compiling and downloading the Next you compile the configuration for the entire PC station
PC station with WinCC Profes- and download it to the SCADA system.
sional
5.6 Starting the PLC program and Once WinCC RT Professional is started on the SCADA system
SCADA system (Runtime) and the PLC programs are started on the S7-1500 CPUs,
archiving is ready to begin.
The selected periodic energy values are archived automati-
cally. The archiving is performed continuously while
Runtime is active.

SIMATIC Energy Suite V19.0

20 Function Manual, 12/2023, A5E36824823-AH
 Basics of the SIMATIC Energy Suite
1.4 Performance features and conventions

1.4 Performance features and conventions

Compatibility of Energy Suite with CPU and FW

The following table shows the compatibility of CPUs to respective Energy Suite versions.

CPU / ET 200SP CPU / ET 200SP Open Controller / FW Energy Suite version

Software Controller
S7-1500 CPU ≥ V2.0 V14.0
V14.0 SP1
V15.0
V15.1
V16.0
V17.0
V18.0
Software Controller ≥ V21.9 V18.0

Performance features of Energy Suite

The following table shows the performance features of the Energy Suite:

Characteristic Value
Maximum number of acquisition objects that can be licensed per S7- 999 for firmware V2.8, for
1500 CPU lower versions it is 500
Maximum number of acquisition object tables per S7-1500 CPU 10
Maximum number of S7-1500 CPUs for simultaneous archiving 10
Maximum number of acquisition objects that can be archived simulta- 2000
neously (WinCC Professional)
Recommendation: distributed to a maximum of 10 S7-1500 CPUs
Minimal adjustable archiving period 1 min
Value range of an archiving period Integer part of one hour/one
day, for example:
• 1 minute
• 5 minutes
• 15 minutes
• 12 hours
The following are invalid,
for example:
• 7 minutes
• 11 minutes
• 5 hours
Maximum adjustable archiving period 24 h
Typical archiving period for electrical variables 15 min
Typical archiving period for non-electrical variables 60 min

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 21
Basics of the SIMATIC Energy Suite
1.4 Performance features and conventions

Visualization tags in unified panels

The following table consists of the number of tags used in visualization objects.

Particulars Number of tags

Maximum number of tags in unified panels 16000
Internal tags used in unified panels - acquisition visualization 30
Internal tags used in unified panels - Load management 450
system visualization

Visualization objects Tags required for each visualization object Maximum number of con-
figurable visualization ob-
ject
Acquisition object basic energy data 50 320 to 470
Acquisition object basic and advanced data 80 200 to 250
Acquisition object basic, advanced and addi- 130 120 to 140
tional data

Visualization objects Tags required for each visualization Maximum number of configurable
object visualization object
Load management system 4100 60
Actuator 60 190 to 220

Please note that these figures are approximates and may vary.

Naming conventions
The following table shows the naming conventions for engineering with the Energy Suite:

Object Value range for name Range of validity

PLC • Prohibited characters: • The naming convention of the PLC
– :?"'\*% applies to the archiving of energy
– <space> data of acquisition objects on PC
station with WinCC Professional.
– <line feed>
– <line break>
Acquisition object • 1 - 32 characters • Unique project-wide for archiving
• Prohibited characters: type "WinCC Professional (data log)"
– : ? ' * " \ $ % § °#~ . / [
]`
– <Space>
– <Line feed>
– <Line break>

SIMATIC Energy Suite V19.0

22 Function Manual, 12/2023, A5E36824823-AH
 Basics of the SIMATIC Energy Suite
1.4 Performance features and conventions

Object Value range for name Range of validity

Acquisition object table • 1 - 32 characters • Unique project-wide for archiving
• Prohibited characters: type "WinCC Professional (data log)"
– <Line feed>
– <Line break>
Archiving period • 1 - 32 characters -
• Prohibited characters:
– :?'*"\%§°
– <Space>
– <Line feed>
– <Line break>
Data log • 1 - 26 characters -
• Permitted characters:
– 0 ... 9
– a ... z
– A ... Z
– -
– _

Note
Unique names
The object names must be unique at least CPU-wide. You cannot use a name that has already
been assigned to a block, a PLC tag or a constant within the CPU for a new object. No
distinction is made between upper and lower case when checking the uniqueness of the
name.

See also
Performance features and conventions (Page 162)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 23
Supply energy data 2
2.1 Energy Management with SIMATIC Energy Suite

Energy management
Globally rising energy costs as well as legal requirements for achieving global climate goals
increasingly motivate industrial enterprises to deal with energy data acquisition and energy
management. The first step to sustainable energy management is to identify the main energy
flows and energy consumers of a company or a production facility and to analyze their
consumption characteristics. This is referred to as "energy transparency".
Measures to improve energy efficiency are specified based on the acquired energy data. The
measures are subsequently implemented in the most effective sequence, technically and
economically. The order of implementation is mainly determined by the factors "savings
potential" and "implementation cost". This means measures with medium savings potential
and low cost may be preferred to measures with high potential and high costs.
Another aspect is legal requirements. These require regular monitoring and reporting of
emissions. The acquired energy data can be used to create company-wide energy
transparency and to form complete energy and material balancing.
In addition to acquisition, visualization, archiving, performance indicator calculation and
energy reporting of energy data are also important factors in energy management.
Additional to the energy management, optimizing of energy consumptions based on the
acquired energy data is becoming vital.

SIMATIC Energy Suite in STEP 7 and WinCC (TIA Portal)

The components of SIMATIC Energy Suite, which we simply refer to as the Energy Suite in the
following, enable you to integrate central functions of the energy management even down
to the level of your automation system. The configuration is made simply and conveniently
directly in the TIA Portal (STEP 7 and WinCC).
Energy Suite records, archives and provides the energy data in the CPU in standardized form.
You can then visualize the energy data and use the data in your automation program (e.g. for
monitoring).
In Energy Suite, you can additionally optimize energy consumption with the introduction of
load management blocks.
Template pictures and faceplates for visualizing the acquired energy data in WinCC
Professional or WinCC Basic, Comfort bzw. Advanced, WinCC Unified are provided by Siemens
Industry Online Support .
In addition, you can process the energy data in SIMATIC Energy Manager:
• For performance indicator calculation, for example, energy costs per produced piece, CO2
emissions per year
• Convenient generation of energy reports, for example, to optimize energy purchasing

SIMATIC Energy Suite V19.0

24 Function Manual, 12/2023, A5E36824823-AH
 Supply energy data
2.1 Energy Management with SIMATIC Energy Suite

Further processing energy data with SIMATIC Energy Manager

You can directly transfer configuration information from Energy Suite into SIMATIC Energy
Manager and save the additional configuration work involved. SIMATIC Energy Manager,
which we simply refer to as Energy Manager in the following, primarily offers functions for
commercial and enterprise-wide assessment of energy consumption. To optimize the energy
consumption, the relevant energy flows of all the company's energy media must be
transparent.
You use the Energy Manager to create energy and material balances or calculations of
performance indicators, for example. The performance indicators (Key Performance Indicator
(KPI)) enable you to evaluate and compare the energy used in various processes and plants.
The evaluation and comparison is also referred to as "benchmarking". The assignment of
energy costs to the actual consumers results in cost transparency and raising awareness of
employees in regard to the energy consumption of machinery, processes and plants.
You can find additional information about the Energy Manager at Siemens Industry Online
Support.
Energy data sources provide the energy data for processing (acquisition, processing,
provision) to the acquisition object. The following data sources can be configured as energy
sources of an acquisition object:
• Input measurement data from connected measurement hardware (Page 28)
• Energy data from the process image or the bit memory area of the CPU (PLC tags)
(Page 31)
• Energy data from data blocks (DB tags) (Page 33)
Data exchange of periodic energy data energy counter value, (pulse signal, energy counter
value, power value), from which the basic energy data are calculated, occurs cyclically via the
process image. The measurement hardware provides energy data to acquisitionobjects using
cyclic and acyclic communication. Advanced energy data, for example, voltage, current or
frequency value, are passed in a data record from the measurement hardware to the
acquisition object. The maximum number of parallel acyclic communication channels is
limited to 10.
You assign acquisition data sources for the energy program when you configure the
acquisition objects. Each energy object is assigned an energy data source.

See also
Acquisition objects and energy acquisition program (Page 34)

SIMATIC Energy Suite V19.0

25 Function Manual, 12/2023, A5E36824823-AH
Supply energy data
2.2 Important information on energy data

2.2 Important information on energy data

The following different energy data exists:
• Basic energy data
• Advanced energy data

Basic energy data

Basic energy data includes the following energy data:
• Periodically calculated energy consumption
• Average output per archive period
• Current values for energy and power consumption
Basic energy data is invoice-relevant energy data which is required for visualizing the energy
flows in a plant.
Basic energy data is primarily transmitted by cyclical communication via the process image.

Advanced energy data

Advanced energy data are only read from the measurement hardware which can make this
data available. Advanced energy data includes the following energy data:
• Phase-specific current, voltage, power and power factor values
• Total power, total energy and total power factor values
• Frequency values
Whether and to what extent the advanced energy data is made available depends on the
respective measurement hardware. In addition to supplying the input measured value, the
measurement hardware or the driver block also supply the minimum and maximum values
of the advanced energy data, for example for the output in a faceplate in WinCC
Professional/WinCC Unified.
Advanced energy data is primarily transmitted by acyclic communication in a data record.

Advanced and additional energy data

Hardware devices and softwares that support advance/advance minimum maximum data will
use interface data blocks upon program generation. The interface data block acts as a
channel that allows user customized blocks to interact (create links) with Energy Suite's
advance/advance min max data upon program generation.
Softwares devices when used as acquisition objects, if the "Activate advanced energy data"
check box is selected, the "Automatic acquisition (by acyclic communication via EnSL driver)”
radio button will be disabled, and "Manual linking (via interface DB)" will be enabled by
default. Upon program generation, the EnS_EnergyDataAdv block will be available.

SIMATIC Energy Suite V19.0

26 Function Manual, 12/2023, A5E36824823-AH
 Supply energy data
2.2 Important information on energy data

Hardware data source when used as acquistion objects that suports advanced data, if the
"Activate advanced energy data" check box is selected, then the options “Automatic
acquisition (by acyclic communication via EnSL driver)” and "Manual linking (via interface
DB)" will be enabled, and the “Automatic acquisition (by acyclic communication via EnSL
driver)”.
If user generates program by selecting “Automatic acquisition (by acyclic communication via
EnSL driver)” radio button, then blocks related to hardware data source will be generated. If
user generates program by selecting “Manual linking” radio button, then interface blocks will
be generated.

Cyclic communication
You use cyclic communication for invoice-relevant energy data (for example, power, energy
counters) which is processed for monitoring and calculation functions in the CPU. This data is
read cyclically, quickly and reliably via the process image.
For additional information on the process image, refer to the online help for the TIA Portal
information system under the keyword "Process image".

Acyclic communication
You use acyclic communication for energy data relevant for visualization (e.g. current,
voltage), which is displayed on a SIMATIC Comfort Panel or PC. For the visualization of the
screen opening, for example, this data is communicated for the duration of the screen
opening.
The energy data is read in a data record with the "RDREC" instruction from the corresponding
module. For additional information on the "RDREC" instruction, refer to the online help for the
TIA Portal information system under the keyword "RDREC".
The driver blocks for the measurement hardware call the "RDREC" instruction for acyclic
communication internally.

Note
Use both types of communication depending on the application. Make sure that the
communication channels are not overloaded.

SIMATIC Energy Suite V19.0

27 Function Manual, 12/2023, A5E36824823-AH
Supply energy data
2.3 Energy data from measurement hardware

2.3 Energy data from measurement hardware

A variety of devices can provide energy data. In addition to the measuring instruments (e.g.
ET 200SP AI EnergyMeter 480VAC ST, SENTRON PAC), the sole purpose of which is to
measure energy, many automation devices (for example, frequency converters or protection
devices and switchgear) provide energy data in addition to their actual automation functions
(for example, speed control). In the following, these devices are referred to as measurement
hardware.

Overview of measurement hardware for Energy Suite

The following table shows some examples of devices as measurement hardware that are
supported by SIMATIC Energy Suite. For this purpose, specific function blocks (FBs) with
driver functionality are available for the measurement hardware from the Energy Support
Library (EnSL).

Measurement hardware Description

AI EnergyMeter 480VAC ST Analog input module for the SIMATIC ET 200SP distributed I/O
system for measuring relevant network parameters in the volt-
age range up to 480V AC phase-to-phase voltage
AI EnergyMeter 480VAC HF Analog input module for the SIMATIC ET 200SP distributed I/O
system for measuring relevant network parameters in the volt-
age range up to 480 V AC phase-to-phase voltage
Extended applications and functionality; current measurement
using Rogowski coils or current and voltage transformers
The AI EnergyMeter 480 V AC HF is available in two versions: CT
and RC.
SENTRON PAC3200/PAC4200 Multifunctional measuring instrument for measuring and dis-
playing relevant power system parameters in low-voltage power
distribution
SENTRON 3VA (8x ETU) Molded case circuit breakers for low-voltage power distribution
equipment, for example, for protecting production equipment
against electrical damage
SINAMICS AC/AC Converters for efficient and economical operation of pumps,
fans and compressors, for example
SIMOCODE pro V PN Motor protection and control device for motor management
tasks such as comprehensive protection, monitoring, safety and
control functions between the motor feeder and automation
system
SIMOCODE Current/Voltage measuring modules of V2 are inte-
grated into Energy Suite
ET 200SP/M200D Motor Starter Motor starter for switching and protecting three-phase induc-
tion motors and single-phase AC motors
Soft starter 3RW44 Soft starter for limiting the starting current and the starting
torque. Both mechanical loads and supply voltage failures can
be reliably avoided with this starter.
Soft starter 3RW55 New generation of soft starters for limiting the starting current
and the starting torque. Both mechanical loads and supply volt-
age failures can be reliably avoided with this starter.

SIMATIC Energy Suite V19.0

28 Function Manual, 12/2023, A5E36824823-AH
 Supply energy data
2.3 Energy data from measurement hardware

Device configuration of measurement hardware in STEP 7 (TIA Portal)

The device configuration of the measurement hardware is performed in STEP 7 (TIA Portal).
The following options are available to add the measurement hardware to the hardware
configuration of your project:
• Transfer the device directly from the hardware catalog into the network or topology view
• Add a device not contained in the hardware catalog via a GSD file (device master data file)
or HSP (Hardware Support Packages)
If you want to configure measurement hardware that is not contained in the hardware
catalog, you need to first install the vendor-supplied GSD file or HSP. Using GSD files or HSP,
installed measurement hardware is displayed in the hardware catalog and can then be
selected and configured in the project.
You can find additional information about configuring a device using the GSD file or HSP in
the online help of the TIA Portal information system.

Driver blocks of the measurement hardware for STEP 7 (TIA Portal)

The energy data (input measurement data) of the measurement hardware are made available
in different ways (e.g. differences in the data format or in the data record address).
In addition to the Energy Suite blocks, function blocks (FBs) specific to the measurement
hardware with driver functionality are made available through the Energy Support Library
(EnSL). These hardware-specific function blocks (referred to as driver blocks in the following),
form the interface between the special measurement hardware and your automation system.
The energy data from the measurement hardware is read and uniformly provided to the
automation system using driver blocks. In this way, the raw energy data is provided easier
and faster to your PLC program and Energy Suite. The Energie Suite blocks are then used to
prepare and process raw energy data.

Energy Support Library (EnSL)

Perform the installation of the Energy Support Library according to the installation
instructions for the measurement hardware.
After the successful installation of the Energy Support Library:
• The measurement hardware library with the driver blocks is available in STEP 7 (TIA Portal)
as a global library. The driver blocks can be used in the PLC program.
• The measurement hardware can be assigned an acquisition object for selecting the energy
data source.
You can find additional information about using global libraries in the online help of the TIA
Portal information system.

SIMATIC Energy Suite V19.0

29 Function Manual, 12/2023, A5E36824823-AH
Supply energy data
2.3 Energy data from measurement hardware

Type of communication
The CPU can read the energy data from the measurement hardware in two ways, with cyclic
or acyclic communication. The cyclic energy data is transferred to Energy Suite via the
process image and the acyclic energy data is transferred in a data record of the measurement
hardware.
The type of the communication between the CPU and the measurement hardware depends
on the measurement hardware and the driver blocks used. Normally, the basic energy data is
transferred via cyclic communication, advanced energy data is transferred via acyclic
communication:
• You use cyclic communication for invoice-relevant energy data (for example, power,
energy counters) which is processed for monitoring and calculation functions in the CPU.
• You use acyclic communication for visualization-relevant energy data (e.g. current,
voltage) which is displayed on a SIMATIC Comfort Panel or PC.
You can find additional information on communication between the CPU and the
measurement hardware used in the documentation of the respective measurement
hardware.

Note
If you use multiple pieces of measurement hardware, pay attention to the load on the
communication channels that are supported by the CPU used.

See also
Assign energy data source (Page 42)

SIMATIC Energy Suite V19.0

30 Function Manual, 12/2023, A5E36824823-AH
 Supply energy data
2.4 Energy data from the process image or bit memory area of the S7-CPU

2.4 Energy data from the process image or bit memory area of the
S7-CPU

PLC tags
PLC tags can be used as an energy source for acquisition objects. To do this, create new PLC
tags or use existing PLC tags in the PLC program. Depending on the desired energy data type
(pulse signal, power value or energy counter value) you assign the created PLC tag to an
appropriate data type. You assign the data type of the PLC tag with the declaration in the PLC
tag table. You assign the energy data types to energy data sources with the configuration of
the acquisition object.

Examples
• A measuring instrument that is not supported by the Energy Support Library provides an
power value and a energy counter value. You assign these values to the PLC tags.
• 10 fan motors each have a rated output of 1.5 kW. The motors are controlled by a PLC. In
the PLC, the theoretical consumption is derived from the switching states and rated
power. For example, if five motors are switched on, the resulting power consumption is
7.5 kW. This calculation is performed in the PLC and can be assigned to the PLC tags.

Overview of the relevant data types for PLC tags

The following table shows the relevant data types for PLC tags for energy data acquisition:

Data type Description

BOOL Used to acquire a pulse signal
From an acquired binary pulse signal, the resulting energy consump-
tion is calculated using the normalization factor.
Example: With a normalization factor of 2 and the physical unit "Wh",
3 pulse signals result in an energy consumption of 6 Wh.
REAL, LREAL, SINT, USINT, INT, Used to acquire a power value
UINT, DINT, UDINT, LINT, The acquired power value is standardized and the resulting energy
ULINT, DWord consumption calculated.
Example: Average power consumption of 180 kW over 10 seconds
corresponds to energy consumption of 0.5 kWh or 500 Wh.
REAL, LREAL, SINT, USINT, INT, Used to acquire an energy counter value
UINT, DINT, UDINT, LINT, The power consumption and the instantaneous value of the power
ULINT, LWord consumption is calculated from the change of the absolute energy
counter value using the normalization factor.
Example: The counter states of an energy counter change in 10 sec-
onds from 6,734,392 Wh to 6,734,414 Wh. This corresponds to an
energy consumption of 22 Wh and an instantaneous value of the
power consumption of 7.92 kW.

SIMATIC Energy Suite V19.0

31 Function Manual, 12/2023, A5E36824823-AH
Supply energy data
2.4 Energy data from the process image or bit memory area of the S7-CPU

Declaring PLC tags for energy data acquisition

To declare the PLC tags for energy data acquisition, create the PLC tags in a PLC tag table
according to the standard procedure. Depending on the energy data type, you assign the PLC
tags the appropriate data type.
You can find additional information about the procedure in the online help of the TIA Portal
information system under "Declaring tags in the PLC tag table".

See also
Assign energy data source (Page 42)

SIMATIC Energy Suite V19.0

32 Function Manual, 12/2023, A5E36824823-AH
 Supply energy data
2.5 Energy data from data blocks

2.5 Energy data from data blocks

DB tags
DB tags can be used as an energy source for acquisition objects. To do this, create new DB
tags in data blocks or use existing DB tags in the PLC program.
Depending on the desired energy data type (pulse signal, power value or energy counter
value) you assign the created DB tag to an appropriate data type. You assign the data type of
the DB tag or an element in the declaration table for the data blocks. You assign the energy
data types to energy data sources with the configuration of the acquisition object.

Overview of data types for DB tags

The following chart shows the different data types for DB tags for energy data acquisition:

Data type Description

BOOL Used to acquire a pulse signal
From an acquired binary pulse signal, the resulting analog power value is calcu-
lated using the normalization factor.
Example: With a normalization factor of 2 and the physical unit "Wh", 3 pulse
signals result in an energy consumption of 6 Wh.
SINT, USINT, INT, Used to acquire a power value
UINT, DINT, The acquired power value is standardized and the resulting energy value calcu-
UDINT, LINT, lated.
ULINT, DWord
Example: Power consumption of 180 kW over 10 seconds corresponds to energy
REAL, LREAL consumption of 0.5 kWh or 500 Wh.
SINT, USINT, INT, Used to acquire an energy counter value
UINT, DINT, The power consumption and the instantaneous mean power consumption is
UDINT, LINT, calculated from the change of the absolute energy counter value using the nor-
ULINT, LWord malization factor.
REAL, LREAL Example: The counter states of an energy counter change in 10 seconds from
6,734,392 Wh to 6,734,414 Wh. This corresponds to an energy consumption of
22 Wh and an average power consumption of 7.92 kW.

Declaring DB tags for energy data acquisition

To declare the DB tags for energy data acquisition, create corresponding data blocks and
define their structure according to the standard procedure.
You can find additional information about the procedure in the online help of the TIA Portal
information system under "Editing properties of tags in data blocks".

See also
Assign energy data source (Page 42)

SIMATIC Energy Suite V19.0

33 Function Manual, 12/2023, A5E36824823-AH
Process energy data 3
3.1 Acquisition objects and energy acquisition program
For processing raw energy, define acquisition objects in STEP 7 (TIA Portal) in the project tree
below the S7-1500 CPU. The acquisition objects are used for process-specific configuration of
raw energy data and the subsequent generation of an energy program.

There is the new "Energy acquisition" folder in the project tree for this after the successful
installation of SIMATIC Energy Suite. The following figure shows the "Energy objects" folder in
the project tree.

Acquisition objects
Each acquisition object represents a measuring point of your production plant. You use the
parameter setting of acquisition object to define the processing of the input measurement
data to energy values that can be subjected to analysis.
To define the periodic calculation of energy values, assign each acquisition object an
archiving period. This enables you to define the intervals at which the acquired raw energy
data for a periodic energy value are to be compressed and archived with their time stamp.
Often, an electric power value is archived in 15 min. periods and a non-electric energy value
(e.g., gas) is archived in 60 min. periods. You can centrally create manage multiple archiving
periods independent of the acquisition objects.
You create and manage acquisition objects in acquisition object tables and also configure
Load management through Energy acquisition node. Several acquisition object tables enable
the structuring of the acquisition objects, for example, based on the hierarchy of the
measuring points in your production plant.
You can find additional information about the possible number of acquisition objects and
acquisition object tables in the section "Performance features and conventions (Page 21)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 34
 Process energy data
3.1 Acquisition objects and energy acquisition program

Energy program
Based on the configured acquisition objects and the archiving periods, a PLC program is
generated for the acquisition, processing and archiving of energy data. This program is
referred to as the "energy program" in the following.
When the energy program is generated, blocks from the supplied Energy Suite library and
from the measurement hardware library (Energy Support Library) are automatically created
and interconnected according to the configuration of the acquisition objects. Before the start
of the generation of the energy program, you have the option to select those measuring
points that should be taken into account in the energy program by enabling the acquisition
objects.
Once the energy program is generated, it is available in the project tree below the CPU in the
"Program blocks" > "Energy Suite - program" folder together with all the required
components.

Load Management
Load management blocks in SIMATIC Energy Suite acts as a monitoring component which
ensures the power and energy consumption does not exceed the user defined limit energy
value. You can find more information on Load Management in the section "Optimizing
energy consumptions (Page 157)".

Programming rules

Note
The "EnS_" and "EnSL_" prefix is reserved for the Energy Suite.
Before generating the energy program, make sure that the prefix "EnS_" and "EnSL_" is not
used in your existing PLC program (user blocks, tags, UDTs or technology objects). In this
way, you avoid unintentional overwriting when generating the energy program.

Note
The "Energy Suite - Program" folder is a reserved area for the Energy Suite.
Before generating the energy program, make sure that no parts of your existing PLC program
are located in the "Energy Suite program" folder. In this way, you avoid unintentional
overwriting when generating the energy program.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 35
Process energy data
3.2 Creating an acquisition object table

3.2 Creating an acquisition object table

First, create acquisition object tables below the CPU in the "Energy acquisition" folder.
Consider in advance how you want to structure the acquisition objects over multiple
acquisition object tables. The number of acquisition object tables affects the maximum buffer
duration (Page 62).
You can find additional information about the possible number of acquisition object tables
and naming conventions in the section "Performance features and conventions (Page 21)".

Requirement
• An S7-1500 CPU is created in the project.

Procedure
To create an acquisition object table, proceed as follows:
1. Open the S7-1500 CPU in the project tree.
2. Open the "Energy objects" folder below the S7-1500 CPU.
3. Open the "Energy acquisition" folder.
4. Double-click on the "Add new acquisition object table" object.
A new acquisition object table is created directly in the "Energy aquisition" folder.
5. In the shortcut menu of the new acquisition object table, select the "Rename" command and
enter the desired name in adherence with the naming conventions (Page 21).
If needed, create additional acquisition object tables in the same way. Continue creating
acquisition object tables below any other S7-1500 CPUs.

SIMATIC Energy Suite V19.0

36 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.3 Adding acquisition objects for acquisition object tables

3.3 Adding acquisition objects for acquisition object tables

In order to process the energy data, create acquisition objects in the acquisition object tables
for the measuring points of your production plant. Consider how you want to structure the
acquisition objects over multiple acquisition object tables.
You can find additional information about the possible number of acquisition objects and
naming conventions in the section "Performance features and conventions (Page 21)".

Requirement
• An acquisition object table has been created in the "Energy acquisition" folder below the
S7-1500 CPU.

Procedure
To create an acquisition object, follow these steps:
1. Open the "Energy objects" folder below the S7-1500 CPU.
2. Open the "Energy acquisition" folder.
3. Double-click on the acquisition object table in which you want to enter the acquisition
object.
The acquisition object table opens in the working area.
4. Double-click "<Add new>" in the "Name" column of the acquisition object table.
A new acquisition object is created in the acquisition object table.
Create additional acquisition objects for all acquisition object tables in the same way.
Continue creating acquisition objects below any other S7-1500 CPUs.

Result
Each row of an acquisition object table represents an acquisition object. You can clearly view
the most important properties features of the acquisition objects directly in the acquisition
object table and change them necessary. This includes:
• Name of the acquisition object
• Energy data source of the acquisition object
• Enable status of the acquisition object for the energy program
• Configuration of specific properties of the acquisition object (processing properties)
• Archiving period of the acquisition object
• Periodic forecast for activating the load management (Page 157)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 37
Process energy data
3.3 Adding acquisition objects for acquisition object tables

The following figure shows an acquisition object table in the working area of STEP 7 (TIA
Portal):

When an acquisition object is selected in the acquisition object table in the working area of
the Inspector window of STEP 7 (TIA Portal), the specific properties of the acquisition object
are displayed. Setting for these properties is described in the following sections.

Copying acquisition objects

Acquisition objects can be copied between the acquisition object tables via the shortcut
menu. After copying, check the properties of the acquisition object and adapt the copied
settings as needed.

See also
Configuring an acquisition object (Page 39)
Change the enable for acquisition objects for the energy program (Page 41)

SIMATIC Energy Suite V19.0

38 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

3.4 Setting the properties of the acquisition objects

3.4.1 Configuring an acquisition object

Each acquisition object represents a measuring point of your production plant and is
correspondingly configured by you. You configure an acquisition object in the "Properties"
Inspector window.

Note
Alternatively, you can display or hide the most important parameters of the acquisition object
in the acquisition object table or (via the shortcut menu of the table header). The settings of
the acquisition objects can be clearly displayed and also changed in the acquisition object
table individually assembled in this way.

For each acquisition object, you define:

• Data source of raw energy data
• Parameters for the acquisition and processing of energy data
• Parameters for archiving energy data (e.g. archiving period)
• Enable of the acquisition object for the energy program
The energy program is generated based on the configured properties.

Requirement
• An acquisition object has been created in the acquisition object table.

Procedure
To open the "Properties" Inspector window of an acquisition object, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the energy acquisition table in which the acquisition object has been
created.
The acquisition object table with the acquisition objects opens.
3. Click on the desired acquisition object in the acquisition object table.
All parameters of the acquisition object are displayed in the "Properties" Inspector window.
The configuration of the acquisition object is described in detail in the following sections.

See also
Basic settings (Page 40)
Energy data source (Page 42)
Periodic energy values (Page 49)
Processing (Page 52)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 39
Process energy data
3.4 Setting the properties of the acquisition objects

3.4.2 Basic settings

The following table shows the basic settings of an acquisition object:

Setting Description
Name CPU-wide unique name of the acquisition object. The name appears
in the acquisition object table and can be changed according to indi-
vidual requirements.
Valid name length: 1 - 32 characters
The following characters are prohibited: ? ' * " \ % § °
You can find additional information about naming conventions in the
section "Performance features and conventions (Page 21)".
Comment Optional short description of acquisition objects, for example, about
the purpose or the data source of acquisition object.
Enable acquisition object • When this check box is selected, the acquisition object is enabled
for generating the energy program.
• When the check box is not selected, the acquisition object is not
used in the energy program.
If the number of Runtime licenses for the Energy Suite (Page 70) is
fewer than the number of enabled acquisition objects, the generation
of the energy program is canceled and an error alarm is displayed.
Acquisition objects that are not enabled are ignored by the license
count.
Date created The creation date corresponds to the date on which the acquisition
object was added to the acquisition object table. The creation date
cannot be changed.
Last modified The date of modification corresponds to the date on which the acqui-
sition object was last changed. The date of modification is updated
each time a change is made to the properties of the acquisition ob-
ject. The date of modification cannot be changed.

See also
Configuring an acquisition object (Page 39)
Change the enable for acquisition objects for the energy program (Page 41)

3.4.3 Project information

The following table shows the settings of the acquisition object under "Project information":

Setting Description
Acquisition object detec- The acquisition object identifier is assigned automatically when you create
tion the acquisition object. The acquisition object identifier is used internally
for addressing and identification of the acquisition object.
The acquisition object identifier cannot be changed.
Author Name of the editor of the acquisition object. The name can be changed
according to individual requirements. The user logged onto the operating
system is set by default.

See also
Configuring an acquisition object (Page 39)

SIMATIC Energy Suite V19.0

40 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

3.4.4 Identification & Maintenance

The following table shows the settings of the acquisition object under "Identification &
Maintenance":

Setting Description
Plant designation The plant designation defines the measuring point to which the acquisi-
tion object is assigned within the process plant.
Location identifier The location ID defines the exact location of the measuring point to which
the acquisition object is assigned within the process plant.
Installation date Date on which the measuring point assigned to the acquisition object was
installed in the plant. The date can be selected from the calendar dialog
box.
Additional information Additional information about the measuring point assigned to the acquisi-
tion object, for example, the intended use of the measurement hardware.

See also
Configuring an acquisition object (Page 39)

3.4.5 Change the enable for acquisition objects for the energy program
You can change the inclusion of the individual acquisition objects for generating the energy
program. After adding a new acquisition object, the enable is active (default setting). It may
be useful to disable this setting for some applications (e.g. for testing purposes or to make
maximum use of runtime licenses):

Note
Acquisition objects that are not enabled are ignored by the Runtime licensing (Page 70).

You have the following options for this:

• In the Inspector window: when creating the acquisition object and assigning parameters
to it
• In the acquisition object table: central and clear for all associated acquisition objects

Procedure
To change the enable of the acquisition object for the energy program in the Inspector
window, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the acquisition object table in which the acquisition object has been created.
The acquisition object table with the created acquisition objects opens.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 41
Process energy data
3.4 Setting the properties of the acquisition objects

3. Click on the desired acquisition object in the acquisition object table.

All parameters of the acquisition object are displayed in the "Properties" Inspector window.
4. Select/clear the check box "Enable acquisition object" for the basic settings.
– Activated: The acquisition object is enabled for generating the energy program.
– Deactivated: The acquisition object is not used for generating the energy program.
This setting for the acquisition object is also updated within the "Enable acquisition object"
column of the acquisition object table. Alternatively, you can select/clear the check box in the
acquisition object table.

3.4.6 Energy data source

3.4.6.1 Assign energy data source

In order to create an energy program, each acquisition object requires an energy data source
that provides energy data. The following sources are available as energy data sources for the
acquisition objects:
• Input measurement data from connected measurement hardware (Page 28)
• Energy data from the process image or the bit memory area of the CPU (PLC tags)
(Page 31)
• Energy data from data blocks (DB tags) (Page 33)
You have the following options for assigning the energy data source:
• In the Inspector window: when creating the acquisition object and assigning parameters
to it
• In the acquisition object table: central and clear for all associated acquisition objects

Requirement
• The PLC tags and DB tags are declared for energy data acquisition.
• The measurement hardware for power data acquisition is configured below the S7-1500
CPU.
• The Energy Support Library with the driver blocks for the measurement hardware is
installed.

In the Inspector window

To assign an energy data source to a acquisition object, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the acquisition object table in which the acquisition object was entered.
The acquisition object table with the created acquisition objects opens.

SIMATIC Energy Suite V19.0

42 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

3. Click on the desired acquisition object in the acquisition object table.

The properties of the acquisition object are displayed in the "Properties" Inspector window.
4. Select the "Configuration > Energy data source" item in the navigation area.
5. Right-click on the "Energy data source" field.
The selection dialog with PLC/DB tags declared CPU-wide or with the modules of the
available measurement hardware opens.
6. Navigate to the desired energy data source in the selection dialog.
7. Apply the select by clicking on the green check mark in the selection dialog.
Based on the selected energy data types in the "Energy data type" area, the energy data
source can be selected. You can make additional settings for the energy data type (Page 46)
in the Inspector window.
The assigned energy data source is also updated within the "Energy data source" column of
the acquisition object table.

In acquisition object table

To assign or change the energy data source for multiple acquisition objects when needed,
follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the acquisition object table in which the acquisition objects were entered.
The acquisition object table with the created acquisition objects opens.
3. Click on the table field in the row of the acquisition object in the "Energy data source"
column.
The selection dialog with PLC/DB tags declared CPU-wide or with the modules of the
available measurement hardware opens.
4. Navigate to the desired energy data source in the selection dialog.
5. Apply the select by clicking on the green check mark in the selection dialog.
The assigned energy data source is also updated in the "Properties" Inspector window. You
can make additional settings for the energy data type (Page 46) in the Inspector window.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 43
Process energy data
3.4 Setting the properties of the acquisition objects

3.4.6.2 Energy data source

The following table shows the settings of the acquisition object under "Energy data source":

Setting Description
Energy data source The energy data sources available for selection are:
• Measurement hardware module with the input measured data of
the measuring point
or
• PLC tag with the values from the process image or DB
The energy data sources must be created and configured before pa-
rameter assignment of the acquisition objects. Afterwards, they are
available in the selection dialog for the energy data source.
Type Depending on the selected energy source for the energy acquisition,
the corresponding type of energy data source is displayed. The type of
energy data source cannot be changed.
Add error monitoring of Error monitoring for energy data sources that do not have integrated
energy data source error monitoring (e.g. for analog energy values). You program the
evaluation of the hardware error in the PLC program for this purpose.
If a fault occurs at the input signal of the energy data source, the trig-
ger for hardware error is set.
Conventions for the signal:
• Minimum duration of 2 times the value at the "Acquisition cycle"
setting
• Rising edge: incoming error
• High-level: Error is present
• Falling edge: outgoing error
• Low-level: No error
The only error events recorded are those that have been pending at
least for the duration of the acquisition cycle. You can find additional
information on the acquisition cycle in the section Energy data type
(Page 46).
When this check box is selected, the tag for the trigger for hardware
error can be selected.
Trigger for hardware error Selection of the tag for the trigger for hardware error
If an invalid energy value is detected from an energy data source that
has no integrated error monitoring, then the selected tag of the
"BOOL" data type is set and the "Hardware error" error message is gen-
erated.
The evaluation of the tag for the hardware error trigger must be pro-
grammed accordingly to the conventions for the signal in order to
diagnose an incoming error at a falling edge.
You can find the conventions for the signal in the description of the
setting "Add error monitoring of energy data source".
Example:
• A measuring device that is not supported by the Ener-
gy Support Library provides an analog power value.
• In addition, the measuring device provides a binary output which
generates a falling edge in case of a fault.
Can only be selected when the "Add error monitoring of energy data
source" check box is selected.

SIMATIC Energy Suite V19.0

44 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

Advanced & additional energy data

The following table shows additional options for the acquisition objects which are
configurable using data source as measurement hardware under "Energy data source":

Setting Description
Activate advanced energy Allows you to activate advanced energy data and the check box is
data unchecked by default. Upon selecting the checkbox, the following
radio buttons will get enabled, and you can choose one among them:
• Automatic acquisition (by acyclic communication via EnSL driver) -
If you select the data source as hardware data source, upon pro-
gram generation, the EnSL driver blocks through acyclic communi-
cation are used automatically . This is not applicable in case of a
software data source or if the device does not support advanced
data
• Manual linking (via interface DB) - If you select only the software
data source, or if the device does not support advanced data, then
the interface data blocks must be manually linked to the generated
data blocks

• Include minimum/maximum data - contains minimum and maxi-

mum values of advanced energy data. Enabled when advanced da-
ta is checked
Activate additional energy Allows you to activate additional energy data, and the checkbox is
data (via interface DB) unchecked by default. Upon selecting the checkbox, and if program is
generated, you can use the interface blocks "<Acquisition object
name>_Add" to link to the user-defined blocks with additional data.

See also
Assign energy data source (Page 42)
Important information on energy data (Page 26)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 45
Process energy data
3.4 Setting the properties of the acquisition objects

3.4.6.3 Energy data type

Depending on the energy data source of the energy acquisition object, the following energy
data types are processed.

Energy data type

The following table shows the available energy data types with corresponding units and
examples:

Setting Unit Example

Pulse signal Wh With a normalization factor of 0.5, six pulses correspond to 3 Wh.
l
hl
m³
m³ [n]
kg
t
pcs
Energy counter Wh The counter states of an energy counter change in ten seconds from
value l 6,734,392 Wh to 6,734,414 Wh.
hl The difference corresponds to an energy consumption of 22 Wh and
an average power consumption of 7.92 kW.
m³
Resetting the energy count value during an active archiving period
m³ [n] results in the calculation of incorrect energy values for this archiving
kg period.
t The following applies for a valid energy counter value:
pcs • Energy counter value < Overflow value
Power value W Average power consumption of 180 kW over ten seconds corresponds
l/h to energy consumption of 0.5 kWh or 500 Wh.
hl/h
m³/h
m³/h [n]
kg/h
t/h
pcs/h

Acquisition cycle
The driver blocks for the acquisition of energy data are called once per acquisition cycle.
The following acquisition cycles can be selected:
• 0.01 s
• 0.02 s
• 0.05 s
• 0.1 s
• 0.2 s
• 0.3 s

SIMATIC Energy Suite V19.0

46 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

• 0.5 s
• 1s
• 2s
The following default values are set:
• Pulse signal: 0.01 s
• Energy counter value: 1 s
• Power value: 0.1 s

Settings for selected energy data type

The following table shows the additional settings for the selected energy data type:

Setting Description
Data type Only visible with energy data type "Energy counter value"
The data type of the energy counter value is displayed depending on
the selected energy data source that provides the energy counter val-
ue. The Energy data source displays data type based on the input type
of acquisition object selected under Energy data type:
• Pulse signal - Supports only boolean tags
• Energy counter value - Supports LReal,Real, Lint,Dint,Int,
SInt,ULint,UDInt,UInt,USInt,LWord
• Power value - Supports LReal,Real, Lint,Dint,Int,
SInt,ULint,UDInt,UInt,USInt,DWord
The same data types are displayed for the Energy data source under
the Properties area.
Unit Physical unit of the energy value
• Units for pulse signal: Wh, l, hl, m³, m³ [n], kg, t, pcs
• Units for energy counter value: Wh, l, hl, m³, m³ [n], kg, t, pcs
• Units for power value: W, l/h, hl/h, m³/h, m³/h [n], kg/h, t/h, pcs/h
Normalization factor Specifies the value by which the acquired energy value is multiplied to
convert this energy value into the selected unit (e.g. "W" or "Wh" or
"m³" or "m³/h").
Preset to 1.0 by default. Permissible value range: 0 – 9999999
Example:
A measuring instrument provides an output value of 3.7 with the
"kWh" unit. Settings for this in the Energy Suite:
• Unit: Wh
• Normalization factor: 1000
Energy Suite processed the value to 3700 Wh.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 47
Process energy data
3.4 Setting the properties of the acquisition objects

Setting Description
Energy flow direction Configuration of the energy flow direction
• Consumer
The energy is drawn from the power grid by the consumer (for ex-
ample, an electrical machine in motor mode).
• Producer
The energy is fed into the power grid by the producer (for example,
an electric machine in producer mode).
Overflow value Only for "energy counter value" energy data type
Specifies the value at which the energy counter value is reset to 0.
1000000 (1*10^6) is set by default.
Assignable values:
• 1000000 (1*10^6)
• 1000000000 (1*10^9)
• 1000000000000 (1*10^12)
• User-defined
User-defined overflow value Configurable only with overflow value = "User-defined"
Manual specification of the overflow value at which the energy coun-
ter value is reset to 0. Permissible value range: 1 - 1.0e+15

See also
Assign energy data source (Page 42)

SIMATIC Energy Suite V19.0

48 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

3.4.7 Periodic energy values

3.4.7.1 Setting energy values for periodic archiving

The acquired energy data are archived after processing as periodic energy values together
with their time stamps. Depending on the selected energy data type, different energy values
can be set for archiving.
During the configuration of the acquisition object, you select the periodic energy values and
the archiving period in the Inspector window for this.

Requirement
• The archiving periods with different values are created at a central location in the settings
for the energy program.
You can find additional information on this in the section "Defining archiving periods
(Page 54)".

Procedure
To define the periodic energy values for an acquisition object for archiving, follow these
steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the acquisition object table in which the acquisition object has been created.
The acquisition object table with the created acquisition objects opens.
3. Click on the desired acquisition object in the acquisition object table.
The properties of the acquisition object are displayed in the "Properties" Inspector window.
4. Select the "Configuration > Periodic energy data" item in the navigation area.
5. Select the check box for the desired energy values:
– Power consumption
– Energy consumption
– Energy counter value (can only be enabled for the energy counter value energy data
type)
6. Right click on the "Archiving period" field.
The table with the centrally created archiving periods (Page 54) for the energy program
opens. If no custom archiving periods have been created previously, there are only two
archiving periods (15 min., 60 min.) to choose from by default.
7. Click on the desired archiving period and apply the selection by clicking the green check
mark in the selection dialog.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 49
Process energy data
3.4 Setting the properties of the acquisition objects

3.4.7.2 Periodic energy data

The acquired energy data are archived after processing as prepared periodic energy values
together with their time stamps. Depending on the selected energy data type, different
energy values are available for archiving.

Periodic energy values

The following table shows the periodic energy values for archiving:

Setting Description
Power consumption Average power consumption per archiving period. Archiving for the
following selected energy data types possible:
• Pulse signal
• Energy counter value
• Power value
Energy consumption Energy consumption per archiving period. Archiving for the following
selected energy data types possible:
• Pulse signal
• Energy counter value
• Power value
Energy counter value Energy counter value per archiving period. Archiving for the following
selected energy data types possible:
• Energy counter value
Forecast Acquisition objects for load management are generated only if you
select the Forecast option.

Assignment of the archive period

By selecting the archiving period, the acquisition object and thus also the selected energy
value is assigned to the periodic period for calculation and archiving. You assign exactly one
archiving period to each acquisition object.
You create new archiving periods with the central settings for the energy program (Page 54).
You can choose the archiving period as a default value for an acquisition object by selecting
the "Default" checkbox in the "Archiving periods" dialog. For more information about
archiving periods see "Archiving periods (Page 56)".

Note
Avoid using the same measurement hardware multiple times as energy data source
Make sure that the same measurement hardware is used only once as energy data source in
the energy program to prevent overload of the communication channels.

SIMATIC Energy Suite V19.0

50 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

Example for assignment of multiple archiving periods

To archive the energy consumption, for example, with a 15-minute and a 60-minute
archiving period, create an acquisition object for each archiving period.
1. For the acquisition object with the 15-minute archiving period, select the measurement
hardware as energy data source and activate archiving of the energy consumption. Then
generate the energy program.en
2. For the acquisition object with the 60-minute archiving period, select the "energy" output
parameter of the driver block of the measurement hardware as energy data source. Next,
activate archiving of the energy consumption for the acquisition object and generate the
energy program again.
In this way, the energy consumption of a measuring point is archived in two archiving
periods, and the measurement hardware is used only once as energy data source in the
energy program.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 51
Process energy data
3.4 Setting the properties of the acquisition objects

3.4.8 Processing

3.4.8.1 General processing settings

The following table shows the settings of the acquisition object under "Processing":

Setting Description
General processing settings
Internal processing cycle For each internal processing cycle, the energy data activated for
archiving is calculated and refreshed once.
The following duration can be selected for the internal processing
cycle:
• 0.1 s
• 0.2 s
• 0.5 s
• 1s
The internal processing cycle can be changed for faster updating of
the energy data, for example for:
• Visualizing energy data
• Further processing of the energy data by the user program (for
example, load management)
Set to 1 s by default.
Calculation of current value of power consumption
Calculation interval Used for calculation of current value of power consumption.
The current value of power consumption is calculated from the
energy consumption for each calculation interval. The calculated
instantaneous value corresponds to the average over the duration
of the calculation interval.
Can only be edited when energy data type "Energy counter value" or
"Pulse signal" is selected.
The following duration can be selected for the calculation interval:
• 1s
• 2s
• 3s
• 4s
• 5s
• 6s
• 10 s
• 15 s
• 20 s
• 30 s
• 60 s
10 s is set by default.

SIMATIC Energy Suite V19.0

52 Function Manual, 12/2023, A5E36824823-AH
 Process energy data
3.4 Setting the properties of the acquisition objects

Setting Description
Extend calculation interval The dynamic extension of calculation interval allows the calculation
of current value of power consumption with additional acquisition
time.
Example:
A pulse is output every 4 s with constant power consumption. When
a default calculation interval of 10 s is configured
• 2 pulses are counted in the first calculation interval instead of
2 1/2
• 3 pulses are counted in the second calculation interval
With an extension of the calculation interval of 5 s
• 3 pulses are counted in the first calculation interval
• 3 pulses are counted in the second calculation interval
The second calculation interval starts after 12 s beginning with the
first calculation interval.
Extension of calculation interval Calculation of current value of power consumption starts when one
of the following requirements is met:
• The energy counter value has changed.
• At least the duration of the extension of calculation interval has
expired.
• The consumer has been switched off.
The following duration can be selected for the extension of calcula-
tion interval:
• 1s
• 2s
• 3s
• 4s
• 5s
• 6s
• 10 s
• 15 s
• 20 s
• 30 s
• 60 s

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 53
Buffering and archiving energy data 4
4.1 Defining archiving periods

Archiving periods
Archiving periods are periodic time intervals in which the raw energy data of the respective
acquisition object in the CPU are processed to a periodic energy value with a time stamp and
then - depending on the setting - archived in the CPU (SIMATIC Memory Card) or in
WinCC Professional (Data Log)/WinCC Unified(for example, every 15 minutes).
To ensure plant-wide energy values from all acquisition objects are archived at the same
time, the configured duration of the archiving period can be synchronized to an internal or
external timer:
• By default, the internal CPU clock is used as a timer for all blocks of the energy program.
For this, you synchronize the CPU time with an external time server (for example, NTP).
You can find additional information on this in the online help of the TIA Portal information
system under the key "Time-of-day synchronization (S7-1500)".
• To synchronize with an external clock (for example, synchronization signal of a utility
company), enable the external pulse and configure its pulse source.
You create the various archiving periods at a central location in the settings for the energy
program. When you configure the acquisition object, you then assign the respective archiving
period to each individual acquisition object.
You can find additional information about the naming conventions of archiving periods in the
section "Performance features and conventions (Page 21)".

UTC

Note
Set the time of the CPU to UTC, for example, to avoid a time difference when switching to
daylight saving time.
Setting the time of day for the CPU corresponds to the standard procedure and therefore
occurs outside the Energy Suite in the online and diagnostics view of the CPU.
You can find additional information on this in the online help of the TIA Portal information
system in the section "Determining and setting the time of a CPU".

SIMATIC Energy Suite V19.0

54 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.1 Defining archiving periods

Procedure
To create new archiving periods in the central administration dialog, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the "Energy program settings" object.
The dialog with the settings for the energy program opens in the working area.
3. Select "Archiving periods" in the navigation area.
The table with the central management of the archiving periods opens. Each row of the
table represents an archiving period. If no custom archiving periods have been created
previously, the table only contains two archiving periods (15 min., 60 min.) to choose
from by default.
4. Only for 24h archiving periods: Use the "Apply time zone settings from the regional settings
of the local engineering PC" check box to set the time zone (difference to UTC time) for the
synchronization:
– Activated: The time zone of the local engineering PC is used.
– Deactivated: The time zone from the following drop-down list is used. Select the
desired time zone from the drop-down list.
5. To create another archiving period, double-click "<Add>" in the "Name" column of the table.
A new archiving period is created in the table.
6. Create additional archiving periods in the same way, if required.
7. Make the settings for each archiving period:
– Name of the archiving period
– Duration of archiving period
– Unit for duration of archiving period
– Defauit
– Synchronization with external pulse (timer) and selection of the pulse source.
The meaning of the settings is described in detail in the section "Archiving periods (Page 56)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 55
Buffering and archiving energy data
4.2 Archiving periods

4.2 Archiving periods

You create the various archiving periods at a central location in the settings for the energy
program. When you configure the acquisition object, you then assign the respective archiving
period to each individual acquisition object.
Two archiving periods (15 min., 60 min.) with an internal clock for the synchronization are
preset by default.

Time zone
The following table shows the time zone settings for synchronization under "Archiving
periods". The time zone settings are only valid for the synchronization of the archiving
periods with a duration of 24 hours.

Setting Description
Apply time zone settings • Activated: The 24 hour archiving periods are synchronized based
from the regional settings of
on the time zone settings from the regional settings of the local
the local engineering PC
engineering PC.
• Deactivated: Selection of the required time zone for synchroniza-
tion of the 24 hour archiving periods from the drop-down list.
Deactivated by default.
Time zone Time zone (difference to UTC time)
Archiving periods with a duration of 24 h are synchronized at
0:00:00:000 UTC time.
In case of an offset between UTC time and regional time, synchroniza-
tion of the 24 h archiving period can be adjusted based on the selected
time zone.
The time zone can only be selected when the "Apply time zone settings
from the regional settings of the local engineering PC" check box is
cleared.

SIMATIC Energy Suite V19.0

56 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.2 Archiving periods

Archiving periods
The following table shows the settings for new archiving periods in central administration:

Setting Description
Name Two archiving periods (15 min., 60 min.) with an internal clock for the synchro-
nization are preset by default. If different values are needed for the duration,
create additional archiving periods.
The name of the archiving period is unique CPU-wide and can be changed ac-
cording to individual requirements.
Recommendation: Use in the name of the duration of the archiving period (for
example, UserPeriod_15min)
You can find additional information about naming conventions in the section
"Performance features and conventions (Page 21)".
Duration Period at the end of which the energy values are periodically calculated and
archived. The time stamps are generated based on the time period.
Example: With an archiving period of 15 min., time stamps are generated in 15
min. increments (starting at the top of the hour).
The prepared periodic energy values are archived together with the respective
time stamps:
• As a CSV file internal to the CPU on the SIMATIC memory card
or
• In the data log of the WinCC Professional/WinCC Unified SCADA system
15 min is set by default for newly added archiving periods.
Unit Unit for the time period in which a periodic energy value is calculated and
stored.
The following units can be set:
• min = minutes
• h = hours
Default Allows you to retain the archiving period as default while configuring the acqui-
sition object table.
Deactivated by default.
External pulse An external pulse triggers the clock for synchronization of the archiving period.
• With selected check box, you assign the synchronization signal (e.g. from a
utilities company) to the external pulse in the "Pulse source" column.
• When the check box is not selected, the internal CPU clock triggers the syn-
chronization of the archiving period. The internal CPU time is synchronized
with an external time server to UTC time (for example, with NTP) to form
the time stamp.
Deactivated by default.
Pulse source A tag of data type "BOOL" can be selected as the pulse source.
The tag must be assigned to the synchronization signal, for example, of the
utilities company.
Can only be edited when the external pulse is enabled.

See also
Defining archiving periods (Page 54)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 57
Buffering and archiving energy data
4.3 Setting the archiving on a S7-CPU (SIMATIC Memory Card)

4.3 Setting the archiving on a S7-CPU (SIMATIC Memory Card)

The prepared periodic energy values with time stamp are cached in the data blocks for
buffering before they are archived on the S7-1500 CPU (on an inserted SIMATIC memory
card).
The number of data blocks for buffering corresponds to the number of acquisition object
tables.
Then the energy values in are stored in data logs (CSV files) on the S7-1500 CPU (SIMATIC
memory card). One data record is written to the data log per archiving period. A data record
contains an energy value with time stamp and status.
You can find general information on data logs in the online help of the TIA Portal information
system under "Data Logging - Overview".
You define the number and size of the data log files for archiving on the memory card.

Requirement
• The prepared periodic energy values with time stamp (power and energy consumption,
energy counter value) are enabled for archiving.
You can find additional information on this in the section "Setting energy values for
periodic archiving (Page 49)".

Procedure
To make the required settings for archiving on the S7-1500 CPU, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the "Energy program settings" object.
The dialog with the settings for the energy program opens in the working area.
3. Select the entry "Archiving and buffering" in the area tree.
4. In the "Archiving" area, select the option button "PLC (SIMATIC memory card)".
– The parameters for the data log are displayed below the option button.
– The number and size of the data blocks for buffering are shown in the "Buffering" area.
5. In the "Archiving" area, make the settings for the data logs (data archives in CSV format) for
the transfer to the memory card:
– Name of the data log
– Number of data logs
– Size of the data log
6. In the "Buffering" area, check the parameters displayed for the size and the memory area of
the data blocks.
The meaning of the settings is described in detail in the section "Archiving and buffering (S7-
CPU) (Page 59)".

SIMATIC Energy Suite V19.0

58 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.4 Archiving and buffering (S7-CPU)

4.4 Archiving and buffering (S7-CPU)

Archiving
The prepared periodic energy values with time stamp are archived in data logs (CSV files) on
the S7-1500 CPU (SIMATIC memory card). You can find general information on data logs and
the structure of CSV files in the online help of the TIA Portal information system under "Data
Logging - Overview".
You define the number and size of the data log files for archiving on the SIMATIC memory
card.
The following table shows the settings in the area "Archiving" for the "PLC (SIMATIC Memory
Card)" archiving type:

Setting Description
Name of the data log The name of the data log is used for file name of the CSV file (comma sepa-
rated values). The file name consists of the name (as prefix) and the time
stamp of the first energy value in the data log.
The following restrictions apply to the name of the data log with the S7-1500
CPUs:
• Permissible name length: 1 - 26 characters
• The following characters are allowed: 0 ... 9, a ... z, A ... Z, "_", "-"
You can find additional information about naming conventions in the section
"Performance features and conventions (Page 21)".
Number of data logs The number of data logs is limited by the capacity of the SIMATIC memory
card.
If the selected number of data logs is reached, the oldest log data is deleted
and a new data log created.
Valid number of data logs: 2 - 10
Set to 5 by default.
Size of the data log If a data log approaches the specified size, a new data log is created.
The maximum size of the data log is limited by the system to 1024 MB. The
required space on the SIMATIC memory card for a data log is calculated using
the following formula:
45 bytes + (number of data records * 116 bytes)
A data record contains an energy value with time stamp and status.
Recommendation:
Set the value for the "Size of data log" setting no larger than 180 MB in order
to avoid data loss if the CSV file is re-used, for example, with "Microsoft Excel".
Set to 10 MB by default.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 59
Buffering and archiving energy data
4.5 Example for archiving (S7 CPU)

Buffering
The periodic energy values are cached along with their time stamps in the data blocks for
buffering before they are archived on the S7-1500 CPU (SIMATIC memory card). The caching
avoids loss of data - for example in the event that the SIMATIC memory card is full because
the configured number of data logs has been reached.
The following table shows the settings in the area "Buffering" for the "PLC (SIMATIC Memory
Card)" archiving type:

Setting Description
Number of data The number of data blocks corresponds to the number of created acquisition
blocks object tables. One data block for buffering is required for every acquisition
object table. The data blocks are automatically created with the generation of
the energy program.
Size of the data blocks By using larger data blocks, you have the option to extend the buffer period
of the energy values on the CPU, for example.
Set to 10 KB by default.
Allocated memory Product of number multiplied by the size of the data blocks

See also
Example for archiving (S7 CPU) (Page 60)
Setting the archiving on a S7-CPU (SIMATIC Memory Card) (Page 58)

4.5 Example for archiving (S7 CPU)

The required space on the SIMATIC memory card for a data log is calculated using the
following formula:
45 bytes + (number of data records * 116 bytes).
The maximum size of the data log is limited by the system to 1GB. In this way, you can
archive 9,256,395 (approximated as 9,200,000 or 9,000,000) data records of an acquisition
object in which archiving of the power consumption, energy consumption and energy
counter value is enabled to a data log.
• When number of data records is approximated as 9,200,000:
This corresponds to an archiving over 31940 days (87 years) for an acquisition object, or
159 days for 200 acquisition objects with the same configuration.
• When number of data records is approximated as 9,000,000:
This corresponds to an archiving over 31250 days (85 years) for an acquisition object, or
157 days for 200 acquisition objects with the same configuration.

SIMATIC Energy Suite V19.0

60 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.6 Setting the archiving on a PC station with WinCC Professional/WinCC Unified (Data Log)

4.6 Setting the archiving on a PC station with WinCC

Professional/WinCC Unified (Data Log)
The prepared periodic energy values with time stamp are cached in the data blocks for
buffering before they are archived on the WinCC Professional/WinCC Unified SCADA system
Then the energy values are transferred to the data log on the WinCC Professional/WinCC
Unified SCADA system. This type of buffered communication enables secure archiving and
thus a significant increase in the quality and consistency of invoice-related energy data.
The number of data blocks for buffering corresponds to the number of acquisition object
tables.

Note
WinCC Professional/WinCC Unified (data log)
You select a corresponding check box in the Energy Suite to archive the buffered energy
values in data logs of WinCC Professional/WinCC Unified.
The data logs of WinCC Professional/WinCC Unified are set up in the settings of WinCC
Professional/WinCC Unified.

Requirement
• The desired periodic energy values (power and energy consumption, energy counter
value) are enabled for archiving.
You can find additional information on this in the section "Setting energy values for
periodic archiving (Page 49)".

Procedure
To make the required settings for archiving to the data log of WinCC Professional/WinCC
Unified on the PC station, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the "Energy program settings" object.
The dialog with the settings for the energy program opens in the working area.
3. Select the entry "Archiving and buffering" in the area tree.
4. In the "Archiving" area, select the option button "WinCC Professional/WinCC Unified (data
log)".
– Below the option button, a notice appears telling you that the setting of the data log
for this archiving type must be made in WinCC Professional/WinCC Unified.
You can find additional information on this in the section "Create archiving structure
for energy values (Page 103)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 61
Buffering and archiving energy data
4.7 Archiving and buffering (WinCC Professional/WinCC Unified)

– You can use the "Advanced communication settings (between PLC and WinCC)" check
box to make additional optional settings for checking the data transmission and the
connection between the PLC and WinCC Professional.
– The number and size of the data blocks for buffering are shown in the "Buffering" area.
The "Number of data blocks" output field indicates the number of data blocks. This
number corresponds to the number of acquisition object tables created and cannot be
changed.
5. In the "Buffering" area, specify the size of the data blocks for buffering.
The "Occupied memory" output field shows the product of the defined number multiplied
by the size of the data blocks.
The meaning of the settings is described in detail in the section "Archiving and buffering
(WinCC Professional/WinCC Unified) (Page 62)".

4.7 Archiving and buffering (WinCC Professional/WinCC Unified)

Archiving
The prepared periodic energy values with time stamp are archived in data logs on the WinCC
Professional/WinCC Unified SCADA system.

Note
WinCC Professional/WinCC Unified (data log)
The data logs of WinCC Professional/WinCC Unified are configured in the settings of WinCC
Professional/WinCC Unified.
You can find additional information on this in the section "Create archiving structure for
energy values (Page 103)".

The following table shows the advanced communication settings (between PLC and WinCC)
for the selected archiving type "WinCC Professional/WinCC Unified (Data Log)":

CAUTION
Advanced communication settings
You do not need to change the advanced communication settings configured by default.
If you have any questions about archiving, contact Service & Support.

SIMATIC Energy Suite V19.0

62 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.7 Archiving and buffering (WinCC Professional/WinCC Unified)

Setting Description
Advanced communication Can only be activated for the archiving type "WinCC Professional/WinCC
settings (between PLC and Unified (data log)"
WinCC) When the check box is selected, the settings under the following areas
can be configured:
• Monitoring of connection
• Handshake for data transfer
Deactivated by default.
Monitoring of connection
Monitoring time of connec- Monitoring time of connection for watchdog
tion The connection between the CPU and WinCC Professional/WinCC Uni-
fied is monitored by the watchdog counter as follows:
• When the connection is established, the Energy Suite component
in WinCC Professional/WinCC Unified acknowledges the request for
comparison of the watchdog counter.
• If no acknowledgment is made within the monitoring time for the
watchdog, the connection is interrupted and an error message is
generated.
The following duration can be selected for the monitoring time of
connection:
• 1s
• 2s
• 5s
• 10 s
• 20 s
5 s are set by default.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 63
Buffering and archiving energy data
4.7 Archiving and buffering (WinCC Professional/WinCC Unified)

Setting Description
Handshake for data transfer
Monitoring time Monitoring time for writing the energy data to the data log
Handshake for data transfer takes place under the following condi-
tions:
• The Energy Suite component acknowledges the request for writing
the energy data to the data log of WinCC Professional/WinCC Uni-
fied within the monitoring time.
• No monitoring time error has occurred for the watchdog.
The following duration can be selected for the monitoring time:
• 10 s
• 20 s
• 30 s
• 60 s
• 120 s
• 180 s
• 240 s
• 300 s
• 600 s
• 900 s
The default setting is 30 s.
Wait time Wait time for repeating the request to write the energy data to the
data log
The request is repeated until the following conditions are met:
• Wait time has expired.
• Energy Suite component acknowledges the request.
The following duration can be selected for the wait time:
• 10 s
• 20 s
• 30 s
• 60 s
• 90 s
• 120 s
60 s is set by default.

Note
Sufficient watchdog time
Adapt the watchdog time to the number of acquisition objects. The more acquisition objects
are configured, the longer the watchdog time needs to be.

SIMATIC Energy Suite V19.0

64 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.7 Archiving and buffering (WinCC Professional/WinCC Unified)

Buffering
The periodic energy values are cached along with the associated time stamp in the data
blocks (DBs) for buffering before they are archived in the data log of WinCC
Professional/WinCC Unified. Caching avoids loss of data - for example, in the event that the
connection to WinCC Professional/WinCC Unified is interrupted.
You specify the size of the data blocks (buffer DBs) for the duration of the buffering of the
periodic energy values. The number of archived energy values and the configured archiving
period are relevant for the maximum duration of buffering.
The following table shows the settings in the area "Buffering" for the "WinCC
Professional/WinCC Unified (Data Log)" archiving type:

Setting Description
Number of data The number of data blocks corresponds to the number of created acquisition
blocks object tables. One data block for buffering is required for every acquisition
object table. The data blocks are automatically created with the generation of
the energy program.
Size of the data blocks By using larger data blocks, you have the option to extend the buffer period
of the energy values on the CPU, for example, in the event of failure of the
communication to the WinCC Professional/WinCC Unified SCADA system.
Set to 10 KB by default.
Allocated memory Product of number multiplied by the size of the data blocks

See also
Examples of archiving and buffering (WinCC Professional/WinCC Unified) (Page 66)
Setting the archiving on a PC station with WinCC Professional/WinCC Unified (Data Log)
(Page 61)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 65
Buffering and archiving energy data
4.8 Examples of archiving and buffering (WinCC Professional/WinCC Unified)

4.8 Examples of archiving and buffering (WinCC Professional/WinCC

Unified)

Examples for buffering

The following examples show the relationship between the number of acquisition object
tables and the duration of the buffering, depending on the CPU. The examples show the
calculation of one or two acquisition object tables.
• The duration of the buffering depends on the number of acquisition object tables,
because exactly one data block for buffering is created for each acquisition object table.
• The assignment of individual acquisition objects to the acquisition object table also has an
effect on the maximum buffer duration.
The following table shows the maximum size of the data block for buffering and the
approximate values for the duration of the buffering for a data record (e.g. power
consumption) with a 15 min. archiving period in various S7-1500 CPUs: The size of an archive
value including the time stamp is 72 bytes.

Note
The maximum data block size is the maximum size supported by the corresponding PLCs. The
actual usable size will be smaller depending on the size of the PLC program and the available
memory.

CPU Maximum size of the DB [MB] Duration of buffering [d]

CPU 1511 1 150
CPU 1516 5 750
CPU 1518 20 3000
CPU 1510SP 0.75 110
CPU 1512SP 1 150

Example with one acquisition object table

The duration of the buffering is calculated based on the following constraints:
• CPU used: CPU 1518
• Buffering size configured in Energy Program Settings: 5 MB
• Number of acquisition object tables: 1
• Number of acquisition objects: 50
• Energy data to archive per acquisition object:
– Power consumption
– Energy consumption

SIMATIC Energy Suite V19.0

66 Function Manual, 12/2023, A5E36824823-AH
 Buffering and archiving energy data
4.8 Examples of archiving and buffering (WinCC Professional/WinCC Unified)

• Duration of the archiving period: 15 min

• Duration of buffering: 7 1/2 days
The duration of the buffering is calculated as follows:
750 days / 2 energy data items / 50 acquisition objects = 7 1/2 days

Example with two acquisition object tables

The duration of the buffering is calculated based on the following constraints:
• CPU used: CPU 1518
• Buffering size configured in Energy Program Settings: 5 MB
• Number of acquisition object tables: 2
– Per acquisition object table: 25 acquisition objects
• Number of acquisition objects: 50
• Size of 2 data blocks for buffering (for 2 acquisition object tables): 10 MB
• Energy data to archive per acquisition object:
– Power consumption
– Energy consumption
• Duration of the archiving period: 15 min
• Duration of buffering: 15 days
The duration of the buffering is calculated as follows:
1500 days / 2 energy data items / 50 acquisition objects = 15 days
The duration of the buffering directly depends on the number of acquisition object tables,
because exactly one data block for buffering is created for each acquisition object table.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 67
Generate energy program 5
5.1 Making general settings for the energy program
Once the acquisition objects have been configured and settings for buffering and archiving
have been made, define the following general properties for the energy program before the
generation if required:
• Enable for alarm suppression
• Startup time of the Energy Suite blocks

Procedure
To open the dialog for general settings of the energy program, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the "Energy program settings" object.
The "General" dialog with the settings for the energy program opens in the working area.
3. Make the desired settings in the "General" dialog. The meaning of the parameters is
described in detail in the section "General settings (Page 69)".

See also
Defining archiving periods (Page 54)
Setting the archiving on a S7-CPU (SIMATIC Memory Card) (Page 58)
Setting the archiving on a PC station with WinCC Professional/WinCC Unified (Data Log)
(Page 61)

SIMATIC Energy Suite V19.0

68 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.2 General settings

5.2 General settings

The following table shows the settings of the energy program under "General":

Setting Description
Alarm suppression Selection of the tag (data type "BOOL") for higher-level alarm suppression
for the energy program.
This allows block alarms to be suppressed, for example, at restart of the CPU
after a voltage failure.
Startup time Duration for which the Energy Suite blocks remain disabled after restarting
the CPU.
10000 ms is set by default.
Example:
The startup time is used to prevent field devices that are still starting up
from causing errors or the reporting of errors due to the startup. When the
initialization of the field devices is complete (startup finished), the field
devices are ready for operation.
The setting of the startup time depends on the number of devices connect-
ed to the CPU. The more devices on the PROFINET line there are, the longer
the startup time must be set.

See also
Making general settings for the energy program (Page 68)
Archiving periods (Page 56)
Archiving and buffering (S7-CPU) (Page 59)
Archiving and buffering (WinCC Professional/WinCC Unified) (Page 62)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 69
Generate energy program
5.3 Runtime licenses for Energy Suite

5.3 Runtime licenses for Energy Suite

Available runtime licenses

Energy Suite requires Runtime licenses on the CPU based on the number of configured
energy objects.
The following runtime licenses can be set for the Energy Suite:
• "5 Energy objects" license type
• "10 Energy objects" license type
The available runtime licenses for the Energy Suite are displayed for the CPU configuration in
the "Properties" Inspector window under:
Runtime licenses > Energy Suite > Runtime licenses > Number of purchased licenses

Note
Runtime licenses
Before generating the energy program, ensure that sufficient runtime licenses are available
on your engineering system. Disabled energy objects are not included in a runtime license.
Lacking or insufficient runtime licenses result in the termination of the program generation.

Example
The following figure shows the configuration of runtime licenses for the following example:
If you use 32 energy objects in the energy program, you need:
• 1 * "5 energy objects" license type and 3 * "10 energy objects" license type
or
• 7 * "5 energy objects" license type

SIMATIC Energy Suite V19.0

70 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.3 Runtime licenses for Energy Suite

Required runtime licenses

Number of configured acquisition objects calculates from
• number of configured acquisition objects
• number of configured actuators for load management
To display the configured objects for acquisition and load management, follow these steps:
1. Open the "Energy objects" folder in the project tree.
2. Double-click on the "Energy program settings" object.
The dialog with the settings for the energy program opens in the working area.
3. Select the entry "Energy Suite runtime licenses" in the area tree.
The configured acquisition objects and actuator objects are displayed. Each actuator object's
license is equivalent to nine acquisition object licenses. The total number determines the
required Energy Suite runtime licenses.

Note
Ensure that the Number of purchased licenses must always be equal to or lesser than the
total number of required acquisitions object licenses mentioned in Available runtime licenses.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 71
Generate energy program
5.4 Support for Modbus devices

5.4 Support for Modbus devices

Modbus devices can be added through the Modbus option in the Energy Suite program
settings editor, . The user can integrate a Modbus based measuring device as an acquisition
object. For the Modbus based measuring devices, PLC program can be generated, acquired,
monitored and data can be displayed on Energy Suite.

Modbus device configuration

SIMATIC Energy Suite V19.0

72 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.4 Support for Modbus devices

To successfully configure a modbus device the following fields should be provided.

Fields Description
1 Name Name of the Modbus device
2 Device Type Select the type of Modbus device from the list of the devices supported
by Energy Suite
3 Input Type Energy/Power
4 IP address IP address of the device
5 Port number Default 502

In the modbus configuration page, the user can configure the register address of the advance
energy value for the configured device.
After successful configuration of the Modbus devices the following blocks are generated
under Energy Suite library(EnSL).
• Under Acquisition objects in the EnSL block types, EnSL_Modbus_TCP_energyAdv along
with its user defined datatypes are created.
• The dependent user defined datatypes are as follows:
– EnSL_typeModbusComInt
– EnSl_typeModbusDeviceAddress
– EnSL_typeModbusDeviceType
– EnSL_typeModbusDeviceTypeValue
• For every acquisition object with Modbus data source, a database is created.

Note
1. For SENTRON PAC 22xx / 32xx / 42xx / 5x00 device selection the set of default parameter
register is generated automatically. To integrate any other devices apart from SENTRON
device family input the Modbus register map for the energy data from the device
manufacturer's manual.
2. You can generate program only after the installation of Energy Suite library.
3. Each Modbus device should have a unique IP address.
4. Whenever Modbus device configuration is changed, the project should be fully downloaded
for the changes to be effective.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 73
Generate energy program
5.5 Generate energy program

5.5 Generate energy program

Once the acquisition objects have been fully configured and settings for the energy program
have been made, you generate the energy program based on these guidelines.

Requirement
• All acquisition objects that should be included are enabled for the energy program.
• The acquisition objects enabled for the energy program are fully configured.
• The settings for the energy program are defined.
• The number of required runtime licenses for Energy Suite is sufficient.
You can find additional information on this in the section "Runtime licenses for Energy
Suite (Page 70)".
• The name structures in the SCADA system do not exceed the maximum permissible length
for the CPU name of 85 characters.

Procedure
To generate the energy program, follow these steps:
1. Open the S7-1500 CPU in the project tree.
2. Click on the "Energy objects" object below the S7-1500 CPU and select the command
"Generate energy program" from the shortcut menu.
Alternatively, you can open this dialog in the "Energy program settings" dialog by clicking
the "Generate energy program" icon.
The dialog with the selection for generating the energy program opens.
3. Select the option button "Complete program generation" for generation of complete energy
acquisition, peak load managemment and base load management program or select
"Customised program generation" and click on the checkbox for generating customised
program. Ensure when you click "Energy acquisition program", acquisition objects must be
configured. In case of no acquisition objects configured, an error message is displayed.
While generating a customised program, ensure that valid checkboxes are selected for the
generate button to be active. For generating an energy program for load management
using the "Customised program generation" the "Acquisition program generation"
checkbox should also be selected. While selecting "Base load management" and/or "Peak
load management" program generation, the "Acquisition program generation" will
automatically be selected by default.
If complete program generation is selected or customized program generation with
acquisition, peak load managemment and/or base load management program enabled,
and no load management are configured, then a warning is displayed.

SIMATIC Energy Suite V19.0

74 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.5 Generate energy program

4. Click on the "Generate" button. For complete program generation or customized program
generation with acquisition, peak load managemment and/or base load management
enabled, ensure to configure minimal infeed, and actuators for load management.
The generator checks the completeness and the plausibility of the configuration of the
acquisition objects and starts the generation of the energy program. Information and
events during the generation of the energy program are displayed in the Inspector
window under "Info > Energy Suite". A progress bar indicates the status of generation.
5. You can use the "Go to" function to jump to the position in the configuration that is relevant
for the respective event.
6. Adapt the configuration if necessary and start the generation of the energy program again.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 75
Generate energy program
5.5 Generate energy program

Result
After error-free and full configuration of acquisition objects, instances of the required blocks
are created from the Energy Suite Library and the measurement hardware library in the
"Program blocks" folder below the S7-1500 CPU. In addition, other required components,
such as organization blocks and data blocks, are added to the "Program blocks" folder and the
required interconnections are made.
Instances of data types from the Energy Suite Library and the measurement hardware library
can be created in the "PLC data types" folder below the S7-1500 CPU.
The energy program is generated for all enabled acquisition objects (regardless of the division
in the acquisition object tables).

SIMATIC Energy Suite V19.0

76 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.5 Generate energy program

Object Description
① Energy Suite - program New folder for energy program
② EnS - block types (Page 79) Subfolder "Acquisition - block types" with the Energy Suite
blocks and measurement hardware driver blocks (function
blocks)
③ EnS - program blocks (Page 81) Folder for additional blocks (organization blocks, functions,
DBs, etc.)
④ Acquisition objects (Page 84) Blocks for acquisition objects (data blocks)
⑤ Energy Suite - data types Folder with the Energy Suite data types and measurement
(Page 85) hardware data types

Delta generation scenario

• Add: In case of delta generation, when you add a new acquisition object in the
"Acquisition object table", and generate energy program, the new blocks generated will
append to the existing blocks under the folder "Energy Suite - program". The related
function calls will get updated.
– During PLC runtime, only the newly added blocks will be archived along with
timestamp without restarting the PLC.
• Modifiy: In case of delta generation, when you edit an acquisition object in the
"Acquisition object table", and generate energy program, the edited blocks will get
generated and will append to the existing blocks under the folder "Energy Suite -
program". The modified parameters of an acquisition object are updated in the runtime
under "Start value" column only for an instance DB. To reflect the changes from "Start
value" column to "Monitor value" column in runtime, you must click " Load start values as
actual values". The related function calls will get updated.
– In PLC runtime, only the edited EnOs will be re initiated and the existing acquisition
objects should not be impacted and the current energy period will remain valid.
– In SCADA runtime: All the instances of existing EnOs should not be impacted.
• Delete: In case of delta generation, when you delete an acquisition object in the
"Acquisition object table", and generate energy program, the selected blocks only will be
deleted and will not affect the existing blocks under the folder "Energy Suite - program".
The related function calls will get updated.
– During PLC runtime, excluding the deleted blocks, rest will be archived along with
timestamp without restarting the PLC.

See also
Change the enable for acquisition objects for the energy program (Page 41)
Making general settings for the energy program (Page 68)
Important information on energy data (Page 26)
Generate energy program (Page 176)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 77
Generate energy program
5.6 Structure of the energy program

5.6 Structure of the energy program

5.6.1 Structure of the energy program

When the energy program is generated, the following folders are automatically created
below the S7-1500 CPU:
• "Energy Suite - program" folder under "Program blocks" with subfolders
– [EnS general program elements]
- EnS - block types (Page 79)
- EnS - program blocks (Page 81)
– Acquisition objects (Page 84)
• Folder "Energy Suite - data types (Page 85)" under "PLC data types"

Note
Blocks of the energy program
SIMATIC Energy Suite automatically generates for you all the required blocks and data types
and their interconnection based on the configured acquisition objects and the energy
program settings.
You do not need to further adapt these blocks for the standard application with Energy Suite.

CAUTION
Manual change to blocks of the energy program
If you make manual changes to the blocks after generating the energy program, you
yourself are responsible for the error-free operation of the devices and the energy program.

CAUTION
Using Energy Suite blocks in other PLC programs
If you use the Energy Suite blocks from the global library in other PLC programs, you
yourself are responsible for error-free use of Energy Suite blocks.

See also
Acquisition objects and energy acquisition program (Page 34)

SIMATIC Energy Suite V19.0

78 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

5.6.2 EnS - block types

The structure of your energy program depends on the following configurations:
• Energy data sources (Page 24)
• Enabled acquisition objects (Page 39)
• Energy program settings (Page 68)
The following shows how the Energy Suite blocks generally work in the energy program for
energy data from the process image of the CPU (PLC tags) or from data blocks (DB tags).
When the input measurement data is received from the connected measurement hardware,
the hardware-specific function blocks (FBs) are added with driver functionality. You can find
additional information on this in the section "Structure of the energy program for
measurement hardware (Page 86)".

How Energy Suite blocks work

The placeholder "xxx" in the picture means that there are different types of this block, for
example, for "EnS_Drvxxx":
• EnS_DrvPulse
• EnS_DrvCounterLInt
You can find more types in the "EnS - block types" table after the picture.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 79
Generate energy program
5.6 Structure of the energy program

The following picture show how the Energy Suite blocks work:

* EnS_BufferRead is not called for archiving in WinCC Professional

Energy data flow

Parameter assignment data

Blocks used internally

Blocks associated with an acquisition object table

SIMATIC Energy Suite V19.0

80 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

EnS - block types

The "Acquisition - block types" subfolder contains the instances of all function blocks from the
Energy Suite library once the energy acquisition program is generated. When the
measurement hardware acts as the energy data source, this subfolder also contains a further
subfolder "EnSL - block types" with the instances of the associated Driver block from the
measurement hardware library (Page 86).

Function block Description Example in STEP 7 (TIA Portal)

EnS_ArchiveDataLog Archived energy data in data logs (CSV
(Page 211) file on the SIMATIC memory card of the
CPU)
EnS_ArchiveHMI Archived energy data in data logs of
(Page 221) WinCC Professional
EnS_BufferRead Reads the data from the buffer DB
(Page 229) (EnS_BufferDB (Page 265)).
Used internally
EnS_BufferWrite Writes data to the buffer DB
(Page 231) (EnS_BufferDB (Page 265)).
Used internally
EnS_CalcEnergyData Periodically calculates the energy used
(Page 234) and average power consumption
EnS_DrvAnalogValue Driver block for analog input (e.g.
(Page 240) power value, flow value)
EnS_DrvCounterLInt Driver block for counter values of the
(Page 242) LINT type
EnS_DrvCounterLReal Driver block for counter values of the
(Page 244) LReal type
EnS_DrvPulse Driver block for a pulse input
(Page 246)
EnS_EnergyDataAdv Advanced energy data from a device
(Page 248) (for example, phase-specific current
and voltage values)
EnS_EnergyDataAdvMin Minimum and maximum values of the
Max (Page 249) advanced energy data of a device
EnS_EnergyDataBasic Basic energy data from a device (for
(Page 250) example, power, energy counter value)
EnS_Organization Contains general data and parameters
(Page 255) for central program organization
EnS_TimeSync Synchronizes the times for calculating
(Page 256) the energy data
EnS_EnergyDataAdd Additional energy data
(Page 263)

5.6.3 EnS - program blocks

The "EnS - program blocks" folder contains additional blocks, such as organization blocks,
data blocks and functions (FCs) required for the energy program, once the program is
generated.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 81
Generate energy program
5.6 Structure of the energy program

EnS - program blocks

The "EnS - program blocks" folder contains the following blocks once the program is
generated:

Block Description Example in STEP 7 (TIA Portal)

Organization block
EnS_CycInt<NNNcc>OB Three cyclic interrupt OBs with different timings.
"NNN" and "cc" are placeholders for the clock
and the unit.
Example:
For three clock speeds of 100 ms, 1000 ms and
10000 ms, the following cyclic interrupt OBs are
created:
• "EnS_CycInt100msOB"
• "EnS_CycInt1sOB"
• "EnS_CycInt10sOB"
EnS_StartupOB Startup OB 100
Function
EnS_Archive_CycInt<NNNcc> An FC for archiving energy data in the cyclic
interrupt OB. "NNN" and "cc" are place holders
for the duration and unit.
Example:
With a cycle time of 500 ms, the
"EnS_Archive_CycInt500ms" FC is created.
EnS_Basic_CycInt<NNNcc> An FC for the basic energy data of acquisition
objects in the cyclic interrupt OB. "NNN" and "cc"
are place holders for the duration and unit.
Example:
With a cycle time of 1s, "EnS_Basic_CycInt1s" is
created.
EnS_Drv_CycInt<NNNcc> An FC for the driver blocks of acquisition objects
in the cyclic interrupt OB. "NNN" and "cc" are
place holders for the duration and unit.
Example:
With a cycle time of 100 ms,
"EnS_Drv_CycInt100ms" is created.
EnS_Org_CycInt<NNNcc>FC Three FCs for the central organization of the
energy program that are called in the cyclic
interrupt OB and startup OB. "NNN" and "cc" are
place holders for the cycle duration and unit.
Example:
For three cycle times of 1 s, 100 ms and 10 s,
the following FCs are created:
• "EnS_Org_CycInt1sFC"
• "EnS_ Org_CycInt100msFC"
• "EnS_ Org_CycInt10sFC"

SIMATIC Energy Suite V19.0

82 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

Block Description Example in STEP 7 (TIA Portal)

EnS_StartupFC FC called in the startup OB.
EnS_Sync_CycInt<NNNcc> An FC for the time synchronization. "NNN" and
"cc" are place holders for the duration and unit.
Example:
With a cycle time of 500 ms, the
"EnS_Sync_CycInt500ms" FC is created.
Data block
EnS_Archive<N> Instance DB of FB "EnS_ArchiveDataLog". "N" is a
Unique ID for the respective acquisition object
table.
Example: For Acquisition object table with
unique ID 1234, the "EnS_Archive1234" instance
DB is created
DrvPulse_<name of the ac- Instance DB of the FB "EnS_DrvPulse"
quisition object> Example:
The instance DB "DrvPulse_Transformer1" is
created by an acquisition object with the name
"Transformer1".
EnS_Calc_<name of the ac- Instance DB of FB "EnS_CalcEnergyData"
quisition object> Example:
The instance DB "EnS_Calc_Transformer1" is
created by an acquisition object with the name
"Transformer1".
EnS_Org_CycInt<NNNcc> Instance DB of FB "EnS_Organization". "NNN"
and "cc" are place holders for the cycle duration
and unit.
Example:
With a cycle time of 10 ms, an
"EnS_Org_Cyclnt10ms" instance DB is created.
EnS_Sync_Period_<NNNcc> Instance DB of FB "EnS_TimeSync". "NNN" and
"cc" are placeholders for the synchronization
period and the unit.
Example:
For a synchronization period of 15 minutes, the
"EnS_Time15m" instance DB is created.

See also
EnS_BufferDB (Page 265)
EnS_BufferWorkDB (Page 266)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 83
Generate energy program
5.6 Structure of the energy program

5.6.4 Acquisition objects

Once the program is generated, the "Acquisition objects" folder contains a subfolder with the
name of the acquisition object table "<name of the acquisition object table>" for each
acquisition object table with acquisition objects.
The "<name of the acquisition object table>" folder contains the instance data blocks
• On the function blocks that are required for the acquisition objects in the energy program
• With the periodic energy values of the acquisition objects, which are provided for
buffering and archiving
The data blocks for buffering the energy data are also created as instances from the Energy
Suite library in this folder.

<Name of the acquisition object table>

Depending on the configuration of the acquisition objects, the "<name of the acquisition
object table>" folder may contain the following data blocks:

Data block Description Example in STEP 7 (TIA Portal)

<Name of the acquisition Data block with information for the measuring
object> point and the energy values that are provided
for archiving
EnS_Buffer<Unique id of Data block for buffering energy data records.
acquisition object table>
(Page 265)
Example:
The "EnS_BufferXXXXX" buffer DB is created by
an acquisition object table with the unique ID
XXXXX of acquisition object table.
EnS_BufferWork<Unique id Data block for control and status information
of acquisition object table> of the buffer.
(Page 266) Example:
The "EnS_BufferWorkXXXXX" buffer DB is cre-
ated by an acquisition object table with the
unique ID XXXXX of acquisition object table.

SIMATIC Energy Suite V19.0

84 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

5.6.5 Energy Suite - data types

Energy Suite - data types

The "Energy Suite - data types" folder contains the instances of the following data types
blocks from the Energy Suite library once the program is generated:

Data type Description Example in STEP 7 (TIA Portal)

EnS_typeAnalogValue Data type for analog process values
(Page 267)
EnS_typeBufferReadCtrl Data type for control information of the buffer
(Page 267) for reading data
EnS_typeBufferReadStat Data type for data and status information of the
(Page 268) buffer for reading data
EnS_typeBufferWork Data type for control and status information of
(Page 268) the buffer
EnS_typeBufferWriteCtrl Data type for control information of the buffer
(Page 270) for writing data
EnS_typeBufferWriteStat Data type for status information of the buffer
(Page 270) for writing data
EnS_typeEnergyAdv Data type for advanced energy data
(Page 271)
EnS_typeEnergyBasic Data type for basic energy data
(Page 272)
EnS_typeEnergyCounter Data type for energy counter value
(Page 273)
EnS_typeEnergyMeta Data type for metadata of the measuring point
(Page 274) (information for configuration of the acquisition
object)
EnS_typeHMIWriteCtrl Data type for control information of the buffer
(Page 277) for writing energy data to the data log of WinCC
Professional
EnS_typeHMIWriteStat Data type for status information of the buffer
(Page 278) for writing energy data to the data log of WinCC
Professional
EnS_typeOrgData Data type for organizational data
(Page 279)
EnS_typeSync (Page 279) Data type for time synchronization
EnS_typeValue (Page 280) Data type for output values
EnS_typeEnergyAdd Data type for additional energy data
(Page 280)
Ens_typeEnergyAddValue Data type for additional energy data value
(Page 281)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 85
Generate energy program
5.6 Structure of the energy program

5.6.6 Driver blocks for measurement hardware

5.6.6.1 Structure of the energy program for measurement hardware

Driver blocks of the measurement hardware for STEP 7 (TIA Portal)

The energy data (input measurement data) of the measurement hardware are made available
in different ways (e.g. differences in the data format or in the data record address). These
differences make it difficult to access and further process the energy data from the
measurement hardware in the PLC program.
For this, in addition to the Energy Suite blocks, hardware-specific function blocks (FBs) with
driver functionality are available for the measurement hardware from the Energy Support
Library (EnSL). This hardware-specific function blocks (referred to as driver blocks in the
following), form the interface between the measurement hardware and automation system.
The energy data from the measurement hardware is read and uniformly provided to the
automation system using driver blocks. In this way, the raw energy data is provided easier
and faster to your PLC program and Energy Suite. The components of the Energy Suite are
then used to prepare and process raw energy data.

Interaction of Energy Suite blocks and driver blocks for measurement hardware
When the energy program is generated, instances of specific driver blocks for the
measurement hardware are automatically created and interconnected (depending on the
selected energy data sources) in the "EnS block types" folder of the energy program.
The following sections of this document describe the basic interaction of the Energy Suite
blocks and the specific driver blocks for the measurement hardware in the energy program.

Documentation of the specific driver blocks for the measurement hardware

You can find a detailed description about how driver blocks operate and their block
parameters in the documentation of the measurement hardware. The documentation for the
measurement hardware is part of the Energy Support Library (EnSL).

SIMATIC Energy Suite V19.0

86 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

5.6.6.2 Energy data processing based on the "IPO" principle

Energy data processing according to the "IPO" principle can be divided into "Input"
"Processing" and "Output":

How function blocks work

The following figure shows the general operation of the driver blocks for the measurement
hardware according to the "IPO" principle:

Energy data via cyclic communication (process image)

Energy data via acyclic communication (read data record)
Driver blocks for measurement hardware
Blocks of the SIMATIC Energy Suite
Required blocks
Optional blocks

The following table describes the different areas of the picture:

Area Description
Input Contains the measurement hardware (for example, measuring instrument) which provides the
input measurement data for processing
Processing Acquisition, calculation, time stamping and provision of energy values for other systems by the
respective function blocks
Output Provision of periodic energy values for different systems for visualizing, archiving or further evalu-
ation (for example, SIMATIC Energy Manager PRO)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 87
Generate energy program
5.6 Structure of the energy program

5.6.6.3 Area: Input

The measurement hardware is entered in the "Input" area. The driver blocks read the energy
measurement data from the measurement hardware. This is done using cyclical
communication (process image) and/or acyclic communication (read data record).
The following figure shows "input" according to the "IPO" principle:

Energy data using cyclic communication (process image)

Energy data using acyclic communication (read data record)

You can find a detailed description of the measurement hardware in the documentation for
the respective measuring instrument.

5.6.6.4 Area: Processing

In the "processing" area, the energy data from the respective driver blocks are acquired,
normalized and prepared as raw energy data that can be easily further processed.
The "Basic", "Adv" and "Add" blocks are located in the "Driver blocks" area. The "EnSL_DrvBasic"
driver block passes the current basic energy data to the Energy Suite function block
"EnS_CalcEnergyData (Page 234)". The "EnS_CalcEnergyData" function block calculates the
energy consumption and the average power over the individually configured archiving period
(e.g. 15 min.).
You can find a detailed description of the driver blocks in the documentation for the
respective measurement hardware.

SIMATIC Energy Suite V19.0

88 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

The following figure shows an example of "processing" according to the "IPO" principle. The
interconnection of the parameters may vary depending on the measurement hardware used.

Cyclic energy data

Acyclic energy data
Driver blocks for measurement hardware
Blocks of the SIMATIC Energy Suite
Required blocks
Optional blocks

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 89
Generate energy program
5.6 Structure of the energy program

The following table describes the components of a picture:

Component Description
EnSL_DrvBasic Driver block for basic energy data
Reads the basic energy data via cyclic communication from the measurement hardware, for
example, energy counters, power
EnSL_DrvAdv Driver block for advanced energy data
Reads a data record with advanced energy data via acyclic communication from the meas-
urement of hardware, for example, voltage, current
EnSL_DrvAdd Driver block for additional energy data
Reads a record with additional energy data via acyclic communication from the measure-
ment hardware, for example, harmonics
EnS_CalcEnergyData Energy Suite block for further processing (periodic calculation, time stamping, etc.) the
energy data.
You can find additional information on this in the section "EnS_CalcEnergyData (Page 234)".
Cyclic energy data Predominantly basic energy data that are read by the "EnS_DrvBasic" driver block from the
measurement hardware using cyclic communication (process image).
Acyclic energy data Predominantly advanced and additional energy data that is read by the "EnSL_DrvAdv" and
"EnSL_DrvAdd" driver blocks using acyclic communication (read data record).
messageSuppress Alarm suppression
energyMeta Process tag specific data
You can find additional information on this in the section "EnS_typeEnergyMeta (Page 274)".
orgData Organization data
You can find additional information on this in the section "EnS_typeOrgData (Page 279)".
enableDrvAdv Processing enable of the "EnSL_DrvAdv" driver block
energy Current value of the active energy counter
power Current value of the active power
measValues Cyclic measurement data that is passed to the "EnSL_DrvAdv" driver block
advData Extended measured data record
addData Additional energy data
addDataLReal / addDataReal Current LREAL/REAL data record

See also
Important information on energy data (Page 26)

SIMATIC Energy Suite V19.0

90 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.6 Structure of the energy program

5.6.6.5 Area: Output

After acquisition and processing, the energy data are collected in the "Output". The "Output"
serves as an interface for visualization with SIMATIC WinCC or other MES (for example,
SIMATIC Energy Manager PRO).
The following figure shows "output" according to the "IPO" principle:

Cyclic energy values

Acyclic energy values

Blocks of the SIMATIC Energy Suite

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 91
Generate energy program
5.6 Structure of the energy program

The following table describes the components of a picture:

Function block Description

EnS_EnergyDataBasic Energy Suite block for providing the prepared basic energy data and metadata. The cyclic basic en-
ergy data are calculated to the following values by the "EnS_CalcEnergyData" Energy Suite block:
• Energy consumption over a period (for example, 15 min.)
• Average power over a period (for example, 15 min.)
You can find additional information under "EnS_EnergyDataBasic: Providing metadata and energy
values (Page 250)".
EnS_EnergyDataAdv Energy Suite block for providing a data record with advanced energy values
Advanced energy values (acyclic):
• Voltage, current, cos φ
• Apparent, active and reactive power etc.
You can find additional information under "EnS_EnergyDataAdv: Providing advanced energy values
(Page 248)".
EnS_EnergyDataAdv Energy Suite block for providing a data record with minimum and maximum values of the advanced
MinMax energy values
Minimum and maximum values of the advanced energy values:
• Voltage, current, cos φ
• Apparent, active and reactive power
You can find additional information under "EnS_EnergyDataAdvMinMax: Providing advanced mini-
mum and maximum values (Page 249)".

SIMATIC Energy Suite V19.0

92 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.7 Compiling and downloading the PLC program

5.7 Compiling and downloading the PLC program

Once the energy program is generated, compile the complete PLC program and download it
to the S7-1500 CPU target system.
There are several ways to compile and download project data to the CPU. One version is
described below. You can find additional information on this in the online help of the TIA
Portal information system.

Requirement
• The energy program has been fully generated without error.
• The PLC program is also complete and error free.

Compile
To compile the entire PLC program (including the energy program), follow these steps:
1. Open the S7-1500 CPU in the project tree.
2. Click "Program blocks" object below the S7-1500 CPU and select the command "Compile >
Software (rebuild all blocks)" from the shortcut menu.
The PLC program is compiled. You can check to see if the compiling has been successfully
executed in the Inspector window under "Info > Compile".
3. If needed, correct the causes of possible compiling errors and start the compiling again.

Download
To compile the entire PLC program on the CPU, follow these steps:
1. Open the S7-1500 CPU in the project tree.
2. Click "Program blocks" object below the S7-1500 CPU and select the command "Download to
device > Software (only changes)" from the shortcut menu.
3. Follow the instructions of the wizard for charging. If required, select the interface for the
online connection to the target system.
The online connection to the CPU is established.
4. Click on the "Download" button and then the "Finish" button.
If the download was successful, the entire PLC program (including the energy program) is
loaded into the CPU. If the download was not successful, consult the online help of the TIA
Portal information system to learn about the further actions required.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 93
Generate energy program
5.8 Testing the energy program

5.8 Testing the energy program

The standard functions of STEP 7 (TIA Portal) enable you to test the acquisition and
processing of the energy values.

Requirement
• The energy program has been fully generated without error.
• The PLC program has been successfully compiled and downloaded to the S7-1500 CPU.
• An online connection to S7-1500 CPU is available.
• Program execution is active (CPU in "RUN").

Procedure
To test the energy program, follow these steps:
1. In the "EO - <name of the acquisition object>" folder, open the data block for the acquisition
object: <name of the acquisition object> [DBx].
The contents of the data block with the metadata and energy data of the acquisition
object opens in the working area.
2. Start the monitoring by clicking the "Monitor all" icon.
The additional "Monitor value" column is displayed in the table. It displays the current data
values. You can track and, in needed, control the current periodic energy values under the
"energyData" structure

Behavior after regeneration of the energy program

The Energy Suite has the following behavior when the energy program is regenerated:
1. The entire energy program is deleted.
2. The energy program including changes is newly created.
All unchanged acquisition objects are created exactly as before.
3. The addresses (symbolic names) of the DBs are changed when the following settings are
changed:
– Name of the acquisition object (instance DB of EnS_Drvxxx, EnS_CalcEnergyData,
EnS_EnergyDataBasic)
– Name of the measurement hardware used in the hardware configuration (instance DB
of EnSL_DrvBasicxxx)
– Name of the archiving period (instance DB of EnS_TimeSync)

Note
The DB numbers are assigned automatically by STEP 7 (TIA Portal).

SIMATIC Energy Suite V19.0

94 Function Manual, 12/2023, A5E36824823-AH
 Generate energy program
5.9 Editing the PLC program without installation of Energy Suite

5.9 Editing the PLC program without installation of Energy Suite

STEP 7 (TIA Portal) projects that have configured acquisition objects and parts of an energy
program can be opened and edited on STEP 7 (TIA Portal) computers on which there is no
installation of Energy Suite.
This allows you to further edit the device configuration or the rest of the PLC program, for
example. The existing configuration of acquisition objects and the generated energy program
remain unchanged in the project.

Response of the engineering system without an Energy Suite installation

When you open such a STEP 7 (TIA Portal) project on an engineering system without an
Energy Suite installation, a dialog appears informing you that no installation of the Energy
Suite is available. After confirming the dialog, you can change the project (excluding the
Energy Suite objects), compile it, and download it to the target systems (S7-1500 CPU, PC
station).

Possible application examples

The following figure and the following table show the applications that are possible for the
project execution without installing Energy Suite:

Application Newly created/changed ...can be further pro- Supported processing

example project on engineering cessed on the engineer-
station (1) with ing station (2) with
① • STEP 7 Professional • STEP 7 Professional Opening and editing a STEP 7 (TIA Portal) project
on the engineering station (2) containing an
• WinCC Professional Energy Suite configuration but no Energy Suite
• Energy Suite • STEP 7 Professional installation.
with at least acquistion • WinCC Professional The Energy Suite configuration remains un-
object changed.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 95
Generate energy program
5.10 PLC program without measurement hardware library with driver blocks

Application Project that can be fur- ... can be further pro- Supported processing
example ther processed on engi- cessed on the engineer-
neering station (2) with ing station (1) with
② • STEP 7 Professional • STEP 7 Professional Opening and editing a STEP 7 (TIA Portal) project
on an engineering station (1) containing an En-
with unchanged Energy • WinCC Professional ergy Suite installation after it was previously
Suite configuration
• Energy Suite changed on an engineering station (2) without
• STEP 7 Professional an Energy Suite installation.
• WinCC Professional Note: If a PLC (S7-1500 CPU) with configured
acquistion objects has been entirely deleted
with unchanged Energy beforehand, the Energy Suite objects for this S7-
Suite configuration 1500 CPU are no longer available in the project.

5.10 PLC program without measurement hardware library with driver

blocks
STEP 7 (TIA Portal) projects that have configured acquistion objects and parts of an energy
program for measurement hardware can also be opened and edited on STEP 7 (TIA Portal)
computers on which there is no installation of the Energy Support Library .
This allows you to further edit the device configuration or the rest of the PLC program, for
example. The existing configuration of acquisition objects and the generated energy program
for measurement hardware remain unchanged in the project.

Response of the engineering system without Energy Support Library

When configuring the acquisition objects and assigning the energy data source, the
measurement hardware for an Energy Support Library that no longer exists (for example,
because the Energy Support Library was uninstalled) is no longer displayed in the list of
possible energy data sources.
Measurement hardware already assigned as an energy data source for an Energy Support
Library that is no longer available prevents regeneration of the energy program. The missing
reference is displayed in the selection field of energy data source. Regeneration of the energy
program is canceled as long as the missing reference is not corrected (for example, by
changing the energy data source or by installing the Energy Support Library).
The remainder of the PLC program that is unaffected by the energy program can still be
modified, compiled and downloaded to the target systems (S7-1500 CPU, PC station).

SIMATIC Energy Suite V19.0

96 Function Manual, 12/2023, A5E36824823-AH
Visualizing and evaluating energy data 6
6.1 Procedural overview of archiving and visualization with WinCC
Professional/WinCC Unified

Requirement
To perform the following configuration steps, the following requirements must be met in
STEP 7 (TIA Portal) in the project tree below the S7-1500 CPU:
• For each CPU that provides energy data, the "WinCC Professional/WinCC Unified (data log)"
archiving type is enabled.
You can find additional information on this in the section "Setting the archiving on a PC
station with WinCC Professional/WinCC Unified (Data Log) (Page 61)".
• The energy program has been fully generated without error.
• The PLC program has been successfully compiled and downloaded to the S7-1500 CPU.

Configuration steps
The following table provides an overview of the most important configuration steps for
visualization and archiving of the periodic energy data with the WinCC Professional/WinCC
Unified SCADA system.
These steps are performed in STEP 7 (TIA Portal) in the project tree below the PC station.

Topic Step Description

Visualizing and 1.1 Configuring a PC station with A PC station with the SIMATIC "WinCC RT Professiona/WinCC
evaluating energy WinCC Professional/WinCC Uni- Unifiedl" HMI application is required for the SCADA system.
data fied
1.2 Creating a connection to the To enable data transfer between the S7-1500 CPU and the
SCADA system SCADA system, configure an HMI connection to the PC
station with WinCC Professional/WinCC Unified in STEP 7
(TIA Portal).
1.3 Reading and displaying energy On the PC station with WinCC Professional/WinCC Unified,
values configured for archiving Energy Suite offers an overview of all acquisition objects
on the engineering system on and the periodic energy values that you have configured in
the PC station (Page 100) the engineering system for archiving in the data log of
WinCC Professional/WinCC Unified.
With the "Refresh" function, synchronization is performed
with the engineering data of the S7-1500 CPUs that can be
reached by the PC station with WinCC Professional/WinCC
Unified.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 97
Visualizing and evaluating energy data
6.1 Procedural overview of archiving and visualization with WinCC Professional/WinCC Unified

Topic Step Description

Visualizing and 1.4 Configuring the SCADA system Configuring the PC station with WinCC Professional/WinCC
evaluating energy (Page 103) Unified:
data
• For data transfer to the SCADA system, generate the
HMI tags for the data blocks for buffering ("HMI tags"
folder).
• For archiving, generate the data log with the logging
tags (energy values) and set up the archive segments
for archiving (Page 108) of the periodic energy values
("Archive" folder).
• For visualization of the collected energy data in runtime,
you can integrate the template screens and screen ele-
ments from the Siemens Industry Online Support into
the WinCC application ("Screens" folder).
• For the visualization of the collected energy data in
runtime, you can also use the automatically installed
faceplates from the Energy Suite library.
• With installed SIMATIC Visualization Architect (SiVArc),
you can generate Screens based on created SiVArc rules
for Energy Suite (Page 110). With SiVArc you generate
the visualization for multiple HMI devices and PLCs from
Energy Suite program blocks and vizualisation tem-
plates.
1.5 Compiling and downloading the Next you compile the configuration for the entire PC station
PC station with WinCC Profes- and download it to the SCADA system.
sional/WinCC Unified
1.6 Starting the PLC program and Once WinCC RT Professional is started on the SCADA system
SCADA system (Runtime) and the PLC programs are started on the S7-1500 CPUs,
archiving is ready to begin.
The selected periodic energy values are archived automati-
cally. The archiving is performed continuously while
Runtime is active.

SIMATIC Energy Suite V19.0

98 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.2 Energy values on PC station with WinCC Professional/WinCC Unified

6.2 Energy values on PC station with WinCC Professional/WinCC

Unified
The periodic energy values prepared on the S7-1500 CPU can be transferred to the data log of
WinCC Professional/WinCC Unified for long-term archiving. For example, this allows you to:
• Generate reports from energy values
• Visualize the energy values within WinCC Professional/WinCC Unified environment
• Transfer energy values to SIMATIC Energy Manager PRO for further processing on the
management level
On the PC station with WinCC Professional/WinCC Unified, the Energy Suite offers an
overview of all acquistion objects and the periodic energy values that you have enabled for
archiving in the data log of WinCC Professional/WinCC Unified.
Once the SIMATIC Energy Suite has been successfully installed, there is this new "Energy data"
folder in the project tree below the PC station with WinCC Professional/WinCC Unified.
The following figure shows the "Energy data" folder in the project tree.

See also
Displaying energy values for archiving in WinCC Professional/WinCC Unified (Page 100)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 99
Visualizing and evaluating energy data
6.3 Displaying energy values for archiving in WinCC Professional/WinCC Unified

6.3 Displaying energy values for archiving in WinCC

Professional/WinCC Unified
You would like an overview of all acquisition objects and their periodic energy values that you
have configured for archiving in the data log of WinCC Professional/WinCC Unified.

Requirement
• For each CPU that provides energy data, the "WinCC Professional/WinCC Unified(data log)"
archiving type is enabled.
You can find additional information on this in the section "Setting the archiving on a PC
station with WinCC Professional/WinCC Unified (Data Log) (Page 61)".
• A PC station with the SIMATIC "WinCC RT Professional/WinCC Unified" HMI application is
configured in your project.
• A valid HMI connection between the S7-1500 CPU and the PC station with WinCC
Professional/WinCC Unified exists.
You can find additional information on this in the online help of the TIA Portal information
system under "Configuring HMI connections > Creating a new connection graphically".

Procedure
To display the energy values for the logging and archiving, follow these steps:
1. Open the PC station in the project tree.
2. Below the PC station, open the application "WinCC RT Professional/WinCC Unified".
The "Energy data" object is visible below the application.
3. Double-click on the "energy data" object.
A table with all the acquisition objects of S7-1500 CPUs of the entire project opens in the
working area. This gives you an overview of all available acquisition objects and the
periodic energy values to be archived in data log of WinCC Professional/WinCC Unified.
4. Click on the "Refresh" icon.
The data in the table are read in again. A comparison is performed between the
engineering data from this PC station and the S7-1500 CPUs that can be reached by WinCC
Professional/WinCC Unified.

SIMATIC Energy Suite V19.0

100 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.3 Displaying energy values for archiving in WinCC Professional/WinCC Unified

Result
For each acquisition object, there is an enable for the energy program and the configuration
of the following energy values for archiving:
• Power consumption
• Energy consumption
• Energy counter value
The meaning of the displays is described in detail in the section "Overview of energy data
(Page 102)".

Note
Quantity structure
• A maximum of 2000 acquisition objects can be archived with WinCC Professional/WinCC
Unified.
• The acquisition objects of a maximum of 10 S7-1500 CPUs can be archived.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 101
Visualizing and evaluating energy data
6.4 Overview of energy data

6.4 Overview of energy data

The "energy data" table in the "WinCC RT Professional/WinCC Unified" application provides an
overview of the configured acquisition objects and the periodic energy values to be archived
in data log of WinCC Professional/WinCC Unified.

Note
Adaptation of periodic energy values
The periodic energy values are only displayed in WinCC Professional/WinCC Unified. To
change the settings of the periodic energy values, you have to switch to the configuration of
the acquisition objects and the energy program settings below the S7-1500 CPUs.

The following table shows the settings for acquisition and archiving of the energy values in
the data log of WinCC Professional/WinCC Unified:

Setting Description
Name of the acquisition Displays the name of the acquisition object. The name can only be
object changed when configuring the acquisition object below the S7-1500
CPU.
Name of the CPU Displays the name of the S7-1500 CPU to which the acquisition object is
assigned
Enable acquisition object Displays the enable status of the acquisition object for the generation of
the energy program. You activate the enable when configuring the
acquistion object below the S7-1500 CPU.
Power consumption Indicates whether the periodic energy values of the power consumption
are enabled for archiving
Energy consumption Indicates whether the periodic energy values of the energy consump-
tion are enabled for archiving
Energy counter value Indicates whether the periodic energy values of the energy counter
value are enabled for archiving
Duration of archiving peri- Shows the duration of the archiving period. The duration can only be
od changed in the energy program settings below the S7-1500 CPU.
Name of the archiving peri- Displays the name of the archive period. The name can only be changed
od in the energy program settings below the S7-1500 CPU.

Note
Quantity structure
• A maximum of 2000 acquisition objects can be archived with WinCC Professional/WinCC
Unified.
• The acquisition objects of a maximum of 10 S7-1500 CPUs can be archived.

See also
Displaying energy values for archiving in WinCC Professional/WinCC Unified (Page 100)
Energy values on PC station with WinCC Professional/WinCC Unified (Page 99)

SIMATIC Energy Suite V19.0

102 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.5 Create archiving structure for energy values

6.5 Create archiving structure for energy values

After synchronization of the energy data of the engineering system with the energy data of
the PC station with WinCC Professional/WinCC Unified, generate the HMI tags and the data
log with the logging tags for the energy values to be archived. This generation takes place
automatically by pressing a button; manual adjustment afterwards is not required.
The generated data can then be compiled and downloaded to the SCADA system or is
available for visualization in Runtime.

Requirement
• For each CPU that provides energy data, the "WinCC Professional/WinCC Unified (data log)"
archiving type is enabled.
You can find additional information on this in the section "Setting the archiving on a PC
station with WinCC Professional/WinCC Unified (Data Log) (Page 61)".
• A PC station with the SIMATIC "WinCC RT Professional/WinCC Unified" HMI application is
configured in your project.
• A valid HMI connection exists between the S7-1500 CPU and the PC station with WinCC
Professional/WinCC Unified.
You can find additional information on this in the online help of the TIA Portal information
system under "Configuring HMI connections > Creating a new connection graphically".

Procedure
To generate the archiving structure for the energy values, follow these steps:
1. Open the PC station in the project tree.
2. Below the PC station, open the application "WinCC RT Professional".
The "Energy data" object is visible below the application.
3. Double-click on the "energy data" object.
– For acquisition objects the table with all acquisition objects and their archived periodic
energy values is opened in the working area structured according to the S7-1500 CPUs
of the entire project.
– For load management systems the table with all load management systems and their
archived periodic energy values is opened in the working area structured according to
the S7-1500 CPUs of the entire project.
4. Click the icon "Create data log".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 103
Visualizing and evaluating energy data
6.5 Create archiving structure for energy values

Result: HMI tags created

A new folder "Energy Suite - HMI tags" is created automatically in the "HMI tags" folder in the
project tree below the PC station with all tags required for the data blocks for buffering.

Object Description
1 EnS - System tags Internal tag @EnS_SystemTag for the connection to the data log
2 EnS - System tags The following HMI tags are created for each data block n (n = 1, 2, 3, ...)
_<name of the CPU> for buffering (and therefore for each acquisition object table):
• @EnS_Archive<n>_request_<name of the CPU> with the data type
EnS_typeHMIWriteCtrl
• @EnS_Archive<n>_statusWrite_<name of the CPU> with the data
type EnS_typeHMIWriteStat
• @EnS_Buffer<n>_<name of the CPU> with the array of
EnS_typeValue data type

SIMATIC Energy Suite V19.0

104 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.5 Create archiving structure for energy values

Object Description
3 EnS - BLMGT tags The following HMI tags are created for each data block n (n = 1, 2, 3, ...)
_<name of the CPU> for Base load management visualization ( and therefore for each base-
load management system):
• @EnS_BaseLmgtGeneralData_<name of load management sys-
tem>_averageValues_avgPower_<name of the CPU> with data type
Real
• @EnS_BaseLmgtGeneralData_<name of load management sys-
tem>_visualization_actPowerInfeed_<name of the CPU> with data
type LReal
• @EnS_BaseLmgtGeneralData_<name of load management sys-
tem>_visualization_powerLimitHigh_<name of the CPU> with data
type LReal
• @EnS_BaseLmgtGeneralData_<name of load management sys-
tem>_visualization_powerLimitHighConfig_<name of the CPU> with
data type LReal
• @EnS_BaseLmgtGeneralData_<name of load management sys-
tem>_visualization_powerLimitLow_<name of the CPU> with data
type LReal
• @EnS_BaseLmgtGeneralData_<name of load management sys-
tem>_visualization_powerLimitLowConfig_<name of the CPU> with
data type LReal

The associated table in the working area shows the created HMI tags and the HMI connection
to the S7-1500 CPU. The HMI tags cannot be changed.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 105
Visualizing and evaluating energy data
6.5 Create archiving structure for energy values

Result: Data log with logging tags

For acquisition objects a new data log called "EnS_EnergyArchive" with default settings is
automatically created in the working area for the "Archive" folder. The settings "Locked",
"Manual input permitted" can be checked and changed, if necessary.
An archive tag with the name of the acquistion object and the extensions _energy, _power or
_energyCounter is created in the "Logging tags" area for each energy value of all configured
acquistionobjects that is to be archived. The generated logging tags are write-protected and
connected to the internal tag "@EnS_SystemTag".
Parameter values are created in the "Comment for Runtime" column; these can be interpreted
by the SIMATIC Energy Manager PRO for further processing.

For base load management a new data log called "EnS_BLMGT_PowerValue" with default
settings is automatically created. The settings "Locked", "Manual input permitted" can be
checked and changed, if necessary.

SIMATIC Energy Suite V19.0

106 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.5 Create archiving structure for energy values

Archive tags with the name of the base load management system and the extensions
_avgPower, _actPowerInfeed, _avgPower, _power, _powerLimitHigh,
_powerLimitHighConfig, _powerLimitLow,_powerLimitLowConfig are created in the "Logging
tags" area for each energy value of all configured base load management systems that is to
be archived. The generated logging tags are write-protected and connected to power tag
linked to respective values from EnS_BaseLmgtGeneralData_<name of load management>
data block elements.

In addition, the Energy Suite component is entered in the startup list of WinCC Runtime
under:
Runtime settings > Service > Additional tasks/applications
The generated data can be compiled and downloaded to the SCADA system or is available for
visualization in Runtime.
Prior to compiling, check the Settings of the archive segments of the data log (Page 108) in
the Runtime settings of the PC station.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 107
Visualizing and evaluating energy data
6.6 Data log and segmentation for Energy Suite

6.6 Data log and segmentation for Energy Suite

The automatically created data log on the PC station with WinCC Professional/ WinCC Unified
enables long-term archiving of the energy values with time stamp so that the archived
historical data can be used for empirical statistical analyses.
In the Runtime settings below the PC station with WinCC Professional, you also have the
option of segmenting the data log and thereby defining its size.
Setup of the archive segments for archiving the periodic energy values is made in the
working area under:
Runtime settings > Archiving > Archive segments
For WinCC Unified, the same settings are available for each data log

Recommendation for segmenting the data log

Several archive segments of equal size are created in a segmented circular log and
successively filled with periodic energy data (process values). When all segments are
completely filled, the oldest segment is overwritten and the energy data it contains is lost.
Only the energy data within the period that contains all segments is accessed for long-term
archiving. The time period is set to 1 week by default.
The following Energy Suite recommendations apply to continuous long-term archiving of
energy data.
• Time period of all segments: 2 years
• Maximum size of all segments: 24 GB
• Time period contained in a single segment: 1 month
• Maximum size of a segment: 1 GB
• Backup: Activated
Also set the path for the backup on a backup server.

SIMATIC Energy Suite V19.0

108 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.7 Archiving energy data

6.7 Archiving energy data

Once both WinCC RT Professional/WInCC Unified and the PLC program have started, archiving
is ready to begin. The periodic energy values are archived automatically. The archiving is
performed continuously while Runtime is active.

Requirement
• The project has been compiled and downloaded to the target systems (CPUs and PC
station with WinCC Professional/WInCC Unified).
• There are online connections to the S7-1500 CPUs.
• The program processing on the S7-1500 CPUs is active (CPU in "RUN").
• PC station with WinCC Professional/WInCC Unified is in Runtime ("Start runtime").

Result
The archived data include:
• Time stamps generated by the CPU
• Parameters of the acquisition objects, for example:
– Name of the acquisition object
– Acquisition object detection
– High/low limit
– Name of the data log
• Periodic energy values over an archiving period:
– Energy counter value
– Energy consumption
– Power consumption
• Tag attributes (e.g. Quality Code)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 109
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

6.8 Create screens for Energy Suite with SiVArc

6.8.1 Create SiVArc screen rules and copy rules for Energy Suite
You can create screen rules for Energy Suite blocks using SiVArc.

Overview of rules
Individual rules will be available for each of the below Energy Suite blocks:
Few examples below:
• EnS_EnergyDataBasic: collects basic energy data and serves as an interface to an HMI
system
• EnS_EnergyDataAdv: collects advanced energy data and serves as an interface to an HMI
system
• EnS_LmgtControl_Peak: controls load management based on the forecast
• EnS_LmgtActuator_Consumer: controls the consumers based on commands from control
block
• EnS_LmgtActuator_Producer: controls the producer based on commands from control
block
• EnS_EnergyDataAdd: collects additional energy data and serves as an interface to an HMI
system
Similarly Base load management consists of blocks for Control, Consumer, Producer, Storage.

Pre-condition
• SIMATIC Visualization Architect (SiVArc) and SIMATIC Energy Suite version must be similar.
• Energy Suite rules are processed and screens are generated without a mandatory SiVArc
license.

Requirement
• Energy Suite license is available.
• SIMATIC Visualization Architect (SiVArc) is installed.

SIMATIC Energy Suite V19.0

110 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Procedure
To create the SiVArc screen rules, perform the following steps:
1. Open the S7-1500 CPU in the project tree.
2. Right click "Enery objects" > "Create SiVArc rules for Energy Suite" below the S7-1500 CPU.
Alternatively, you can select this option in the "Energy program settings" editor by clicking
the "Create SiVArc Screen rules for Energy Suite" icon.
Rules created through "Copy rules" feature also is used in screen generation.
3. Open the "Common data" folder in the project tree.
4. Open the "SiVArc" folder and double-click on the "Screen rules" object.

Result
System screen rules and copy rules are read only, and are available under “System Screen
rules” tab of SiVArc’s screen rules editor, and displays the following fields:
• Name: Unique name of the screen rule with structure
"EnS_<blockname>_<WinCCdevice>"; WinCCdevice = WinCCComf/WinCCPro
Example "EnS_EnergyDataBasic_WinCCComf"
• Created by: Energy Suite
• Program block: see list under section "Overview of rules"
• Master copy of a screen: Name of the required template of Energy Suite screens from the
Energy Suite Library (subfolder "EnS_Visualization")
• Screen type: The faceplate type or screen type that is used in visualization
• Copy rules: Allows you to copy the existing tags and screens from the library to the
respective HMI device
• Tag rule : Allows you to organize the tags generated with SiVArc screen generation

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 111
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

6.8.2 Create screens for Energy Suite

You can create screens for Energy Suite blocks that uses faceplates configured with tags for
viewing runtime data. SiVArc automates the screen generation through SiVArc rules, and
generates screens.

Pre-condition
• SIMATIC Visualization Architect (SiVArc) and SIMATIC Energy Suite version must be similar.
• Supported by Comfort , Advanced, Professional and Unified devices only
• For load management, professional and unified devices are supported.

Requirement
• Energy Suite license is available.
• SIMATIC Visualization Architect (SiVArc) is installed.
• SiVArc screen rules for Energy Suite (Page 110) are created.
• Successful generation of energy program.

Procedure
To generate the screens for Enery Suite follow these steps:
1. Select each HMI device.
2. You can generate SiVArc screens by clicking the global tool bar icon.
Alternatively you can right click on the HMI device, and select "Generate the visualization
(SiVArc)".
The "Select and generate devices" pop-up window displays.
3. For a specific HMI device, under "Rule Set" drop-down, select "Energy suite rules" >
"Generate".
For more information on the generaton process, you can view the feedback window.

Result
Screens using Energy Suite rules are created, and are available under "Screens" folder within a
HMI device.
For comfort devices, screens are generated and are available under "Screen management"
and "Pop-up screens". If user is deleting or renaming one of the existing acquisition objects
and if user regenerates the SiVArc screens, then some empty screens of deleted acquisition
objects are available under PNV and user has to delete them manually.
For successive generations, repeat the steps for each HMI device.
When multiple PLC’s are connected to a common HMI device (WinCC Professional/Unified
RunTime) and you generate SiVArc screen for Energy Suite rules, an error is displayed. The
error will be shown for all other screens. This error has to be ignored as the underlying
functionality is working fine. Error has to be treated as an information.

SIMATIC Energy Suite V19.0

112 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

6.8.3 Visualization screens for acquisition objects and load management

Requirement
• Hardware and software configurations for energy acquisition objects.
• Minimum configurations of load management actuators.
• SiVArc screen rules for Energy Suite are created.
• Perform SiVArc screen generation for Energy Suite rules.
The visualization screens in runtime are generated for the following:
• Energy acquisition faceplates - displays the header that consists of acquisition object name
with icon, and error (if any) along with actual energy value in kWh and actual power value
in kW of an acquisition object.
• Load management faceplate infeed - displays the header that consists of load
management name with icon, and error (if any) along with energy limit in kWh which is
calculated from average power limit and the forecasted energy value in kWh for an infeed.
• Actuator faceplate - header displays the actuator name with icon of consumer or
producer, manual or automatic indicator, and error (if any) along with actual power
consumption in kW and available energy for escalation and de-escalation in kWh of the
actuator.
• Storage faceplate - Displays storage actuator name with storage icon, manual or
automatic indicator, and error (if any) along with actual power consumption in kW and
available energy for escalation and de-escalation in kWh. State of charge (SOC) of the
storage actuator is displayed only in advance mode.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 113
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Note
SiVArc screen generation time
If user is configuring the larger data blocks (buffer DBs), the SiVArc screen generation time
will increase even with fewer number of acquisition objects. This will affect the performance
of the system.
To reduce the SiVArc screen generation time, user can configure the data blocks (buffer DBs)
in smaller size (for example, 10 KB or 20 KB) to generate energy program and perform SiVArc
screen generation. So that, later user can change the size of data blocks (buffer DBs) to actual
size and regenerate energy program and download it to the system.

SIMATIC Energy Suite V19.0

114 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Acquisition object screens

Upon clicking the energy acquisition faceplates, EnS_EnergyDataBasic screen opens, with the
header consists of acquisition object name and screen displays:
• Periodic data - displays accumulated energy value and graphical representation of average
power value over current sync period for last seven days.

Figure 6-1 EnS_EnergyArchive in Windows RT Professional

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 115
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Figure 6-2 The EnS_EnergyArchive in Windows Unified

– The EnS_EnergyArchive screen contains the following:

- Header: displays acquisition object name with error icon (if any).
- Periodic data trend: displays historical average power in kW value of acquisition object
for every sync period.
- Table: displays historical average energy data of an acquisition object (Power [kW],
Energy [kWh], Counter [Wh]).

Note
• Values and graph will be available only for valid WinCC data logging.
• In Windows Unified screen, you can switch tab for Power and Energy graph. In order to
get historical data, the timepicker should be switched to Manual mode and the
historical values will be displayed. You can use the manual timestamp to visualise
values at the particular date and time.

SIMATIC Energy Suite V19.0

116 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

• Online data - Displays current energy value in kWh of an acquisition object and graphical
representation of actual power value in kW for current sync period.

Additional screen button - Appears in EnS_EnergyDataBasic screen if additional data

is collected from hardware device.

•
Advance screen button - Appears in EnS_EnergyDataBasic screen if advance data is
collected from hardware device.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 117
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Visualization screen for additional energy data:

Upon clicking the additional screen button, EnS_EnergyDataAdd screen opens and displays
the name, value and unit of additional data.

Note
The tabs to switch between "Values 1-6" and "Values 7-12" are visible if more than 6 values
are configured.

SIMATIC Energy Suite V19.0

118 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Visualization screen for advance energy data:

Upon clicking the advance screen button, EnS_EnergyDataAdv screen opens and displays the
advance energy data from the connected hardware device.

The below table displays the columns in the sub-header area:

Columns Description
Phase voltage

Line voltage

Line current

Frequency

Power factor

Apparent power

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 119
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Columns Description
Actual power

Reactive power

Total energy (Apparent, Actual and Reactive)

Note
The above screens and functionalities are described for RT professional, similar screens and
functionalities are available for comfort panels and WinCC Unified also.

Peak load management screens

Upon clicking the Load management faceplates, LMGT_ControlBasic overview screen opens,
with the header consists of load management system name and screen displays as:

SIMATIC Energy Suite V19.0

120 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

The below table displays the columns in the sub-header area:

Columns Description Values coming from DBs

Indicates warning icon when ForecastEnergyValue > General DB of EnS_LmgtControl_Peak_<LMGT>
Actual energy limit

Toggle button to switch the display between Energy

& Power values

Actual Value Actual power/energy value of infeedacquisition object energyBasic data from Acquisition object instance DB
[kW / kWh]
Forecast The forecasted average power/energy value at the Forecast data from Acquisition forecast instance DB
end of the period [kW / kWh]
Setpoint Actual power limit [kW] including limit percentage General DB of Lmgt Control visualization → limitEsca-
used for switching decisions lationEnergykWh
Actual energy limit [kWh] including limit percentage
used for switching decisions
Limit: PowerLimit [kW]: Limit of average power for load General DB of LmgtControl Par-
management amenetrSet→limitConfig → avgPower
EnergyLimit [kWh]: Limit calculated from average General DB of Lmgt Control visualization → limitEn-
power limit of load management system ergykWh
Timer but- Toggle button to switch the display between current
ton time & remaining time
Current Current time of the load management period in [s] General DB of Lmgt Control orgData → currentPeri-
time odTime
Remaining Remaining time of the load management period in [s] General DB of Lmgt Control: orgData → remain-
time ingPeriodTime
Period time Sync Period of the load management system in [s] General DB of Lmgt Control: orgData → periodTime

Table below explains the LMGT_ControlBasic screen elements:

Tabs Fields Value

Overview Trend 1 • Energy in Period: shows the actual Energy [kWh] trend value for
the current period & previous period
• Blue line in the graph represent data when ForecastEnergyValue
< Configured energy limit
• Orange line in the graph represent data when ForecastEner-
gyValue > Configured energy limit
• Previous period represented with shaded orange displays trend of
actual energy data [kWh] of previous sync period > shaded (if
forecast > configured energy limit) or shaded blue (if forecast <
configured energy limit)
Trend 2 • Current Period (power): shows the actual power [kW] trend value
for the current period
Trend 3 • Average power [kW]: Shows the average power [kW] periodic
value of infeed for the last hour, last 8hours, last day, last 7days
Note: Graph will be available only for valid WinCC data logging
Deviation set point Indicates the available energy [kWh] & differential power [kW] which
indicator will be available at the end of the period. Negative value indicates
the amount of available energy and power of LMGT system.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 121
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Tabs Fields Value

Switching Infor- • Indicates the total number of actuators which are current-
mation indicator
ly available for escalation (blue) and de-escalation (grey) along
with total escalation & de-Escalation energy that an actuator can
accommodate in the load management system
• Bar indicates the currently available actuators for escalation
(blue) and de- escalation (grey)
• Click the update button for latest values
Overview Actuator list Displays the actuator details such as:
• ID1-10 -Identifier of actuator, Actuator ranging from ID 0-9 will
be seen here, and consecutive for other tabs. Values coming
from Actuator Instance DB, input parameter as ID
• Type - Actuator type- Consumer (Down) or Producer (UP) with
values as actuator list DB: metadata> actuator type
• Storage tab consists of all the storage actuators with values as
actuator list DB: metadata> actuator type.
• Name - Actuator name configured by user with values as actuator
list DB: metadata > name
• Priority - Priority of the actuator for de-/escalation with values as
actuator list DB: ParameterSet: priority
• Rolling ID - Rolling number of the actuator in the group with
values as actuator list DB: ParameterSet:rollingIdentifier
• State - Status of the actuator- On (Blue), Off (Grey) or partially On
(half blue & half grey) with values as actuator list DB: Actuator >
status > connectionStatus
• For storage actuators the status is displayed as blue with + sign
for charge, blue with - sign for discharge and grey for idle.
• Enable -Actuator availability in LMGT system TRUE: Actuator is
available for switching FALSE: actuator is ignored by LMGT sys-
tem with values as Actuator list DB: Actuator-status > inOutVaria-
bles > enableActuator
• Actual power -Actual power [kW]consumption of the actuator
with values as Actuator list DB: Actuator >status >actPower
• Escalation potential - Energy available [kWh] for escalation with
values as Actuator list DB: Actuator-status ->

escalationEnergy

For storage actuators, the state of charge is displayed in place of

escalation potential.

Configuration Parameter set1, set2, configures five sets of parameters for the LMGT system where one is
(Upon click, set3, set4, set5 an active parameter set and the other four are standby parameter
LMGT_ControlConfig screen sets.

SIMATIC Energy Suite V19.0

122 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Tabs Fields Value

appears) Time parameters & configuration available from LMGT general data DB
Limit parameters EnS_LmgtGeneralData_<LMGTname> → parameterSets (parameter-
Set_1, parameterSet_2, parameterSet_3, parameterSet_4, parame-
terSet_5)

LT switching allows user to consider tolerance limit during de-

escalation
Actuator list Configu- allows user to configure two set of parameters (Parameter set 1 &
ration Parameter set 2) for the actuators. Only 1 parameter set can be ac-
tive at a time (active parameter set).
Storage Parameter set1, set2, configures five set of parameters for the LMGT system where one is
(Upon click, set3, set4, set5 an active parameter set and the other four are standby parameter
LMGT_ContolConfig_Storage sets for the storage actuator.
screen appears) Time parameters & configuration available from Storage general data DB
Limit parameters EnS_LmgtContolConfig_Storage_<LMGTname> → parameterSets
(parameterSet_1, parameterSet_2, parameterSet_3, parameter-
Set_4, parameterSet_5)
LT switching allows user to consider tolerance limit during de-
escalation
Storage actuators list allows user to configure five set of parameters for storage actuators.
Configuration Only one parameter set can be active at a time (active parameter set)
and the other four parameter sets will remain in standby.
Administrator info Backup & Restore Allows to perform the backup and restore. For more information
(Upon click, refer "backup and restore" section.
LMGT_ControlAdmin screen Job management Indicates the job that are generated and evaluated for escalation and
appears) de-escalation requests received within load management system.
Currently escalated Bar: Indicates one or more actuators of the priority number is cur-
priorities rently escalated
Alarm list Indicates the alarms when limit violation & lack of actuator situation
had occurred for the required amount of energy

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 123
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Control Configuration screen

Upon clicking the Configuration tab in Load management control screen,
LMGT_ControlConfig screen appears with the header consists of load management system
name and screen displays as:

SIMATIC Energy Suite V19.0

124 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Control Storage Screen

Upon clicking the Storage tab in Load management control screen,
LMGT_ControlConfig_Storage screen appears with the header consists of load management
system name and screen displays as:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 125
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Control Administrator Infos screen

Upon clicking the Administrator infos tab in Load management control screen,
LMGT_ControlAdmin screen appears with the header consists of load management system
name and screen displays as:

SIMATIC Energy Suite V19.0

126 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Actuator screens
Upon clicking the actuator faceplate, LMGT_ActuatorBasic screen appears with the header
consisting of actuator name with icon of consumer, producer or storage:

Columns Description Values coming from DBs

Priority Priority of the actuator [0-1999]
Actuator list DB: ParameterSet:
priority
Rolling ID Rolling number of the actuator Actuator list DB: ParameterSet:
in the group [0-99] rollingIdentifier
Actual Value Actual power consumption [kW] Actuator list DB: Actuator> sta-
of the actuator tus > actPower
Escalation Potential Energy available for escalation Actuator list DB: Actuator-status
[kWh] > escalationEnergy
Status Status of the actuator- On, Off & Actuator list DB: Actuator-
Partially On (based on type) >status > connectionStatus
Switching Information Indicates the number of count Actuator list DB: Actuator-status
that the actuator switching had -> countEscalated
occurred
Time since last switching action Indicates the time when the For escalation: (Actuator list DB:
actuator switching had occurred Actuator-status -> discon-
nectTime)
For de-escalation: (Actuator list
DB: Actuator-status -> con-
nectTime)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 127
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Columns Description Values coming from DBs

Trend of Actual Power [kW] Shows the Actual Power [kW] Actuator list DB: Actuator >
trend value for the Last Minute, status > actPower
3 minute & Period time
Period Time Shows sync period of the load General DB of Lmgt ControlData
management system > orgData > PeriodTime
Bar Indicates the current time and General DB of Lmgt ControlData
remaining time of the load > orgData > currentPeriodTime >
management period in [min] orgData > remainingPeriodTime
Timer button Toggle button to switch the bar -
display between current time
and remaining time of sync
period
Energetic level for consumers Circular segment Indicates the Actuator list
and producers Typical Power [kW] & the DB:ParameterSet:Typical
Standby Power [kW] Actuator list
DB:ParameterSet:Standby
Center segment shows the ac- Actuator list DB:Actuator > sta-
tual power consumption [kW] of tus > actPower
the actuator
Available energy for escala- Actuator list DB:Actuator > sta-
tion[kWh] tus > escalation energy
Available energy for de- Actuator list DB:Actuator > sta-
escalation [kWh] tus > de-escalation energy
Energetic level for storage Typical Charge Power [kW] & Actuator list DB: Actuator >
the Typical Discharge Power parameter > typicalPowerDis-
[kW] shows the actual power charge
consumption/production [kW] Actuator list DB: Actuator >
of the storage actuator parameter > typicalPowerCharge
Circular segment indicates the Actuator list DB: Actuator >
state of charge graphically with parameter > minDischarg-
charging and discharging limits ingLimit
with maximum charge and Actuator list DB: Actuator >
discharge limit. parameter > dischargingLimit
Actuator list DB: Actuator >
parameter > maxChargingLimit
Actuator list DB: Actuator >
parameter > chargingLimit
Center segment indicates the Actuator list DB: Actuator >
state of charge in % parameter > stateOfCharge
Battery icon indicates the status Actuator list DB: Actuator >
of the storage actuator status > connectionStatus
Available energy for escala- Actuator list DB:Actuator > sta-
tion[kWh] tus > escalation energy
Available energy for de- Actuator list DB:Actuator > sta-
escalation [kWh] tus > de-escalation energy
Indicates whether the actuator Manual: The icon is displayed
is set to manual or automatic
Automatic: The icon is not dis-
played

SIMATIC Energy Suite V19.0

128 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Actuator Configuration screen

Upon clicking the Configuration tab, LMGT_ActuatorConfig screen appears with the header
consists of actuator name and screen displays as:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 129
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Table below explains the LMGT_ActuatorConfig screen elements:

Tabs Field Description

Configuration Parameter Set1 and Parameter Set2 Allows user to configure two set
of parameters for the actuators
Activate Button Allows user to activate actuator
parameters
General parameters & Timing parameters Configures LMGT Actuator List
DB
Ens_LmgtActuator‐
List_<LMGTName> -> Actuators
-> Actuators [n] -> Parameter
(parameterSet_1 and parame-
ter‐Set_2)

Actuator Storage screen

Upon clicking the Storage tab, LMGT_ActuatorConfig_Storage screen appears with the header
consists of actuator name and screen displays as:

Tabs Field Description

Storage Parameter Set1 and Parameter Set2 Allows user to configure two set of
parameters for the storage actuators
Activate Button Allows user to activate storage actuator
parameters

SIMATIC Energy Suite V19.0

130 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Tabs Field Description

Charging and Discharging Limits Allows users to set and vary charge and
discharge limit.
Basic - Advanced mode switch Allows user to switch between basic
and advanced mode which considers
boolean signals or state of charge

Actuator Administrator screen

Upon clicking the Administrator tab, LMGT_ActuatorAdmin screen appears with the header
consists of actuator name and screen displays as:

Table below explains the LMGT_ActuatorAdmin screen elements:

Tabs Field Values

Administrator Operation Mode Allows the switching of actuator
automatically or manually
Automatic Mode Allows the switching of actuator
automatically
Activate Manual mode Allows the switching of actuator
manually

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 131
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Tabs Field Values

Manual switching command Activates when manual mode
is activated; user can command
On-Off the actuator manually
Partial power For manual mode the user can
set partial power of the actua-
tor. To enable partial power the
"Partial load operation" check-
box should be selected in the
Configuration screen.
Combo Box For storage actuators in manual
mode the user can switch be-
tween charge, discharge and
idle modes

Table below explains the status control & feedback and Meta Information:

Column Description Values coming from DB

Acquisition type Feedback mode connected to actua- Actuator list DB: Actuators-
tor: Analog power value, Switch metaData > acquisitionType
state, acquisition object or no feed-
back
Feedback status Feedback status from hardware Actuator list DB: Actuators- sta-
[kW]: tus > inOutvariables > fedBoole-
an ; fedAnalog ;
• fedBoolean >On /Off (0/1)
fedEnOActPower
• fedAnalog > Feedback power
value
• fedEnOActPower > feedback
signal as acquisition object
Control type Control output type connected to Actuator list DB: Actuators-
actuator: Analog control or Boolean metaData > controlType
control
Control Status • Control signal to hardware [kW] Actuator list DB: Actuators- sta-
tus > inOutvariables > ctrlBoole-
• ctrlBoolean > Signal to an ; ctrlAnalog
switch a binary actuator
• TRUE = switch off ctrlAnalog >
The set point consumption for
the actuator [kW]
Actuator available for LMGT • Actuator availability in LMGT Actuator list DB: Actuator-status
> inOutVariables > enableActua-
system TRUE
tor
• Actuator is available for switch-
ing FALSE
• Actuator is ignored by LMGT
system
Status of actuator Status code of the actuator- On, Off Actuator list DB: Actuator-status
& Partially On > inOutVariables > status
Plant ident code Plant identification code Actuator list DB: Actuators-
metaData > plantIdentCode
Local ident code Local identification code Actuator list DB: Actuators-
metaData > localIdentCode

SIMATIC Energy Suite V19.0

132 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Base load management screens

For Base load management on clicking the Base Load management faceplates,
BLMGT_ControlBasic overview screen opens, with the header consists of load management
system name and screen displays as:

The below table displays the columns in the sub-header area:

Columns Description Values coming from DBs

Indicates warning icon when Average- General DB of base load management
PowerValue > ActualPowerLimit
Actual Actual power value of infeed acquisition energyBasic data from Acquisition object
Value object [kW] instance DB
Average The average power value for the given time AveragePower from general DB of base load
Power period [kW ] management -> averageValues -> avgPower
Low/High Actual power limit [kW] including limit per-General DB of base load management visu-
Setpoint centage used for switching decisions alisation -> powerLimitLow and powerLim-
itHigh
Low/High PowerLimit [kW]: Limit of average power for General DB of base load management visu-
Limit: base load management alisation -> powerLimitLowConfig and pow-
erLimitHighConfig

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 133
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Table below explains the LMGT_ControlBasic screen elements:

Overview Trend 1 • Shows Average power [kW] value of infeed for last 5 mins, one
hour and one day
• Solid Blue line in the graph represent the high limit level config-
ured.
• Dotted blue line in the graph represents the set point high.
• Grey line in the graph represents the Average power
• Dotted red line in the graph represents the set point low.
• Solid red line in the graph represents the low limit level config-
ured.

• Trend 2 • Show actual power [kW] value of infeed for last 5 mins, one hour
and one day
• Solid Blue line in the graph represent the high limit level config-
ured.
• Dotted blue line in the grapgh represents the set point high.
• Grey line in the graph represents the Actual power
• Dotted red line in the graph represents the set point low.
• Solid red line in the graph represents the low limit level config-
ured.

Deviation set point Iindicates actual power value when system is within the limits and
indicator show differential value of power when deviates from upper or lower
set points.
Switching Infor- • Indicates the total number of actuators which are current-
mation indicator
ly available for escalation (blue) and de-escalation (grey) along
with total escalation & de-Escalation power that an actuator can
accommodate in the load management system
• Bar indicates the currently available actuators for escalation
(blue) and de- escalation (grey)

SIMATIC Energy Suite V19.0

134 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Overview Actuator list Displays the actuator details such as:

• ID1-10 -Identifier of actuator, Actuator ranging from ID 0-9 will
be seen here, and consecutive for other tabs. Values coming
from Actuator Instance DB, input parameter as ID
• Type - Actuator type- Consumer (Down) or Producer (UP) with
values as actuator list DB: metadata> actuator type
• Storage tab consists of all the storage actuators with values as
actuator list DB: metadata> actuator type.
• Name - Actuator name configured by user with values as actuator
list DB: metadata > name
• Priority - Priority of the actuator for de-/escalation with values as
actuator list DB: ParameterSet: priority
• Rolling ID - Rolling number of the actuator in the group with
values as actuator list DB: ParameterSet:rollingIdentifier
• State - Status of the actuator- On (Blue), Off (Grey) or partially On
(half blue & half grey) with values as actuator list DB: Actuator >
status > connectionStatus
• For storage actuators the status is displayed as blue with + sign
for charge, blue with - sign for discharge and grey for idle.
• Enable -Actuator availability in LMGT system TRUE: Actuator is
available for switching FALSE: actuator is ignored by LMGT sys-
tem with values as Actuator list DB: Actuator-status > inOutVaria-
bles > enableActuator
• Actual power -Actual power [kW]consumption of the actuator
with values as Actuator list DB: Actuator >status >actPower
• Escalation potential - Power available [kWh] for escalation with
values as Actuator list DB: Actuator-status ->
escalationEnergy

For storage actuators, the state of charge is displayed in place of

escalation potential.

Configuration Parameter set1 and configures two set of parameters for the LMGT system.
(Upon click, set2
LMGT_ControlConfig screen Time parameters & configuration available from LMGT general data DB
appears) Limit parameters EnS_LmgtGeneralData_<LMGTname> → parameterSets (parameter-
Set_1 & parameterSet_2)
Actuator list Configu- allows user to configure two set of parameters (Parameter set 1 &
ration Parameter set 2) for the actuators. Only 1 parameter set can be ac-
tive at a time (active parameter set).
Storage Parameter set1 and configures two set of parameters for the storage actuators.
(Upon click, set2
LMGT_ContolConfig_Storage Time parameters & configuration available from Storage general data DB
screen appears) Limit parameters EnS_LmgtContolConfig_Storage_<LMGTname> → parameterSets
(parameterSet_1 & parameterSet_2)
Storage actuators list allows user to configure two set of parameters (Parameter set 1 &
Configuration Parameter set 2) for storage actuators. Only 1 parameter set can be
active at a time (active parameter set).

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 135
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Administrator info Backup & Restore Allows to perform the backup and restore. For more information
(Upon click, refer "backup and restore" section.
LMGT_ControlAdmin screen Job management Indicates the job that are generated and evaluated for escalation and
appears) de-escalation requests received within load management system.
Currently escalated Bar: Indicates one or more actuators of the priority number is cur-
priorities rently escalated
Alarm list Indicates the alarms when limit violation & lack of actuator situation
had occurred for the required amount of energy

Control Config screen

For Base load management on clicking the Configuration tab in Base Load management
control screen, BLMGT_ControlConfig screen appears with the header consists of load
management system name and screen displays as:

SIMATIC Energy Suite V19.0

136 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Control Administrator Infos screen

For Base load management on clicking the Administrator infos tab in Base Load management
control screen, BLMGT_ControlAdmin screen appears with the header consists of load
management system name and screen displays as:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 137
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Actuator screens
For Base load management on clicking the actuator faceplate, BLMGT_ActuatorBasic screen
appears with the header consisting of actuator name with icon of consumer and producer:

SIMATIC Energy Suite V19.0

138 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

For Base load management on clicking the actuator faceplate, BLMGT_StorageBasic screen
appears with the header consisting of storage actuator name with icon of storage:

Table below displays the columns in the sub-header area:

Columns Description Values coming from DBs

Priority Priority of the actuator [0-1999] Actuator list DB: ParameterSet:
priority
Rolling ID Rolling number of the actuator Actuator list DB: ParameterSet:
in the group [0-99] rollingIdentifier
Actual Value Actual power consumption [kW] Actuator list DB: Actuator> sta-
of the actuator tus > actPower
Escalation Potential Power available for escalation Actuator list DB: Actuator-status
[kWh] > escalationPower
Status Status of the actuator- On, Off & Actuator list DB: Actuator-
Partially On (based on type) >status > connectionStatus
Switching Information Indicates the number of count Actuator list DB: Actuator-status
that the actuator switching had -> countEscalated
occurred
Time since last switching action Indicates the time when the For escalation: (Actuator list DB:
actuator switching had occurred Actuator-status -> discon-
nectTime)
For de-escalation: (Actuator list
DB: Actuator-status -> con-
nectTime)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 139
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Columns Description Values coming from DBs

Trend of Actual Power [kW] Shows the Actual Power [kW] Actuator list DB: Actuator >
trend value for the Last Minute, status > actPower
3 minute & 15 minutes time
period.
Energetic level for consumers Circular segment Indicates the Actuator list
and producers Typical Power [kW] & the DB:ParameterSet:Typical
Standby Power [kW] Actuator list
DB:ParameterSet:Standby
Center segment shows the ac- Actuator list DB:Actuator > sta-
tual power consumption [kW] of tus > actPower
the actuator
Available power for escala- Actuator list DB:Actuator > sta-
tion[kW] tus > escalation power
Available power for de- Actuator list DB:Actuator > sta-
escalation [kW] tus > de-escalation power
Energetic level for storage Typical Charge Power [kW] & Actuator list DB: Actuator >
the Typical Discharge Power parameter > typicalPowerDis-
[kW] shows the actual power charge
consumption/production [kW] Actuator list DB: Actuator >
of the storage actuator parameter > typicalPowerCharge
Circular segment indicates the Actuator list DB: Actuator >
state of charge graphically with parameter > minDischarg-
charging and discharging limits ingLimit
with maximum charge and Actuator list DB: Actuator >
discharge limit. parameter > dischargingLimit
Actuator list DB: Actuator >
parameter > maxChargingLimit
Actuator list DB: Actuator >
parameter > chargingLimit
Center segment indicates the Actuator list DB: Actuator >
state of charge in % parameter > stateOfCharge
Battery icon indicates the status Actuator list DB: Actuator >
of the storage actuator status > connectionStatus
Available power for escala- Actuator list DB:Actuator > sta-
tion[kW] tus > escalation power
Available power for de- Actuator list DB:Actuator > sta-
escalation [kW] tus > de-escalation power
Indicates whether the actuator Manual: The icon is displayed
is set to manual or automatic
Automatic: The icon is not dis-
played

SIMATIC Energy Suite V19.0

140 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Actuator Configuration screen

For Base load management,on clicking the Configuration tab, BLMGT_ActuatorConfig screen
appears with the header consists of actuator name and screen displays as:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 141
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

For Base load management,on clicking the Configuration tab, BLMGT_StorageConfig screen
appears with the header consists of actuator name and screen displays as:

Table below explains the LMGT_ActuatorConfig screen elements:

Tabs Field Description

Configuration Parameter Set1 and Parameter Set2 Allows user to configure
two set of parameters for
the actuators
Activate Button Allows user to activate
actuator parameters
General parameters & Timing pa- Configures LMGT Actuator
rameters List DB
Ens_LmgtActuator‐List_<L
MGTName> -> Actuators-
> Actuators [n] -
>Parameter (parame-
ter‐Set_1 and parameter-
Set_2)

SIMATIC Energy Suite V19.0

142 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Actuator Storage screen

For Base load management on clicking the Storage tab, BLMGT_ActuatorConfig_Storage
screen appears with the header consists of actuator name and screen displays as:

Tabs Field Description

Storage Parameter Set1 and Parameter Allows user to configure two set
Set2 of parameters for the storage
actuators
Activate Button Allows user to activate actuator
parameters
Charging and Discharging Limits Allows users to set and vary
charge and discharge limit.
Basic - Advanced mode switch Allows user to switch between
basic and advanced mode which
considers boolean signals or
state of charge

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 143
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Actuator Administrator screen

For Base load management, on clicking the Administrator tab, BLMGT_ActuatorAdmin screen
appears with the header consists of actuator name and screen displays as:

SIMATIC Energy Suite V19.0

144 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

For Base load management, on clicking the Administrator tab, BLMGT_StorageAdmin screen
appears with the header consists of storage name and screen displays as:

Table below explains the BLMGT_ActuatorAdmin screen elements:

Tabs Field Values

Administrator Operation Mode Allows the switching of actuator automatically or
manually
Automatic Mode Allows the switching of actuator automatically
Activate Manual mode Allows the switching of actuator manually
Manual switching command Activates when manual mode is activated; user can
command On-Off the actuator manually
Partial power For manual mode the user can set partial power of
the actuator. To enable partial power the "Partial
load operation" checkbox should be selected in the
Configuration screen.
Combo Box For storage actuators in manual mode the user can
switch between charge, discharge and idle modes

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 145
Visualizing and evaluating energy data
6.8 Create screens for Energy Suite with SiVArc

Table below explains the status control & feedback and Meta Information:

Column Description Values coming from DB

Acquisition type Feedback mode connected to actua- Actuator list DB: Actuators-metaData >
tor: Analog power value, Switch state, acquisitionType
acquisition object or no feedback
Feedback status Feedback status from hardware [kW]: Actuator list DB: Actuators- status >
inOutvariables > fedBoolean ; fedAna-
• fedBoolean >On /Off (0/1) log ; fedEnOActPower
• fedAnalog > Feedback power value
• fedEnOActPower > feedback signal as
acquisition object
Control type Control output type connected to actuator: Actuator list DB: Actuators- metaData >
Analog control or Boolean control controlType
Control Status • Control signal to hardware [kW] Actuator list DB: Actuators- status >
inOutvariables > ctrlBoolean ; ctrlAna-
• ctrlBoolean > Signal to switch a log
binary actuator
• TRUE = switch off ctrlAnalog > The set
point consumption for the actuator [kW]
Actuator available for LMGT • Actuator availability in LMGT system Actuator list DB: Actuator-status > in-
OutVariables > enableActuator
TRUE
• Actuator is available for switching FALSE
• Actuator is ignored by LMGT system
Status of actuator Status code of the actuator- On, Off & Par- Actuator list DB: Actuator-status > in-
tially On OutVariables > status
Plant ident code Plant identification code Actuator list DB: Actuators-metaData >
plantIdentCode
Local ident code Local identification code Actuator list DB: Actuators- metaData >
localIdentCode

See also
Create screens for Energy Suite (Page 112)
Visualize energy data with WinCC Online Trend View (Page 147)

SIMATIC Energy Suite V19.0

146 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.9 Visualize energy data with WinCC Online Trend View

6.9 Visualize energy data with WinCC Online Trend View

You can track the course of the periodic energy values
• Graphically via WinCC Online Trend Control (with connection to the data log)
• Numerically via the Energy Suite Export Tool (Page 148) (included in the installation scope
of the Energy Suite)

Visualization with WinCC Online Trend View

The WinCC Online Trend View is used to display periodic energy values archived in the data
logs as a trend in Runtime. You can configure the graphical representation of the energy
values yourself. To do this, create trend windows and connect the values in the trend to the
logging tags of the required energy values.
You can find additional information on this in the WinCC Information System under the
keyword "WinCC Online Trend View".
The following figure shows an example for displaying energy values in WinCC Online Trend
View:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 147
Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

6.10 Evaluate energy data with Energy Suite Export Tool

The Energy Suite Export Tool supports you in evaluating the acquired energy values in
Microsoft Excel format.
The Energy Suite Export Tool is part of SIMATIC Energy Suite Runtime and is installed together
with it on the PC station with WinCC Professional/WinCC Unified. You can find additional
information on this in the installation instructions for Energy Suite on the DVD.
You can use the Energy Suite Export Tool to export the periodic energy values archived in the
data logs to an external file during runtime using Microsoft Excel. It is necessary to install
Microsoft Excel to validate the exported Energy Suite report.
In addition, you can generate cost center reports with the tariff set you have created with the
Energy Suite Export Tool. You can assign these cost center reports to your cost centers.

Note
To generate a cost center report, you must have created at least one tariff set and one cost
center.

Based on the defined tariff sets and cost centers, the cost center report shows you the energy
consumption and the resulting energy costs. You can open and analyze the cost center report
in Microsoft Excel only.
Possible export format:
• .xls
• Compatible with Microsoft Excel Version 2010 and higher
Possible creation of report:
• Manual report
• Automatic report

Manual report generation procedure

1. Select the menu command Start > Siemens Automation > Options and Tools > SIMATIC
Energy Suite Runtime Toolbox > SIMATIC Energy Suite Export Tool.
The Energy Suite Export Tool opens.
2. Check the name of the WinCC server:
– Ensure that SCADA is running and when WinCC Professional/WinCC Unified is in
Runtime, the server connection status is displayed automatically.
3. Select the interface language (English, German and Chinese) with the menu bar Settings >
Languages.

SIMATIC Energy Suite V19.0

148 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

4. Configure the template for the reports using the Report menu. The following settings are
possible, for example:
– Report type: Export of archived measured values or Cost center report
– Execution as "Manual"
– Report name
– File name (made up of the name of the report, date and time of report creation)
– Storage path
– Tariff rate (for Cost center report)
– Unit (is specified automatically according to the tariff set)
– Data log and logging tags for evaluation (for Export of archived measured values)
– Cost center (for Cost center report)
– Time period that the report evaluates (reporting period)

Note
The units for cubic meters m3 is shown in the Energy Suite Export Tool as "m3".

5. Select the report to be generated. Generate the Microsoft Excel report by the clicking the
icon from the tool bar or go to Report -> Generate from the menu bar.
This step requires a connection to the WinCC server with WinCC Professional/WinCC
Unified in Runtime.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 149
Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

Result
The following figure shows an example for displaying energy values in the Energy Suite
Export Tool:

SIMATIC Energy Suite V19.0

150 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

Automatic report generation procedure

1. Select the menu command Start > Siemens Automation > Options and Tools > SIMATIC
Energy Suite Runtime Toolbox > SIMATIC Energy Suite Export Tool.
The Energy Suite Export Tool opens.
2. Check the name of the WinCC server:
– Ensure that SCADA is running and when WinCC Professional/WinCC Unified is in
Runtime, the server connection status is displayed automatically.
3. Select the user interface language (English, German and Chinese) with the menu command
Settings > Languages.
4. Configure the report template via the Report menu. The following table shows all possible
settings.

Parameter Description Value range Value for example

Type Type of the report Archived measured values export • Archived measured
(Type) Cost center report values export
Trigger Execution of the report • Manually • Automatically
(Execution)
• Automatically
Name Name of the report - For example 1:
(Name) • WeeklyReport
For example 2:
• MonthlyReport
File name File name of the re- - For example 1:
(File name) port, made up of the
name of the report, • WeeklyRe-
date and time of report port_170717_1215.
creation. xls
For example 2:
• MonthlyRe-
port_170702_0900.
xls
Path Storage location of the - • C:\Users\Administrat
(Path) created report
or\Desktop\
Tariff set Selection of the tariff - For example 1:
(Tariff set) set -
For example 2:
-
Unit Unit of energy con- - For example 1:
(Unit) sumption -
(automatic from tariff For example 2:
set)
-
Cost centers Selection of cost cen- - For example 1:
(cost cen- ter -
ters) For example 2:
-

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 151
Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

Parameter Description Value range Value for example

Report cycle Cycle in which the • Daily For example 1:
(Report report is created
• Weekly • Weekly
cycle)
For example 2:
• Monthly
• Yearly • Monthly

Time of day Time at which the • 12-hour format For example 1:

(Time of report is created
• 12:15:00 AM
day)
For example 2:
• 09:00:00 AM
Week day Weekday on which the Monday - Sunday For example 1:
(Weekday) report is created.
• Monday
Can only be selected if
For example 2:
report cycle = weekly.
-
Day Time at which the 1 - 28 For example 1:
(Day) report is created. -
Can only be selected if For example 2:
report cycle = monthly
or annually. • 2
Month Month in which the January - December For example 1:
(Month) report is created. -
Can only be selected if For example 2:
report cycle = annual-
ly. -
Time period Period that the report For "daily" report cycle: For example 1:
(Time peri- evaluates • Start, End • Elapsed week (Mon-
od)
• Last day day - Sunday)
For example 2:
• Elapsed day (00:00 - 24:00)
• Last month
For "daily" report cycle:
• Last week
• Elapsed week (Monday -
Sunday)
For "monthly" report cycle:
• Last month
• Elapsed month (1st - end of
month)
For "annual" report cycle:
• Last year
• Elapsed year (January - De-
cember)

SIMATIC Energy Suite V19.0

152 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

Parameter Description Value range Value for example

Valid period Entire period for which • Start: Current date (set by For example 1:
(Valid peri- the reporting is permit- default) • Start: 07/15/2017
od) ted and valid
• End: 12/31/2099 12:00:00 12:15:00 AM
AM (set by default) End: 08/15/2017
12:15:00 AM
For example 2:
• Values are set by
default

Note
The units for cubic meters m3 is shown in the Energy Suite Export Tool as "m3".

5. Once the report template has been fully configured, click on "Finish".
A task will automatically be added to the Windows Task Scheduler and executed in the
configured report cycle . The reports are stored in the configured storage path.

Creating tariff sets

To create tariff sets, follow these steps:
1. Select the menu command "Settings > Tariff set".
The "Manage tariff sets" dialog opens.
2. To create a new tariff set, click on the "Add tariff set" icon in the toolbar.
The "Add tariff set" dialog opens.
3. Configure the template for the tariff sets. The following settings are possible, for example:
– Template name of the tariff set
– Unit price per energy consumption
– Assignment of tariffs to time ranges and weekdays
– Price per energy consumption
– Hiding holidays
The following entries are required:
– Template name
– One tariff selection per weekday
– Tariff must cover complete day (time range) per weekday
4. Click on the "Add" button.
The tariff set is added to the list in the "Manage tariff sets" dialog.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 153
Visualizing and evaluating energy data
6.10 Evaluate energy data with Energy Suite Export Tool

Reaction to error

Note
If an unexpected response occurs (in cases where, WinCC Professional/WinCC Unified
database does not start), the error messages are stored in the file "ExportToolLog.txt" under "
C:\Program Files (x86)\Siemens\Automation\SCADA-RT_V11\WinCC\bin " for WinCC
Professional and “C:\Program Files\Siemens\Automation\WinCCUnified\bin\Logger” for WinCC
Unified.

SIMATIC Energy Suite V19.0

154 Function Manual, 12/2023, A5E36824823-AH
 Visualizing and evaluating energy data
6.11 Using Conversion tool

6.11 Using Conversion tool

About Conversion tool

Conversion tool is used to convert Load management PLC binary format file into readable
excel (.csv) format, and excel (.csv) into Load management binary format that can be further
used for backup restore functionality.
The Load management configuration can be edited as per your choice in the .csv file. The .csv
file can be converted to binary format and restored to PLC Load management system.

Note
1. Ensure to enter valid values while editing CSV converted LMGT config backup binary file.
Conversion tool does not support validation.
2. The conversion tool is compatible only when the version of the conversion tool matches the
version of TIA portal. i.e. For the V18 version of TIA portal the conversion tool should also be
of V18.

Pre-requisites
• TIA portal with Energy Suite package must be installed
• Minimum of one energy object is created and the basic energy data is configured
• Minimum of one Load management system is configured with appropriate actuator(s)
• Conversion tool must be installed with Energy Suite package
• One of the below files must be available:
– Load management backup
– Lack of actuators
– Limit violation
– Switching event

Procedure
The conversion tool consists of the Energy Suite Load Management - Logfile Converter;
perform the following steps:
1. Energy Suite Load Management - Logfile Converter displays two tabs:
– Main - displays all the avaialble bin files
– Config - allows you to configure the paths for binary and csv files
2. Configure the binary files that you would want to convert into csv files under "Config" >
"Binary Files Path"
3. Configure the path of the csv files to be stored under "Config > CSV Files Path".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 155
Visualizing and evaluating energy data
6.12 Using Data Transfer Tool

4. Use the right and left arrow to select/deselect the binary files that needs to be converted to
.csv files, and .csv files that needs to be converted to binary files.
5. You can change the Load management system confgurations in the .csv files and convert
them to .bin files. The converted csv files will be stored at the location mentioned in step 3.
6. The Mode "Peak" or "Base" must be selected for each file that is enabled for conversion.
"Peak" indicates file from Peak load management system and "Base" indicates file from base
load management system.

Note
Binary files created by the load management system for lack of actuators, limit violation,
switching event can be converted to CSV files, but the same will not be converted back to
.bin files. The corresponding check boxes for lack of actuators, limit violation, switching
event will be disabled automatically

6.12 Using Data Transfer Tool

About Data Transfer Tool

You can transfer and archive the energy values from PLC to WinCC for analysis purposes using
the Energy Suite Data Transfer Tool.
In WinCC Professional, by clicking the "Create data log" icon under energy data, entry will be
added automatically under "Runtime settings > Service > Additional tasks/applications". Data
transfer starts automatically when WinCC is downloaded.

SIMATIC Energy Suite V19.0

156 Function Manual, 12/2023, A5E36824823-AH
Optimizing energy consumptions 7
7.1 Load management with Energy Suite

Load management
In growing industry sectors, the demand for energy consumption is highly intensive. Factory
owners often pay little attention to energy costs in general, and electricity costs in particular,
because of their minor impact on total costs. With increasing electricity prices, and
introduction of varying prices based on time, manufacturing plants can reschedule or
prioritize their operations to reduce their electricity tariffs.
Load management comes as a rescue concept for industries where consumers or producers
take necessary action to switch load in order to gain from total system peak load, and exert
efficient utilization of essential commodities, and distribution capacity.
Optimal load schedule results in significant reduction of peak period demand, and electricity
cost. Generally, consumers are made aware of their need to reduce the power load at short
notice from energy utilities.
With load management, consumers are stimulated to lower their demand in critical supply
periods, and increase it when the cheap and abundant power capacity is available. Producers
on the other side, switch their power production capacity based on the demand, and also
stimulate the use of backup generation, which results in the efficient utilization of resources
without adversely affecting the energy service. Both consumer and producers generate a
tangential effect on the total energy consumption resulting in reduced production costs.

Peak load management with SIMATIC Energy Suite

Load management acts as a monitoring component which ensures that the power and
energy consumption does not exceed the user defined limit energy value. Load management
component contains a key user defined element called as actuators. Actuators can be of the
following types:
• Consumer: Sectors that consumes power
• Producer: Sectors that produce power
• Storage: Sectors that both produces and consumes power
Load management program consists of blocks such as the following:
• Forecast block
• Control block
• Actuator block
• Backup/Restore block
The Forecast block receives its input from the Infeed that is the acquisition object. For
example, in a power plant, the infeed will be the input from the power grid to the receiver.

SIMATIC Energy Suite V19.0

157 Function Manual, 12/2023, A5E36824823-AH
Optimizing energy consumptions
7.1 Load management with Energy Suite

The Forecast block calculates or predicts the average power and energy value using the
infeed at the end of a stipulated time period.
Consider monitoring of a manufacturing plant through load management component. The
Forecast block receives the infeed from the power grid, and monitors the power
consumption.
• The energy uitilization is constantly monitored against a threshold limit over a certain time
period. If the Forecast block's data is exceeding the threshold value, the load Management
triggers an alert, warning or limit violation and directs the consumer (actuator) to switch
off state. This process is termed as escalation.
• Post the threshold peak, when the power consumption is minimal or within the threshold
limit value, the producer (actuator) are switched on. This process is termed as de-
escalation.
• The time period between the escalation and de-escalation is termed as suppression delay.
• The time taken to start new observation of escalation and de-escalation is termed as
Stabilization time.

Base load management with SIMATIC Energy Suite

Base load management acts as a monitoring component which ensures that the power
consumption does not exceed the user defined (upper and lower) power limit values. It is
mainly used to manage the power consumption and generation to manage actuators to
maintain a certain power level. Actuators are defined as participants or units of a base load
management system and can be of the following types:
• Consumer: Units that consumes power
• Producer: Units that produce power
• Storage: Units that both produces and consumes power
Base load management program consists of blocks such as the following:
• Forecast block
• Control block
• Actuator block
• Backup/Restore block
The base load management system has no time dependency in form of archiving periods.
Based on the actual power the average actual power value for the last 10 seconds is
calculated. This is the input value for the system which is controlled to be always between
the specified levels. For example, a generator within an industrial site can be managed in this
way.
There are two limits for the system which define three areas for the monitored value
• Actual value of the infeed
• Average value of the last 10 seconds, value required every 100 milliseconds.

SIMATIC Energy Suite V19.0

158 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.1 Load management with Energy Suite

There are two limits for the system

• If the value is below the lower limit, the system will switch actuators in order to move the
value above the lower limit
• If the value is above the lower limit and below the upper limit, the system will not switch
any actuator
• If the value is above the upper limit, the system will switch actuators in order to move the
value below the upper limit
The control block calculates the additional energy required to move the 10s average value
between the limits. Then the block sends a switching request to the actuator blocks. The
actuator blocks respond to the request according to their user-defined priority.
The power utilization is constantly monitored against these two threshold limits. If the
average power value is not within the threshold values, the base load management triggers
an alarm or warning and switches actuators as below shown:
• Power value < lower limit: Activate consumer, deactivate producer, charge storage
• Power value > lower limit AND power limit < upper limit: No switching
• Power value > upper limit: deactivate consumer, activate producer, discharge storage

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 159
Optimizing energy consumptions
7.2 Procedural overview for load management

7.2 Procedural overview for load management

Requirement
To perform the following configuration steps, the same requirements must be met as
described in section "Procedural overview (Page 18)".

Configuration steps
You can find an overview of the most important configuration steps for energy data
management with the Energy Suite components before the configuration for load
management in section "Procedural overview (Page 18)".
The following table provides an overview of the most important configuration steps for load
management with the Energy Suite components:

Topic Step Description

Optimize energy 1.1 Activating forecast feature of an In order to create a load management system, you have to
consumptions acquisition object (Page 167) activate the forecast feature of an acquisition object. Only
acquisition objects with the activated forecast feature are
available for load management.
Each acquisition object can be activated for load manage-
ment
1.2 Creating a load management Load management systems are used to manage infeed
system (Page 169) objects. You can create a maximum of 5 active
load management systems, each one with a different ena-
bled acquisition object respectively infeed object
1.3 Setting the properties of a load Each load management system represents the strategy of
management system (Page 170) optimizing energy consumptions and must be correspond-
ingly configured.
• Select an acquisition object as infeed object
• Set the power limits to a user defined value
• Check the enable of load management systems for the
energy program
1.4 Adding an actuator (Page 172) Actuators are used to consume and/or produce energy.
Create and define actuators, each one with a different type
1.5 Setting the properties of the Each actuator represents how to react to the infeed for the
actuator (Page 173) load management and must be correspondingly configured
• Select the actuator type for each actuator
• Set the feedback mode, feedback source, Control type
and Control signal configuration
• Check the enable of actuators for the energy program

SIMATIC Energy Suite V19.0

160 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.2 Procedural overview for load management

Topic Step Description

Generate energy 2.1 Making general settings for the Before generating the energy program, set the starting time
program for energy program (Page 68) of the blocks in the energy program.
load manage- You also define the alarm suppression
ment
2.2 Check the enable of acquistion At the latest before generating the energy program, you
objects for the energy program need to decide which acquisition objects (and thus which
and adapt it if necessary measuring points) are to be included in the energy pro-
(Page 41) gram. You can easily enable/disable the acquisition objects
in the acquisition object tables
2.3 Generate energy program You start the generation of the PLC program for energy data
(Page 176) acquisition and processing (or energy program for short)
from the project tree
During the generating process, the required blocks and data
types from the Energy Suite Library and load management
library are automatically used in the energy program and
interconnected according to the configured acquistion
objects.
The generated energy program is created below the S7 CPU
in the "Energy Suite - Program" subfolder of the "Program
blocks" folder
2.4 Compiling and downloading the Once the energy program is generated, compile the com-
PLC program (Page 93) plete PLC program and download it to the S7-1500 CPU
target system
2.5 Testing the energy program To check your settings, open the relevant data block of the
(Page 94) respective acquistion object in the energy program and
watch the online values with the "Monitor all" function

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 161
Optimizing energy consumptions
7.3 Performance features and conventions

7.3 Performance features and conventions

Compatibility of load management with CPU and FW

The following table shows the compatibility of CPUs to respective Energy Suite load
management versions.

CPU / ET 200SP CPU / ET 200SP Open Con- FW Energy Suite load management
troller version
S7-1500 CPU ≥ V2.5 ≥ V16.0

Performance features of load management

The following table shows the performance features of the load management:

Characteristic Value
Maximum number of enabled load management systems for pro- 5
gram·generation
Maximum·number of·load·management·systems 99
Maximum number of actuators (including producers, consumers and 999
storage actuators) per load management system
Maximum number of storage actuators per load management system 100

Note
Out of the available 99 load management systems, only 5 can be active across multiple PLCs.

You can find additional information on performance features of common

Energy Suite components in section "Performance features and conventions (Page 21)".

SIMATIC Energy Suite V19.0

162 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.3 Performance features and conventions

Naming conventions
The following table shows the naming conventions of engineering with load management:

Object Value range for name Range of validity

Load management systems • 1 - 15 characters • Unique project-wide for archiving
• Permitted characters: type "WinCC Professional/WinCC
Unified (data log)"
– 0 ... 9
– a ... z
– A ... Z
– -
– _
Actuators • 1 - 32 characters • Unique project-wide for archiving
• Prohibited characters: type "WinCC Professional/WinCc
Unified (data log)"
– :?'*"\$%§°~./[]
`#
– <Space>
– <Line feed>
– <Line break>

You can find additional information on naming conventions of common

Energy Suite components in section "Performance features and conventions (Page 21)".

Note
The names of the load management systems before V18 version should be manually changed
to adhere to the 15 character limit for naming the load management system as per the latest
naming convention.

Note
Unique names
The object names must be unique at least CPU-wide. You cannot use a name that has already
been assigned to a block, a PLC tag or a constant within the CPU for a new object. Actuator
and load management system must contain unique name. No distinction is made between
upper and lower case when checking the uniqueness of the name.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 163
Optimizing energy consumptions
7.3 Performance features and conventions

Memory requirements for load management

The below table shows the files created for one load mangement system.
For consumers and producers:

Files Size
Back up file 0.3 MB
Log file for switching 16 MB
Log file for lack of actuators 16 MB
Log file for limit violations 16 MB

If storage actuators are present, additional files for storage are included:

Files Size
Back up file 0.03 MB
Log file for switching 1.6 MB
Log file for lack of actuators 1.6 MB
Log file for limit violations 1.6 MB

Hence the total memory required would be approximately 528 MB.

Note
Once the log file reaches 16 MB, a new one is created and a maximum of 10 log files get
created. After 10 files have reached 16 MB, the first one gets overwritten.

Note
The maximum amount of log files created can be reuced by user with the input parameter
"amountLogFiles" of block EnS_LmgtBackupRestore_<LMGT system name>.

SIMATIC Energy Suite V19.0

164 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4 Optimize energy consumptions

7.4.1 Energy program for load management

For optimizing energy consumptions, define acquisition objects and load
management systems in STEP 7 (TIA Portal) in the project tree below the S7-1500 CPU. The
acquisition objects are used for the infeed of load management systems. Load
management systems are used for creating actuators which consume and/or produce energy.
Both of them can be used subsequent for the generation of an energy program.
There is the new "Load management" folder below the "Energy objects" folder in the project
tree for this after the successful installation of SIMATIC Energy Suite. The following figure
shows the "Load management" folder in the project tree, with the subfolder "Load
management systems".

Infeed objects
The infeed objects refer to the acquisition object data source that you would like to input for
the load management block to forecast energy data. The infeed to load management block
can only be an acquisition object that you have configured for an acquisition object table.
While selecting the infeed for a load management block, the acquisition object tables
configured for a specific PLC is only displayed. Based on the energy data source that you
choose, the corresponding load management blocks, and instance data base blocks are
generated.

Instructions for actuators and limits

For each of the load management block that you select, you can choose to configure its
associated actuator, power limit mode and Limit tag. You can configure the actuator field
with a unique name. The actuator type can be either:
• Consumer
• Producer
• Storage

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 165
Optimizing energy consumptions
7.4 Optimize energy consumptions

The power limit mode can be of the following:

• WinCC operator (static): Refers to the run time data. The power limit mode can be a static
value that you set during the run time. The forecast block triggers appropriate warnings or
alerts, or a limit violation to the load management when this value is reached. You can
switch the actuators accordingly.
• PLC tag (dynamic): Refers to the PLC tag value that you configure in the "PLC tags" node.
The forecast block triggers appropriate warnings or alerts, or a limit violation to the load
management when this value is reached. You can switch the actuators accordingly.
The Limit tag refers to the tag value set in the data block. You can configure the Limit tag
only when the PLC tag option is selected. The Limit tag can be set using the PLC tag or the
Data block tag.

Note
The data type supported for data block are Real and LReal only.

Programming rules

Note
The "EnS_" and "EnSL_" prefix is reserved for the Energy Suite.
Before generating the energy program, make sure that the prefix "EnS_" and "EnSL_" is not
used in your existing PLC program (user blocks, tags, UDTs or technology objects). In this
way, you avoid unintentional overwriting when generating the energy program.

SIMATIC Energy Suite V19.0

166 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.2 Activating forecast feature of an acquisition object

Activating the forecast feature of an acquisition object is mandatory for using infeed objects
in load management systems.
You can find additional information about creating acquisition objects in the section "Adding
acquisition objects for acquisition object tables (Page 37)".
You have the following options for activating forecast feature of an acquisition object:
• In the Inspector window: when creating the acquisition object and assigning parameters
to it
• In the acquisition object table: central and clear for all associated acquisition objects

Requirement
• An acquisition object table has been created in the "Energy acquisition" folder below the
S7-1500 CPU.
• An acquisition object has been created in the acquisition object table.

In the Inspector window

To activate the forecast feature of an acquisition object, follow these steps:
1. Open the "Energy objects" folder below the S7-1500 CPU.
2. Open the "Energy acquisition" folder.
3. Double-click on the acquisition object table in which the acquisition object has been created.
The acquisition object table with the created acquisition objects opens.
4. Click on the desired acquisition object in the acquisition object table.
The properties of the acquisition object are displayed in the "Properties" Inspector window.
5. Select the "Configuration > Periodic energy data" item in the navigation area.
6. Select the check box "Enable periodic forecast for acquisition object".
The acquisition object is enabled for periodic forecast respectively load management
systems.
This setting for the acquisition object is also updated within the "Forecast" column of the
acquisition object table.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 167
Optimizing energy consumptions
7.4 Optimize energy consumptions

In the acquisition object table

To activate the forecast feature for 1 or multiple acquisition objects when needed, follow
these steps:
1. Open the "Energy objects" folder below the S7-1500 CPU.
2. Open the "Energy acquisition" folder.
3. Double-click on the acquisition object table in which the acquisition objects has been
created.
The acquisition object table with the created acquisition objects opens.
4. Select the check box of the "Forecast" column in the acquisition object table for all
acquisition objects you want to enable for load management.
The acquisition objects with selected check box are enabled for periodic forecast
respectively load management systems.
This setting for the acquisition objects is also updated in the "Properties" Inspector window.

Result
In the runtime:
• Average power demand and total energy consumption will be forecasted until the end of
the current period.
• Forecast of the average power demand [kW] until the end of the current period is
available.
• Forecast of the average energy consumption [kWh] until the end of the current period is
available.

SIMATIC Energy Suite V19.0

168 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.3 Creating a load management system

In order to optimize energy consumptions, create load management systems for your
individual load management strategy. You create load management systems in the
"Load management" folder below the "Energy objects" folder.
You can find additional information about the possible number of load management systems
and naming conventions in the section "Performance features and conventions (Page 162)".

Requirement
• An S7-1500 CPU is configured in the project.

Procedure
To create a load management system, follow these steps:
1. Open the S7-1500 CPU in the project tree.
2. Open the "Energy objects" folder below the S7-1500 CPU.
3. Open the "Load management" folder.
4. Double-click on the "Load management systems" object.
The table of load management systems opens in the upper half of the working area.
5. Double-click "<Add new>" in the "Name" column of the load management systems.
A new load management system is created in the load management systems.
If needed, create additional load management systems in the same way. Continue creating
load management systems below any other S7-1500 CPU nodes or the current CPU node. You
can copy paste the Laod management within the Load management editor.

Copying and sorting load management systems

• Load management systems can be copied via the shortcut menu. After copying, check the
properties of the load management system and adapt the copied settings as needed.
During copy/paste operation, all the columns get copied except for "Enable generation".
While copy/paste operation, maximum of only 5 load management systems can be active.

Note
Copy/paste of load management system can only be performed. The actuators associated
with a load management will be copied.

• You can sort the "Name" column in ascending or descending order by clicking the arrow
beside "Name".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 169
Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.4 Setting the properties of a load management system

7.4.4.1 Configuring a load management system

Each load management system represents the strategy of optimizing energy consumptions
and is correspondingly configured by you. You configure a load management system in the
"Properties" Inspector window.
For each load management system, you define:
• Select an acquisition object as infeed object
• Set the power limits to a user defined value
• Enable of the load management system for the energy program
The energy program is generated based on the configured properties.

Requirement
• An acquisition object table has been created in the "Energy acquisition" folder below the
S7-1500 CPU.
• An acquisition object with activated feature "Forecast" has been created in the acquisition
object table.

Procedure
To open the "Properties" Inspector window of a load management system, follow these steps:
1. Open the "Energy objects" folder below the S7-1500 CPU.
2. Open the "Load management" folder.
3. Double-click on the "Load management systems" object.
The table of load management systems opens in the upper half of the working area.
4. Click on the desired load management system in the table of load management systems.
All parameters of the load management system are displayed in the "Properties" Inspector
window.
The configuration of the load management system is described in detail in "General settings
(Page 171)".

Note
Any changes made in the inspector window will be reflected in the properties window, and
vice versa applicable.

Forecast power value conditions

When actual power or energy forecast decreases the configured power limit in conjunction
with tolerance, then load management performs de-escalation.For the de-escalation to be
performed, ensure that active load management is configured, and is downloadable to a PLC.

SIMATIC Energy Suite V19.0

170 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.4.2 General settings

A load management system has the following configuration parameters:

Setting Description
Name CPU-wide unique name of the load management system. The name can be
changed according to individual requirements.
You can find additional information about naming conventions in the section
"Performance features and conventions (Page 162)".
Enable generation Decides if load management needs to be activated during energy program gen-
eration.
• When this check box is selected, the load management system is enabled for
generating the energy program.
• When the check box is not selected, the load management system is not
used in the energy program.
If the number of Runtime licenses for the Energy Suite is fewer than the number
of enabled load management systems, the generation of the energy program is
canceled and an error alarm is displayed. Load management systems that are
not enabled are ignored by the license count.
Only 5 load management systems can be active per S7- 1500 CPU. After select-
ing 5 load management systems, the enable generation check box is disabled,
and an error message is displayed.
Infeed Selection of the infeed. The infeed is the energy data source which can either be
hardware or software data. An acquisition object is the infeed for the load man-
agement system. The infeed is the power value to be forecasted until the end of
the current period of the selected acquisition object.
• When the actual power of infeed is greater than the limit, the load manage-
ment system is able to escalate.
• When the actual power of infeed is lower than the limit, the load manage-
ment system is able to de-escalate.
You can configure same infeed for multiple load management systems.
The info "The forecast block calculates the energy data as per the value set in
this parameter".
Archiving period Archiving period of the infeed object. The infeed object assumes the archiving
period (and unit) of the corresponding acquisition object.
The archiving period can just be changed in the configuration of the acquisition
object.
Power limit mode Selection of the power limit mode. The power limit mode can be selectable as
the following:
• WinCC operator (static) - Disables the table field for limit tag
• PLC tag (dynamic) - Enables you to browse the PLC tag table
When PLC tag power limit mode is selected, user should not enter the power
limit via screen.
Limit tag When the power limit mode "PLC tag (dynamic)" is selected, the Limit tag is
configurable. For a "PLC tag (dynamic)" power limit mode you select the corre-
sponding PLC tag.
With this option, you can control the PLC tag limit to a user defined value.
Comment Optional short description of load management systems, for example, about the
purpose or the infeed of the load management system.

See also
Configuring a load management system (Page 170)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 171
Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.5 Adding an actuator

You can find additional information about the possible number of actuators and naming
conventions in the section "Performance features and conventions (Page 162)".

Requirement
• One or more load management system with corresponding infeed object has been
created.

Procedure
To create an actuator for a desired load management system, follow these steps:
1. Open the S7-1500 CPU in the project tree.
2. Open the "Energy objects" folder below the S7-1500 CPU.
3. Open the "Load management" folder.
4. Double-click on the "Load management systems" object.
The table of actuators opens in the lower half of the working area.
5. Click on the desired load management system in the upper half of the working area.
6. Double-click "<Add new>" in the "Name" column in the actuator table.
You can configure the "Actuator type" if the "Feedback source" is an object.
A new actuator for the desired load management system is created. The symbol show the
actuator type:

Sym Actuator type

bol
Consumer

Producer

Storage

If needed, create additional actuators in the same way.

Copying actuators
Actuators can be copied between the load management systems via the shortcut menu. After
copying, check the properties of the actuator and adapt the copied settings as needed.

See also
Creating a load management system (Page 169)

SIMATIC Energy Suite V19.0

172 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.6 Setting the properties of the actuator

7.4.6.1 Configuring an actuator

Each actuator represents how to react to the infeed for the load management and is
correspondingly configured by you. You configure an actuator in the "Properties" Inspector
window.
For each actuator, you define:
• Select the actuator type for each actuator
• Set the feedback mode and feedback source
• Set the control type and control signal
• Enable of the actuator for the energy program
The energy program is generated based on the configured properties.

Requirement
• An actuator for a desired load management system has been created.

Procedure
To open the "Properties" Inspector window of an actuator, follow these steps:
1. Open the "Energy objects" folder below the S7-1500 CPU.
2. Open the "Load management" folder.
3. Double-click on the "Load management systems" object.
4. Click on the load management system in which the desired actuator has been created.
The table of actuators of the selected load management system opens in the lower half of
the working area.
5. Click on the desired actuator.
All parameters of the actuator are displayed in the "Properties" Inspector window. This
settings for an actuator in the "Properties" Inspector window is also updated within
"Actuators" table.
The configuration of the actuator is described in detail in "General settings (Page 174)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 173
Optimizing energy consumptions
7.4 Optimize energy consumptions

7.4.6.2 General settings

An actuator has the following configuration parameters:

Setting Description
Name CPU-wide unique name of an actuator. The name can be changed according to
individual requirements.
You can find additional information about naming conventions in the section
"Performance features and conventions (Page 162)".
Actuator type Selection of the actuator type. The actuator type can be one of the following:
• Consumer: consumes energy
• Producer: provides energy
• Storage: consumes and produces energy
You can switch the actuators based on the forecast data. By default, the actua-
tor type is "Consumer".
Feedback mode Selection of the feedback mode. The forecast block provides the feedback
based on the actuator's energy consumption. If the energy consumption is
greater than the threshold limit, feeback is displayed.
The following feedbacks are selectable:
• No feedback
• Status tag
• Power value
• Acquisition object
Feedback source Depending on the selected feedback mode the feedback source can be select-
ed:
• No feedback: No feedback source needed
• Status tag:
– If the actuator type is consumer or producer, it supports PLC or data
block tags of data type boolean only.
– If the actuator type is storage, it supports PLC or data block tags of data
type USInt,SInt,UInt,Int.
• Power value: Supports PLC or data block tags of data type Real, LReal, Int
and DInt
• Acquisition object: Supports acquisition objects configured in acquisition
object table
Control type Decides the state of actuator control. It can be of the following types:
• Binary - displays the state of switch, i.e. on/off
• Analog - displays the state of power, i.e. on/off
Control signal Assigns the respective tags based on Control type:
• For Binary - Only tags of boolean data types can be selected
• For Analog - Tags of type Real, LReal, Int, Dint can be selected

SIMATIC Energy Suite V19.0

174 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.4 Optimize energy consumptions

Setting Description
Enable generation Decides if the actuators need be activated during energy program generation.
• When this check box is selected, the actuator is enabled for generating the
energy program.
• When the check box is not selected, the actuator is not used in the energy
program.
If the number of Runtime licenses for the Energy Suite is fewer than the num-
ber of enabled actuators, the generation of the energy program is canceled
and an error alarm is displayed. Actuators that are not enabled are ignored by
the license count.
Enable actuator Selection of process tag associating the availability of Actuator using an object
picker and control. The tags are boolean. The tag selection is not mandatory.
Comment Optional short description of actuators, for example, about the purpose or the
actuator type of the actuator.
Mode Three modes are available
• Basic: In basic mode the actuator responds to charge and discharge signals
of load management requests.
• Advanced: In addition to charge and discharge signals, the actuator also
considers state of charge to respond to load management requests. Con-
figuring charge and discharge signals is optional. By default, storage actua-
tors are considered as capable of charging and discharging.
• Basic and advanced: If this mode is selected, then it is possible to switch
between basic and advanced mode during runtime. The operation starts
with basic mode.
Charge Decides whether the actuator should respond to charging request from load
management system.
• True: Actuator is capable of charging.
• False: Actuator is not capable of charging.
This field accepts only boolean tags.
Discharge Decides whether the actuator should respond to discharging request from load
management system.
• True: Actuator is capable of discharging.
• False: Actuator is not capable of discharging.
This field accepts only boolean tags.
State of Charge Indicates the state of charge in a storage actuator. It is measured in %.
This field accepts tags of following data types: USInt, SInt, UInt, Int, DInt, LInt,
UDInt, ULInt, Real, LReal
Control State Assigns the current state of the storage actuator during the load management
process.
• 0 - Idle
• 1 - Charging
• 2 - Discharging
This field accepts tags of following data types: USInt,SInt,UInt,Int

See also
Configuring an actuator (Page 173)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 175
Optimizing energy consumptions
7.5 Generate energy program for load management

7.5 Generate energy program for load management

7.5.1 Generate energy program

After configuring the load management system with its associated actuators, and general
settings for the energy program, generate the energy program for load management based
on below mentioned sections.
You can find additional information on general settings for the energy program and runtime
licenses for Energy Suite in the following sections:
• "Making general settings for the energy program (Page 68)"
• "General settings (Page 69)"
• "Runtime licenses for Energy Suite (Page 70)"

Requirement
• All load management systems which should be included are enabled for the energy
program.
• The load management systems enabled for the energy program are fully configured.
• All actuators which should be included are enabled for the energy program.
• The actuators enabled for the energy program are fully configured.
• All the requirements from generating common Energy Suite energy programs are fulfilled.
You can find additional information on this in the section "Generate energy program
(Page 68)".

Procedure
To generate the energy program for load management, perform the following steps:
1. Open the S7-1500 CPU in the project tree.
2. Click on the "Energy objects" object below the S7-1500 CPU and select the option "Generate
energy program" from the shortcut menu.
Alternatively, you can select this option in the "Energy program settings" dialog by clicking
the "Generate energy program" icon.
The dialog with the selection for generating the energy program opens.

SIMATIC Energy Suite V19.0

176 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

3. Select one of the options:

– Energy acquisition program: generates energy program with the values configured for
energy acquistion.
For generating only an energy acquisition program see section "Generate energy
program (Page 74)".
– Complete energy program (Energy acquisition & Load management): generates energy
program with the values configured for energy acquistion and load management by
default. If load management is not configured, energy acquisition program is only
generated.
4. Click the "Generate" button.
The generator checks the completeness and the plausibility of the configuration of the
acquisition objects and starts the generation of the energy program. Information and
events during the generation of the energy program are displayed in the Inspector
window under "Info > Energy Suite".
5. Click "Cancel" to stop the generation.
6. You can use the "Go to" function to jump to the position in the configuration that is relevant
for the respective event.
7. You can repeat the steps for generating the energy program with necessary configurations.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 177
Optimizing energy consumptions
7.5 Generate energy program for load management

Result
After configuring acquisition objects, instances of the required blocks are created from the
Energy Suite Library and the measurement hardware library in the "Program blocks" folder
below the S7-1500 CPU. In addition, other required components, such as organization blocks
and data blocks, are added to the "Program blocks" folder and the required interconnections
are done.
Instances of data types from the Energy Suite Library and the measurement hardware library
can be created in the "PLC data types" folder below the S7-1500 CPU.
The energy program is generated for all enabled acquisition objects (regardless of the division
in the acquisition object tables).

Object Description
① Energy Suite - program New folder for energy program
② EnS - block types (Page 180) Subfolder "Acquisition - block types" with the Ener-
gy Suite blocks and measurement hardware driver
blocks (function blocks) and the forecast block for
load management.
Subfolder "LMGT - blocks" with additional function
blocks for load management

SIMATIC Energy Suite V19.0

178 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

Object Description
③ EnS - program blocks (Page 183) Folder for additional blocks (organization blocks,
functions, DBs, etc.)
④ Acquisition objects (Page 84) Blocks for acquisition objects (data blocks)
⑤ LMGT - systems (Page 184) Folder with additional functions and data blocks for
load management systems and actuators
⑥ Energy Suite data types (Page 185) Folder with the Energy Suite data types and meas-
urement hardware data types.
⑦ The sub folder "LMGT - data types" contains
additional data types for load management.

Delta generation scenario

• Add - In case of delta generation, when you add new load management actuators in the
"Load management" table along with existing actuator objects and generate energy
program: the new actuator blocks generated will append to the existing blocks under the
folder "Energy Suite - program". The related function calls will get updated accordingly.
– During PLC download, Actuator DB will get re-initialized if actuators are added.
– If reinitialization is not prompted during PLC download after adding an actuator, user
must " Load start values as actual values" in Actuator DB.
• Modify - In case of delta generation, when you edit load management system or actuators
in the "Load management" table and generate energy program: the edited Load
management system actuator blocks will get generated and append to the existing blocks
under the folder "Energy Suite - program". The modified parameters of load management
system or actuators are updated in the runtime under "Start value" column only in the
DBs. To reflect the changes from "Start value" column to "Monitor value" column in
runtime, you must click "Load start values as actual values". The related function calls will
get updated accordingly.
– In PLC runtime, only the modified blocks will be initialized (In case of changing a
parameter of Actuator, Actuator DB will get re-initialized).
– In SCADA runtime: All screen references to the unchanged LMGT and actuators will
remain valid.
• Delete - In case of delta generation, when you delete load management actuator in the
"Load management" table and generate energy program: only the selected actuator blocks
will be deleted and will not affect the existing blocks under folder "Energy Suite -
program". The related function calls will get updated accordingly.
– During PLC download, Actuator DB will get re-initialized if actuators are deleted.
– If reinitialization is not prompted during PLC download after deleting an actuator, user
must " Load start values as actual values" in Actuator DB.

See also
Acquisition objects (Page 182)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 179
Optimizing energy consumptions
7.5 Generate energy program for load management

7.5.2 Structure of energy program

7.5.2.1 Structure of energy program

When the energy program is generated, the following folders are automatically created
below the S7-1500 CPU:
• "Energy Suite - program" folder under "Program blocks" with subfolders
– [EnS general program elements]
- EnS - block types (Page 180)
- EnS - program blocks (Page 183)
– Acquisition objects (Page 182)
– LMGT - systems (Page 184)
• Folder "Energy Suite data types (Page 185)" under "PLC data types"

Note
Blocks of the energy program
SIMATIC Energy Suite automatically generates for you all the required blocks and data types
and their interconnection based on the configured acquisition objects and the energy
program settings.
You do not need to further adapt these blocks for the standard application with Energy Suite.

7.5.2.2 EnS - block types

The structure of your energy program depends on the following configurations:
• Energy data sources (Page 24)
• Enabled acquistion objects (Page 39)
• Energy program settings (Page 68)
• Load management settings (Page 170)
• Actuator settings (Page 173)

How Energy Suite blocks work

The load management program is constructed in a modularized way, so that for each
function can be decided to in-/exclude it and supply it separately.
However, a set of functions are vital for the basic functionality of the load management.
• A basic function set consists of a Forecast block, a Control block, an Actuator block and the
Backup/Restore block.
• For the centralized storage concept, two data blocks are included, the LmgtGeneralData
DB for the general data and the ActuatorList DB for actuator related data.

SIMATIC Energy Suite V19.0

180 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

The Forecast block gets his input data from an acquisition object of an infeed, which is not
part of the load management scope, but from the energy suite.
The following picture show how the Energy Suite blocks work:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 181
Optimizing energy consumptions
7.5 Generate energy program for load management

Acquisition - block types and LMGT - blocks

The "EnS - block types" folder contains the instances of all function blocks from the Energy
Suite library once the general program (energy acquisition and load management) is
generated. When the measurement hardware acts as the energy data source, the "Acquisition
- block types" folder also contains a subfolder "EnSL - block types" with the instances of the
associated Driver block from the measurement hardware library (Page 86). For load
management, the folder "LMGT - blocks" contains the instances of additional available
function blocks for load management.
• Function blocks for acquisition: For more information on function blocks for acquisition,
see section"EnS - block types (Page 79)"
• Function blocks for load management: Table below displays the function blocks "LMGT -
blocks" for load management

Function block Description Example in STEP 7 (TIA Portal)

EnS_LmgtForecast_x Forecast functionality for infeed energy data.
(Page 288)
EnS_LmgtControl_Peak Control logic for peak load management. Calcu-
(Page 290) lation and evaluation of limits. Handling job
data for actuators.
EnS_LmgtActuator_x Feedback, status and control functionality.
(Page 297)
EnS_LmgtBackupRestore Logging of limit violations and switching ac-
(Page 316) tions. Backup and restore functionality for
config data.

7.5.2.3 Acquisition objects

Once the program is generated, the "Acquistion objects" folder contains a subfolder with the
name of the acquisition object table "<name of the acquisition object table>" for each
acquisition object table with acquisition objects.
The "<name of the acquisition object>" folder contains the instance data blocks (Page 84)
• On the function blocks that are required for the acquisition objects in the energy program
• With the periodic energy values of the acquisition objects, which are provided for
buffering and archiving
The data blocks for buffering the energy data are also created as instances from the Energy
Suite library in this folder.

SIMATIC Energy Suite V19.0

182 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

7.5.2.4 EnS - program blocks

The "EnS - program blocks" folder contains additional blocks, such as organization blocks,
data blocks and functions (FCs) required for the energy program, once the program is
generated.

EnS - program blocks

The "EnS - program blocks" folder contains the general blocks once the program is generated:
• General program blocks for acquisition: For more information on general program blocks
for acquisition, see "EnS - program blocks (Page 81)"
• General program blocks for load management: Table below displays the general program
blocks for load management

Block Description Example in STEP 7 (TIA Portal)

EnS_Forecast_CycInt An FC for the forecast blocks in the cyclic
<NNNcc>FC interrupt OB. "NNN" and "cc" are place hold-
ers for the duration and unit.
Example:
With a cycle time of 100 ms,
"EnS_Forecast_CycInt100msFC" is created.
EnS_Lmgt_CycInt An FC for the load management blocks in the
<NNNcc>FC cyclic interrupt OB. "NNN" and "cc" are place
holders for the duration and unit.
Example:
With a cycle time of 100 ms,
"EnS_Lmgt_CycInt100msFC" is created.
EnS_LmgtForecast_Lin Instance DB of FB "EnS_LmgtForecast_LinExt"
Ext_<Name of the Example:
acquisition object>
The instance DB
"EnS_LmgtForecast_LinExt_Transformer1" is
created by an acquisition object with the
name "Transformer1".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 183
Optimizing energy consumptions
7.5 Generate energy program for load management

7.5.2.5 LMGT - systems

The "LGMT - systems" folder contains additional blocks for load management systems and
actuators, such as data blocks and functions (FCs) required for the load management, once
the program is generated.

LMGT - systems
The "LGMT - systems" folder contains the following general blocks once the program is
generated:

Block Description Example in STEP 7 (TIA Portal)

EnS_LmgtActuat Data block for parameters, config data
orList_<name of and priority list of actuator.
the load man- Example:
agement sys-
tem> (Page 323) EnS_LmgtActuatorList_Load_managem
ent_system_1 is created by an load
management system with the name
"Load_management_system_1".
EnS_LmgtContro Data block for limit, control parameters,
l_Peak_<name and time of load management.
of the load man- Example:
agement sys-
tem> (Page 290) EnS_LmgtControl_Peak_Load_manage
ment_system_1 is created by an load
management system with the name
"Load_management_system_1".
EnS_LmgtGener Data block for parameters, status, job
alData_<name data and control information of load
of the load man- management.
agement sys- Example:
tem> (Page 322)
EnS_LmgtGeneralData_Load_managem
ent_system_1 is created by an load
management system with the name
"Load_management_system_1".
EnS_LmgtActuat Instance DB of FB "EnS_LmgtActuator".
or _<name of Example:
the actuator>
The instance DB
"EnS_LmgtActuator_Actuator_1" is
created by an actuator with the name
"Actuator_1".

SIMATIC Energy Suite V19.0

184 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

7.5.2.6 Energy Suite data types

The Energy Suite library contains the information required data types for the energy program.

Energy Suite - data types

The "Energy Suite - data types" folder contains the instances of the data types blocks from the
Energy Suite library once the program is generated:
• Data types for acquisition: For more information on the data types for acquisition, see
"Energy Suite - data types (Page 85)"
• Data types for load management: Table below displays the load management data types
in subfolder "LMGT - data types"

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 185
Optimizing energy consumptions
7.5 Generate energy program for load management

Data type Description Example in STEP 7 (TIA Portal)

EnS_typeLmgtActuatorElement Data structure for one actuator
(Page 324)
EnS_typeLmgtActuatorMeta Actuator meta data
(Page 325)
EnS_typeLmgtActuatorPara- Parameters of actuator
meter (Page 325)
EnS_typeLmgtActuatorPara- Parameter set for one actuator
meterSet (Page 326)
EnS_typeLmgtActuatorStatus Status information and actual values of
(Page 327) actuator
EnS_typeLmgtActuatorStatus- Feedback and control values of actuator
InOut (Page 328)
EnS_typeLmgtAlarmElement Data of alarms and messages
(Page 329)
EnS_typeLmgtControlLimit- Limit configuration of basic LMGT functions
Config (Page 329)
EnS_typeLmgtControlPara- Data of control parameters
meters (Page 330)
EnS_typeLmgtControlPara- Set of control parameters
meterSet (Page 331)
EnS_typeLmgtControlTime- Time configuration of basic LMGT functions
Config (Page 331)
EnS_typeLmgtEnergyDiagram Diagram configuration for load manage-
(Page 332) ment
EnS_typeLmgtForecastValues Forecast energy data for load management
(Page 332)
EnS_typeLmgtGeneralData General data
(Page 333)
EnS_typeLmgtJobRequest- Job request data to actuators
Element (Page 334)
EnS_typeLmgtJobRequestStack Data for request stack
(Page 335)
EnS_typeLmgtJobTaskElement Task data to actuators
(Page 335)
EnS_typeLmgtJobTaskStack Data for Task stack
(Page 336)
EnS_typeLmgtOrganisation Period related data for load management
(Page 336)
EnS_typeLmgtTriggerBR Trigger information for backup-restore
(Page 337) block
EnS_typeLmgtVisualization Data for visualization
(Page 338)
EnS_typeLmgtStorageElement Data structure of storage actuator
(Page 339)
EnS_typeLmgtStoragePara- Parameters of a storage actuator
meter (Page 340)
EnS_typeLmgtStoragePara- Parameters set of a storage actuator
meterSet (Page 340)

SIMATIC Energy Suite V19.0

186 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

7.5.3 Configuring load management parameters with library elements

Linking of faceplate to load management parameters

To monitor the load management system, you can configure the parameters such as Infeed
and actuators. While you configure load management program in PLC, in the global library,
templates for load management control and actuator's parameter configuration are available.
You can configure the load management visualization screens by manually or automatically.
Automatic visualization is performed using SiVArc, for more details on automatic generation,
refer SiVArc online help. The below procedure describes the manual configuration of load
management visualization.
Requirement
• PLC connected to a HMI device (supported device is WinCC RT Professional)
• One or more load management system with corresponding infeed object, and actuators
configured, and running.
• Successful program generation

Procedure
To configure faceplates with load management parameters, perform the following:
1. After configuring the load management with Infeed, and actuators, browse the global
library, Energy Suite > LMGT Visualization.
Load management templates are displayed.
2. You can drag and drop the load management template screens to "Screens" folder under the
HMI device.
3. You can drag and drop the load management tag templates to the "HMI tags" folder under
the HMI device.
4. To link the faceplates with the tags:
– Open the template placed under the HMI tags folder.
– In the PLC tag column, browse for the PLC tag that will be available along with
acquisition objects after generation.
5. The faceplate is linked with the tags.
6. Download the HMI project to local by clicking the Download to device options in the tool
bar.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 187
Optimizing energy consumptions
7.5 Generate energy program for load management

Result
• Load management parameters in WinCC RT Professional are displayed.
• In the runtime mode to modify faceplate, click the load management parameters.
Parameter set 1 and Parameter set 2 mode - In runtime mode, you can manually assign
values to load management by switching between parameter sets by clicking "Activate
parameter set 1" or
"Activate parameter set 2". By defaut, "Parameter set 1" is active.
• The following criterions are applicable:
1. limit tolerance start value: 0 - 999 [%]
2. priority: 0 - 1999
3. rolling sequence: 1 - 99
The default load management parameters are:
• LMGT state - displays the state of LMGT - enabled/disabled.
• limit tolerance start value - predicts the accuracy of forecast values
• limit tolerance duration - time duration defined for limit tolerace value
• Priority - actuators are prioritized to be escalated or de-escalated
• Rolling sequence - assigned for actuators with same priority
• Minimum connect time - minimum time required to connect an actuator
• Maximum connect time - maximum time required to connect to an actuator

Note
To manually switch an actuator's state, manualCommand mode is used, and it is dependent
on the operation mode .manualcommand by default is set to FALSE. When you change the
OperationMode to False (which means manualCommand mode), then actuator can be
switched manually in the system. When OperationMode is in auto, the manualcommand
mode will hold the actuator's current state.

SIMATIC Energy Suite V19.0

188 Function Manual, 12/2023, A5E36824823-AH
 Optimizing energy consumptions
7.5 Generate energy program for load management

Back up and restore

After downloading the PLC and HMI project, the user interface is available to perform backup
and restore operations.
• In the runtime mode, click "Back-up" to create a copy of the load management
configuration. As soon as you click the Back up option, a back up file name as <LMGT
Name >_ ConfigBackup.bin is created on the SD card of the PLC.If storage actuators are
present, the storage actuator's data is stored in file "<LMGT name>_StorageBackup.bin.
Every time the backup operation is executed, the back up file is overriden with the latest
changes.
• In the runtime mode, click "Restore" to restore the load management configuration. When
you click restore, the load management configuration will be read from the latest back up
file, which is stored in the SD card of the PLC.

Note
• While restore complete LMGT parameters set in general DB and Actuator meta data &
parameters set in actuator list DB will be overwritten.
• Backup and restore block functions for PLCs with firmware versions 2.5 and above.

Log file for load management

The three different types of log files are:
• Limit violation - Upon limit violation (power demand exceeds power limit) , Lmgt_Control
block triggers the log file from "EnS_LmgtGeneralData" and "EnS_ActuatorList". A log file
of type "<LMGTName>_LimitViol_xx.bin" is created and for storage actuators, the data is
logged in file "<LMGT name>_LimitViol_Storagexx.bin". When the maximum file size is
reached, a new file will be created with incremented file number xx. The data is read and
written to the SD card of the PLC.
• Switching action - When switching action is performed by the load management
actuators, data from "EnS_LmgtGeneralData" and EnS_ActuatorList" is read and written to
the SD card of the PLC. A log file of type " "<LMGTName>_SwitchEvnt_xx.bin"is created
and for storage actuators, data is logged in file "<LMGT
name>_SwitchEvnt_Storagexx.bin".
• Lack of actuators - When control block wants to perform an escalation of job, and no
actuators are available. A log file of type " "<LMGTName>_LackActuators_xx.bin" is created
and for storage actuator's, data is logged in file "<LMGT
name>_LackActuators_Storagexx.bin".

Note
For multiple files, xx is a consecutive number defined by the input parameter
"amountLogFiles" in the PLC.

The log file consists of all the DB parameters of load management system and actuator
gloabal DB. The log file contains the information such as name of the load management
system, Date and time of the limit violation or actuators (includes local and UTC time), power
limit, current power, average power forecast or average power (at the end of an period) and
so on.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 189
Energy Efficiency Monitor 8
8.1 Basic information of Energy Efficiency Monitor
The Energy Efficiency Monitor provides the following three main functions:
• Average power value calculation per operating state
• Distribution of energy to the respective operating state
• Calculation of specific energy consumption per unit produced

Average power value calculation per operating state

The average power value calculation per operating state is used to evaluate the machine
characteristic. You can start a reference measurement and a current or last measurement. An
average power value per operating state is calculated for each configured measuring point.
The percentage difference is calculated as a result for each power value.
The following example shows the calculation of the percentage deviation of the power value
of a current measurement relative to a reference measurement of an electrical measuring
point in the "Standby" operating state:
• Reference measurement: 500 W
• Current measurement: 600 W
• Difference: 20%
The percentage deviation of 20% shows that the machine property has changed.

Distribution of energy to the respective operating state

The distribution of the energy to the respective operating state is used to evaluate the
operation of the machine. Several status-related counters are mapped for the input value of a
measuring point for each status. You can automatically map additional calculations as energy
characteristics in SIMATIC Energy Manager PRO.
The following example shows the status-related distribution of the energy of an electrical
measuring point:
• Counter in "Off" operating state: 10 kWh
• Counter in "Standby" operating state: 100 kWh
• Counter in "Operational" operating state: 390 kWh
• Counter in "Working" operating state: 2 000 kWh
• Counter value total: 2 500 kWh
The value-adding energy in the "Working" operating state is 80%.

SIMATIC Energy Suite V19.0

190 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.2 Configuring the Energy Efficiency Monitor system

Calculation of specific energy consumption per unit produced

With the energy efficiency monitor you can calculate the energy consumption per unit
produced in relation to a specific operating state.
The following example shows the energy consumption of an electrical measuring point per
unit produced in the "Working" operating state:
• Counter in "Working" operating state: 2 000 kWh
• Counter quantity: 100 units
The energy consumption is 20 kWh per unit. Only the "Working" operating state is taken into
account when calculating the energy consumption per unit.

8.2 Configuring the Energy Efficiency Monitor system

Procedure
To configure an Energy Efficiency Monitor system perform the following steps.
1. Select Energy Efficiency Monitor systems under the Energy Efficiency Monitor from the
Project tree.
2. In the Energy Efficiency Monitor system tab, click on Add new and enter the following
details.
– Name
– Enable generation
– Machine type
– Machine State
– Piece counter
– Piece overflow counter
– Comment
3. On selecting the Energy Efficiency Monitoring system, the corresponding measuring devices
list is displayed.
4. Further you can configure the system from the properties Tab.
5. Under General you have the Basic settings where you can edit the above configured
properties.
6. In the Configuration section of the properties Tab you can edit the Machine state
information. Here you can select the machine state and update the status information.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 191
Energy Efficiency Monitor
8.3 Generate energy program for Energy Efficiency Monitor

To configure the measurement device perform the following steps.

7. Select a Energy Efficiency Monitoring system, the corresponding measuring devices list is
displayed.
8. Click on Add new in the mesurement points tab and enter the following details.
– Name
– Media Type
– Media Data type
– Media Data source
– Unit
– Enable generation
– Comment
9. These details can be edited in the properties Tab under the General-> Basic settings.
10.In the configuration section of the properties tab you can edit the media setting for Energy
counter and Power media data types.

Note
For a Energy efficiency monitoring system you can configure upto 10 measurement points.

8.3 Generate energy program for Energy Efficiency Monitor

After configuring the energy efficiency monitor system with its associated devices, and
general settings for the energy program, generate the energy program for energy efficiency
monitoring system based on below mentioned sections.

Requirement
• All Energy efficiency monitor systems which should be included are enabled for the
energy program.
• The energy efficiency monitor systems enabled for the energy program are fully
configured.
• All devices which should be included are enabled for the energy program.
• The devices enabled for the energy program are fully configured.

SIMATIC Energy Suite V19.0

192 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.3 Generate energy program for Energy Efficiency Monitor

Procedure
To generate the energy program for energy efficiency monitor system, perform the following
steps:
1. Open the S7-1500 CPU in the project tree.
2. Click on the "Energy objects" object below the S7-1500 CPU and select the option "Generate
energy program" from the shortcut menu.
Alternatively, you can select this option in the "Energy program settings" dialog by clicking
the "Generate energy program" icon.
The dialog with the selection for generating the energy program opens.
3. Select one of the options:
– Energy acquisition program: generates energy program with the values configured for
energy acquistion.
For generating only an energy acquisition program see section Generate energy
program (Page 68).
– Energy acquisition and Load management: generates energy program with the values
configured for energy acquistion and load management by default. If load
management is not configured, energy acquisition program is only generated.
– Energy acquisition and Energy Efficiency monitoring: generates energy program with
the values configured for energy acquistion and energy efficiency monitoring by
default. If energy efficiency monitoring is not configured, energy acquisition program
is only generated.
– Complete energy program (Energy acquisition, Load management and Energy
Efficiency monitoring): generates energy program with the values configured for
energy acquistion, load management and energy efficiency monitor by default. If load
management and/or energy efficiency monitoring is not configured, energy acquisition
program is only generated.
4. Click the "Generate" button.
The generator checks the completeness and the plausibility of the configuration of the
acquisition objects and starts the generation of the energy program. Information and
events during the generation of the energy program are displayed in the Inspector
window under "Info > Energy Suite".
5. Click "Cancel" to stop the generation.
6. You can use the "Go to" function to jump to the position in the configuration that is relevant
for the respective event.
7. You can repeat the steps for generating the energy program with necessary configurations.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 193
Energy Efficiency Monitor
8.3 Generate energy program for Energy Efficiency Monitor

Result
After configuring acquisition objects, instances of the required blocks are created from the
Energy Suite Library and the measurement hardware library in the "Program blocks" folder
below the S7-1500 CPU. In addition, other required components, such as organization blocks
and data blocks, are added to the "Program blocks" folder and the required interconnections
are done.
Instances of data types from the Energy Suite Library and the measurement hardware library
can be created in the "PLC data types" folder below the S7-1500 CPU.
The energy program is generated for all enabled energy efficiency monitoring systems.

Object Description
Energy Suite - program New folder for energy program
EnS - block types (Page 79) Subfolder "EEM - block types" with additional function blocks for energy
efficiency monitor.
EnS - program blocks (Page 81) Folder for additional blocks (organization blocks, functions, DBs, etc.)
Energy Efficicency Monitor - systems (Page 199) Folder with additional functions and data blocks for energy efficiency
monitor systems and devices

SIMATIC Energy Suite V19.0

194 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.3 Generate energy program for Energy Efficiency Monitor

Delta generation scenario

• Add - In case of delta generation, when you add new energy efficiency monitor devices in
the "Energy efficiency monitor" table along with existing device objects and generate
energy program: the new device blocks generated will append to the existing blocks
under the folder "Energy Suite - program". The related function calls will get updated
accordingly.
• Modify - In case of delta generation, when you edit energy efficiency monitor system or
devices in the "Energy efficiency monitor" table and generate energy program: the edited
Energy efficiency monitor system device blocks will get generated and append to the
existing blocks under the folder "Energy Suite - program". The modified parameters of
energy efficiency monitor system or devices are updated in the runtime under "Start
value" column only in the DBs. To reflect the changes from "Start value" column to
"Monitor value" column in runtime, you must click "Load start values as actual values". The
related function calls will get updated accordingly.
In SCADA runtime: All screen references to the unchanged Energy efficiency monitor and
devices will remain valid.
• Delete - In case of delta generation, when you delete load management device in the
"Energy efficiency monitor" table and generate energy program: only the selected device
blocks will be deleted and will not affect the existing blocks under folder "Energy Suite -
program". The related function calls will get updated accordingly.

See also
Making general settings for the energy program (Page 68)
General settings (Page 69)
Acquisition objects (Page 84)
Energy Suite data types (Page 185)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 195
Energy Efficiency Monitor
8.4 Structure of energy program

8.4 Structure of energy program

8.4.1 Structure of energy program for energy efficiency monitor

When the energy program is generated, the following folders are automatically created
below the S7-1500 CPU:
• "Energy Suite - program" folder under "Program blocks" with subfolders
– [EnS general program elements]
- EnS - block types (Page 197)
- EnS - program blocks (Page 198)
– EnS - acquisition objects (Page 198)
– Energy efficiency monitor - systems (Page 199)
• Folder "Energy Suite data types" under "PLC data types"

Note
Blocks of the energy program
SIMATIC Energy Suite automatically generates for you all the required blocks and data types
and their interconnection based on the configured acquisition objects and the energy
program settings.
You do not need to further adapt these blocks for the standard application with Energy Suite.

SIMATIC Energy Suite V19.0

196 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.4 Structure of energy program

8.4.2 EnS - block types

The structure of your energy efficiency monitor configurations:
The function of the EEM is implemented on the PLC with three different blocks.
• "EnS_EEm_Calc": This instruction is integrated in TIA Portal is the core of the Energy
Efficiency Monitor. Its function is to calculate the status-dependent consumption values
and the Energy performance indicator.
• "EnS_EEm_Report": This block is available as an integrated instruction in TIA Portal, albeit
as a function block. It creates a detailed report as a CSV file summarizing the current
measurement results.
The blocks and associated User Data Types are stored in a library and can be copied into your
project.

Note
The configuration of the individual blocks is done centrally. By bundling the data in the block
"eemFunctionCall", you only need to connect the inputs on this block.

The essential function of the Energy Efficiency Monitor is carried out by the "EnS_EEm_Calc"
instruction. The shell block serves to bundle all the Energy Efficiency Monitoring system
functionalities, to make commissioning easier, and as a unified interface for the visualization.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 197
Energy Efficiency Monitor
8.4 Structure of energy program

The EEM needs at least three pieces of information from the machine you wish to monitor:
• Machine status = Status of the machine. Valid values are 1-8. For all values outside of this
range, the energy is totaled in array element 0.
• Production counter = Number of products produced at the machine.
• Measured values = Up to 10 measured values from the instruments in the machine. Here,
it is not necessary to distinguish between real value and meter value when interfacing
with the FB. Detailed configuration of the measured value can be finalized in the
visualization during runtime.

See also
Making general settings for the energy program (Page 68)
Supply energy data (Page 24)
Setting the properties of the acquisition objects (Page 39)

8.4.3 Acquisition objects

Once the program is generated, the "EnS - acquistion objects" folder contains a subfolder with
the name of the acquisition object table "<name of the acquisition object table>" for each
acquisition object table with acquisition objects.
The "<name of the acquisition object>" folder contains the instance data blocks (Page 84)
• On the function blocks that are required for the acquisition objects in the energy program
• With the periodic energy values of the acquisition objects, which are provided for
buffering and archiving
The data blocks for buffering the energy data are also created as instances from the Energy
Suite library in this folder.

8.4.4 EnS - program blocks

The "EnS - program blocks" folder contains additional blocks, such as organization blocks,
data blocks and functions (FCs) required for the energy program, once the program is
generated.
EnS - program blocks
The "EnS - program blocks" folder contains the general blocks once the program is generated:
• General program blocks for acquisition: For more information on general program blocks
for acquisition, see "EnS - program blocks (Page 81)"
• General program blocks for Energy efficiency monitoring system: Table below displays the
general program blocks for Energy efficiency monitoring system.

Block Description Example in STEP 7 (TIA Portal)

EnS_EEm_FunctionCall This block includes functions to com-
pute and report the data measured
from the measuring devices associated
with a particular machine

SIMATIC Energy Suite V19.0

198 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.4 Structure of energy program

8.4.5 Energy efficiency monitor - systems

The "Energy efficiency monitoring systems" folder contains additional blocks for energy
efficiency monitor systems and devices, such as data blocks and functions (FCs) required for
the energy efficiency monitor, once the program is generated.

Block Description Example in STEP 7 (TIA Portal)

EnS_EEmCall Function call for a particluar
_<name of machine comprising of compu-
machine> tation and reporting blocks
EnS_Eem- Database of measuring devices
GeneralData for a particular machine.
_<name of
the machine>

8.4.6 Energy Suite data types

The Energy Suite library contains the information required data types for the energy program.

Energy Suite - data types

The "Energy Suite - data types" folder contains the instances of the data types blocks from the
Energy Suite library once the program is generated:
• Data types for acquisition: For more information on the data types for acquisition, see
"Energy Suite - data types (Page 85)"
• Data types for load management: Table below displays the load management data types
in subfolder "EEm - data types"

Data type Description Example in STEP 7 (TIA Portal)

EnS_typeEEmData Contains the Energy efficiency
(Page 387) montoring system data.
EnS_typeEEmDataInter- Contains internal data for block
nal (Page 388) functions.
EnS_typeEEHmiEnMPro- Contains communication infor-
Communication mation for EnMPro communication
(Page 389)
EnS_typeEEmMeasPoint- Used for measurement point con-
Configuration (Page 390) figuration.
EnS_EEm_typeComDiag- Contains diagnostic data for
nostics (Page 391) EnMPro communication
EnS_EEm_typeCommuni- Contains communication data for
cation (Page 392) EnMPro communication.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 199
Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

8.5 Visualizating screens for Energy Efficiency Monitor

8.5.1 Configuring the system for visualizing screens

Energy efficiency monitoring system offers a visualization template WinCC Unified only. You
can start configuring the screens with the help of the following faceplates.

Faceplate "fpEEmInfo"
This faceplate serves as a jumping-off point for opening the detailed information. In order to
see which faceplate relates to which Energy Efficiency Monitor instance, the configured
name of the machine is displayed. On Left-click the detail view with the associated data is
displayed.

Configuration
To configure the Energy Efficiency Monitor the visualization offers a configuration wizard,
which launches the first time the faceplate is opened.

Configuration of general machine settings

In the first configuration step, we make machine-wide settings. These include:
• Metadata of the machine (name, type, etc.)
• Names of the machine states
• Identification of the productive machine states
• Identification of the machine states for the EnPI

SIMATIC Energy Suite V19.0

200 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

1. Machine name
2. Type of the machine
3. Serial number of the machine
4. Manufacturer of the machine
5. Settings regarding machine states, including name, EnPI calculation and productive energy
6. Left-click to confirm the machine settings and continue the wizard
7. Left-clicking here aborts the initialization.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 201
Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

Machine state settings

Here you can edit the machine state settings.

1. Names of the machine states.

2. Left-clicking switches the identification of the productivity state (blue = productive, gray =
non-productive).
3. Left-clicking switches the identification of the EnPI calculation state (blue = included in the
calculation).

SIMATIC Energy Suite V19.0

202 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

Configuration of measurement points

The configuration wizard will guide you through settings for all measurement points as a
function of the machine configuration. You need not enter values in the data blocks and
UDTs. Using the metadata, all settings, up to and including the measurement point type, can
be stored during runtime.

1. Current configuration progress

2. Name of measurement point
3. Medium measured by the measurement point (e.g. electrical energy, air, gas, etc.)
4. Units for actual value and meter in plaintext
5. Measurement point type configuration (meter or actual value). Depending on the selection,
the following settings options will be covered up.
6. Interpolation of the connected actual value. If no interpolation is necessary (input value =
output value), the starting values can be left alone.
7. Left-clicking saves the configuration of the measurement point and checks that it is valid.
8. Aborts the initialization.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 203
Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

9. Normalization factor for a connected meter value. If no normalization is necessary (input

value = output value), the value 1.0 must be set.
10.Overflow value of the connected meter.

Note
If incorrect input is entered while configuring the type of measured value, it will be
highlighted in red in the IO field. You can correct it with the valid limit values.

8.5.2 Visualization screens overview

After succesful configuration, you will be able to visualize key data points in the Energy
Efficiency Monitor Overview screen.

SIMATIC Energy Suite V19.0

204 Function Manual, 12/2023, A5E36824823-AH
 Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

1. Productive energy widget: The energy consumed by a machine should be used in the most
productive manner possible, where the proportion is ideally as close to 100% as possible.
The share of productive energy in relation to the total consumption is calculated from the
energy meters of the productive machine states. Productive statuses can be selected in a
separate configuration dialog.
– Opens the dialog for configuring the productive machine states.
– Displays pie chart indicating the productive energy in percent (blue = productive
energy, gray = non-productive energy).
– Represents percentage of productive energy in comparison to the total consumption.
2. Energy by status widget: Provides a more precise overview of how much energy is used. It
represents the energy by status in the form of a pie chart.
– Displays an energy pie chart divided by status. The legend below indicates which
segment colors correspond to which machine states (here: red = idle).
– Represents percentage of the energy used in this status compared to the total
consumption (right). Without a status selected, the share is 100% (left).
– Left-clicking on one of the six machine states in the legend highlights this status in the
pie chart.
– Shows the currently highlighted machine state / the machine state shown in the IO
fields.
– Left-clicking resets the highlighted status selection.
3. Energy Performance Indicator view: One of the most important data points for a
production machine is its efficiency. To this end, the energy efficiency monitor calculates
the consumption per item and displays this in a widget within the visualization.
– On click, opens the configuration dialog for the machine states for calculating the EnPI.
– Displays the item counter used for calculating the EnPI, the last EnPI reset, Energy
Performance Indicator,the reference value of the EnPI for the graphic beneath.
– Shows the current value of the EnPI compared to the reference value. The starting
values for the upper (dark green) and lower (dark red) limit of the graphic are 90%
(actual value is better than the reference value) and 140% (actual value is worse than
the reference value).
4. Widget for actual and reference measurements: This widget lets the user start an actual
or reference measurement. In general, one should always use a reference measurement as a
reference point, and only at certain times (e.g. after machine acceptance or after
implementing efficiency improvements). An actual measurement, by contrast, can be
carried out at any time to check the changes in energy efficiency.
– The status of the actual and reference measurement (here, both measurements are
stopped). A measurement in progress is symbolized with an orange clock icon with an
orange triangle.
– Left-clicking opens the dialog for starting or stopping measurements.
– The start time and the duration of the latest measurement is displayed.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 205
Energy Efficiency Monitor
8.5 Visualizating screens for Energy Efficiency Monitor

5. Measurement results widget: After taking at least one reference or actual measurement,
the results appear on the right side in the widget. Here, the value of the reference
measurement is taken as a basis and then the percent deviation of the actual measurement
value is given.
A value above 0% indicates the consumption of the actual measurement is greater than in
the reference measurement, meaning that the efficiency has declined.
A value below 0% indicates the consumption of the actual measurement is less than in the
reference measurement, meaning that the efficiency has improved.
To get the most accurate figures about any improvements or declines, it is recommended
to let the respective measurements run over a longer period so as to eliminate statistical
anomalies.
The following values are displayed.
– Graphical view of the measured difference between reference and actual
measurement. By default, the maximum and minimum value are ±25%. The value can
be modified in the configuration dialog (see Configuration dialog for the general
visualization). > 1% = orange bar indicates significant deterioration. ± 1% = green bar
indicates consumption has not changed. < 1% = green bar indicates a significant
improvement.
– Percent deviation in plaintext.
– Average consumption during the actual measurement.
– Average consumption during the reference measurement.

SIMATIC Energy Suite V19.0

206 Function Manual, 12/2023, A5E36824823-AH
Energy Suite blocks - Acquisition A
A.1 Overview of Energy Suite blocks for acquisition

Note
Description of Energy Suite blocks for experts
You can find a detailed description about how each block operates and its block parameters
in the following sections.
You do not need this information for the standard application with Energy Suite. SIMATIC
Energy Suite automatically generates for you all the required blocks and their interconnection
based on the configured acquistion objects and the energy program settings.

CAUTION
Manual change to blocks of the energy program
If you make manual changes to the blocks and their interconnection after generating the
energy program, you yourself are responsible for the error-free operation of the devices and
the energy program. User is responsible if any new blocks or folders are added, the
regeneration of energy program will lead to the removal of blocks from containers, and
causes an error state.

CAUTION
Using Energy Suite blocks in other PLC programs
If you use the Energy Suite blocks from the global library in other PLC programs, you
yourself are responsible for error-free use of Energy Suite blocks.

This section provides an overview of all available Energy Suite blocks. Following the
installation of SIMATIC Energy Suite, the blocks can be seen under "Global Libraries" in STEP 7
(TIA Portal):
• Function blocks (Page 211)
• Data blocks (Page 265)
• Data types (Page 267) including enumerations (Page 282)

How Energy Suite blocks work

The following shows how the Energy Suite blocks generally work in the energy program for
energy data from the process image of the CPU (PLC tags) or from data blocks (DB tags).

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 207
Energy Suite blocks - Acquisition
A.1 Overview of Energy Suite blocks for acquisition

The placeholder "xxx" in the picture means that there are different types of this block, for
example, for "EnS_Drvxxx":
• EnS_DrvPulse
• EnS_DrvCounterLInt
You can find more types in the "Function Blocks" table after the picture below.
The following picture show how the Energy Suite blocks work:

* EnS_BufferRead is not called for archiving in WinCC Professional

Energy data flow
Parameter assignment data

Blocks used internally

Blocks associated with an energy acquisition table

SIMATIC Energy Suite V19.0

208 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.1 Overview of Energy Suite blocks for acquisition

Function blocks

Name Function
EnS_ArchiveDataLog (Page 211) Archived energy data in data logs (CSV file on the SIMATIC memory card of the CPU)
EnS_ArchiveHMI (Page 221) Archived energy data in data logs of WinCC Professional
EnS_BufferRead (Page 229) Reads the data from the buffer DB (EnS_BufferDB (Page 265)).
Used internally
EnS_BufferWrite (Page 231) Writes data to the buffer DB (EnS_BufferDB (Page 265)).
Used internally
EnS_CalcEnergyData (Page 234) Periodic calculation of the consumed energy and average power consumption
EnS_DrvAnalogValue (Page 240) Driver block for analog input (e.g. power value, flow value)
EnS_DrvCounterLInt (Page 242) Driver block for counter values of the LINT type
EnS_DrvCounterLReal (Page 244) Driver block for counter values of the LREAL type
EnS_DrvPulse (Page 246) Driver block for a pulse input
EnS_EnergyDataAdv (Page 248) Advanced energy data from a device (for example, phase-specific current and voltage
values)
EnS_EnergyDataAdvMinMax Minimum and maximum values of the advanced energy data of a device
(Page 249)
EnS_EnergyDataBasic (Page 250) Basic energy data from a device (for example, power, energy counter value)
EnS_Organization (Page 255) Contains general data and parameters for central program organization
EnS_TimeSync (Page 256) Synchronizes the times for calculating the energy data
EnS_EnergyDataAdd (Page 263) Additional energy data

Data blocks

Name Function
EnS_BufferDB (Page 265) * Data block for buffering of energy data records
EnS_BufferWorkDB (Page 266) * Data block for monitoring and status information of the buffer

* The name can be changed.

User-defined data types

Name Function Used by

EnS_typeAnalogValue (Page 267) Data type for analog process values EnS_CalcEnergyData
EnS_DrvAnalogValue
EnS_typeBufferReadCtrl (Page 267) Data type for control information of the EnS_BufferRead
buffer for reading data EnS_typeBufferWork
EnS_typeBufferReadStat (Page 268) Data type for data and status infor- EnS_typeBufferWork
mation of the buffer for reading data
EnS_typeBufferWork (Page 268) Data type for monitoring and status EnS_BufferRead
information of the buffer EnS_BufferWrite
EnS_ArchiveDataLog
EnS_EnergyDataBasic
EnS_BufferWorkDB
EnS_ArchiveHMI

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 209
Energy Suite blocks - Acquisition
A.1 Overview of Energy Suite blocks for acquisition

Name Function Used by

EnS_typeBufferWriteCtrl (Page 270) Data type for control information of the EnS_BufferWrite
buffer for writing data EnS_typeBufferWork
EnS_typeBufferWriteStat Data type for status information of the EnS_typeBufferWork
(Page 270) buffer for writing data
EnS_typeEnergyAdv (Page 271) Data type for advanced energy data EnS_EnergyDataAdv
EnS_typeEnergyBasic (Page 272) Data type for basic energy data EnS_CalcEnergyData
EnS_EnergyDataBasic
EnS_typeEnergyCounter (Page 273) Data type for energy count value EnS_CalcEnergyData
EnS_DrvCounterLInt
EnS_DrvCounterLReal
EnS_DrvPulse
EnS_typeEnergyMeta (Page 274) Data type for metadata of the measuring EnS_CalcEnergyData
point (information for configuration of EnS_BufferWrite
the acquistion object)
EnS_DrvAnalogValue
EnS_DrvCounterLInt
EnS_DrvCounterLReal
EnS_DrvPulse
EnS_EnergyDataAdv
EnS_EnergyDataBasic
EnS_typeHMIWriteCtrl (Page 277) Data type for control information of the EnS_ArchiveHMI
buffer for writing energy data to the
data log of WinCC Professional
EnS_typeHMIWriteStat (Page 278) Data type for status information of the EnS_ArchiveHMI
buffer for writing energy data to the
data log of WinCC Professional
EnS_typeOrgData (Page 279) Data type for organization data EnS_Organization
EnS_TimeSync
EnS_DrvAnalogValue
EnS_DrvCounterLInt
EnS_DrvCounterLReal
EnS_DrvPulse
EnS_ArchiveDataLog
EnS_EnergyDataAdv
EnS_EnergyDataBasic
EnS_ArchiveHMI
EnS_typeSync (Page 279) Data type for time synchronization EnS_TimeSync
EnS_CalcEnergyData
EnS_typeValue (Page 280) Data type for output values EnS_BufferDB
EnS_BufferRead
EnS_ArchiveDataLog
EnS_typeEnergyAdd (Page 280) Data type for additional energy data EnS_EnergyDataAdd
Ens_typeEnergyAddValue Data type for additional energy data EnS_typeEnergyAdd
(Page 281) value

SIMATIC Energy Suite V19.0

210 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2 Function blocks (FBs)

A.2.1 EnS_ArchiveDataLog: Write energy values to data logs

A.2.1.1 Description of EnS_ArchiveDataLog

Description
The "EnS_ArchiveDataLog" function block writes periodic energy data from the data block for
buffering to buffer EnS_BufferDB (Page 265)" ("bufferDB" parameter) in "Data Logs to the
SIMATIC memory card of the CPU. Writing is performed only if the "archiveEnergy",
"archivePower", "archiveEnergyCounter" parameters have been set to "TRUE" in the
corresponding metadata (Page 274). The data are stored as a CSV file on the SIMATIC
memory card.
To avoid access conflicts on the SIMATIC memory card of the CPU, use only one instance of
the function block per CPU.
The following table shows the structure of a CSV file.

Column Name Description

1 SeqNo Sequential number (specified by the system)
2 Tagname Tag name
3 Value Archived value
4 TimeStamp Time stamp of the archived value
5 Status Status of the archived value

The name of the archived data is composed of <DataLogName>+<YYYYMMDD_hhmm (time

stamp of the creation time stamp in UTC format)>
Example: DataLog_20141117_2315
The size of the data log is limited by the system to 1 GB. The number of data records must be
set accordingly at the "noRecords" parameter (see the following calculation example).
Example: The space required on the memory card for a data log is calculated using the
following formula: 45 bytes + (number of data records * 116 bytes).
The number of data logs is defined by the "noDataLogs" parameter. The capacity of the
memory card limits the number of available data logs (valid number: 1 - 100).

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 211
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Writing data logs

The archiving of energy data is performed when the buffer DB contains new data
(bufferWork.noItems > 0). The function block then reads the new data with the
"EnS_BufferRead (Page 229)" function block and writes it to the data log.

Note
The writing speed may vary depending on the CPU used, the employed memory card and the
location of the data on the memory card. The number of cycles that are required to write an
energy data record varies. No more than 1 data record can be written per cycle.

Number of data logs

If a data log is full, the "full" output is set for one cycle and a alarm is generated.
When the maximum number of data logs ("noDataLogs", valid number: 2-10) has been
reached and the last data log is full, the oldest data log is deleted and a new data log is
created. A message is generated when a data log is deleted or a new one is created. You can
view the alarm on a SCADA system, for example.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 215)" parameter
contains additional error information. The error information of the lower-level function block
"EnS_BufferRead (Page 229)" is added to the "status" parameter. The error information is
displayed in the "status" parameter until the error is cleared. Only then is the information
about the next pending error displayed.

SIMATIC Energy Suite V19.0

212 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.1.2 Parameters of EnS_ArchiveDataLog

The following table shows the function block "EnS_ArchiveDataLog":

Parameter Declaration Data type Default Description R*

dataLogName Input STRING[32] - Name of the data log -
noRecords Input UDINT 10000 Number of data records in the data log -
noDataLogs Input UINT 5 Number of data logs -
bufferDB Input DB_ANY - Pointer to buffer data block -
sD Input VARIANT - Associated value for alarm messages -
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated -
press
full Output BOOL FALSE TRUE = Data log is full -
busy Output BOOL FALSE TRUE = Processing is active -
done Output BOOL FALSE TRUE = Data successfully processed -
error Output BOOL FALSE TRUE = Error -
status Output WORD - Error status information (Page 215) -
statusCreateFct Output WORD - Error status information of the Data- -
LogCreate instruction
statusOpenFct Output WORD - Error status information of the Dat- -
aLogOpen instruction
statusWriteFct Output WORD - Error status information of the Data- -
LogWrite instruction
statusDeleteFct Output WORD - Error status information of the Data- -
LogDelete instruction
statusCloseFct Output WORD - Error status information of the Data- -
LogClose instruction
dataLogName- Output STRING[48] - Name of the active data log -
Act
dataLogName- Output STRING[48] - Name of the last data log -
Last
data- Output STRING[48] - Name of the deleted data log -
LogNameDel
errorAlarm1 Output BOOL FALSE TRUE = Error Program_Alarm1 -
statusAlarm1 Output WORD - Error status information Pro- -
gram_Alarm1
alarmState1 Output BYTE - Alarm status of Program_Alarm1 -
errorAlarm2 Output BOOL FALSE TRUE = Error Program_Alarm2 -
statusAlarm2 Output WORD - Error status information Pro- -
gram_Alarm2
alarmState2 Output BYTE - Alarm status of Program_Alarm2 -
errorAlarm3 Output BOOL FALSE TRUE = Error Program_Alarm3 -
statusAlarm3 Output WORD - Error status information Pro- -
gram_Alarm3
alarmState3 Output BYTE - Alarm status of Program_Alarm3 -
errorAlarm4 Output BOOL FALSE TRUE = Error Program_Alarm4 -
statusAlarm4 Output WORD - Error status information Pro- -
gram_Alarm4
alarmState4 Output BYTE - Alarm status of Program_Alarm4 -
errorAlarm5 Output BOOL FALSE TRUE = Error Program_Alarm5 -

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 213
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Parameter Declaration Data type Default Description R*

statusAlarm5 Output WORD - Error status information Pro- -
gram_Alarm5
alarmState5 Output BYTE - Alarm status of Program_Alarm5 -
errorAlarm6 Output BOOL FALSE TRUE = Error Program_Alarm6 -
statusAlarm6 Output WORD - Error status information Pro- -
gram_Alarm6
alarmState6 Output BYTE - Alarm status of Program_Alarm6 -
id InOut DWORD 0 ID of the current data log X
orgData InOut EnS_typeOrgData - Organization data -
(Page 279)
bufferWork InOut EnS_typeBufferWork - Buffer monitoring and status infor- -
(Page 268) mation

* The marked parameters are given the "Retain" system attribute and are stored in the
retentive memory area of the CPU.

SIMATIC Energy Suite V19.0

214 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.1.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter of the "EnS_ArchiveDataLog" function block when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8511 Error reading from Archiving buffer- The reading continues until it is successful.
buffer error Work.readStat.st Cause of error:
atusReadFct
Wrong data block is connected or no data block is
present.
Procedure:
Correct the program.
8601 Error creating data Error creat- statusCreateFct The errors of the "DataLogCreate" SFC are copied to
log ing the "statusCreateFct" parameter.
The creation is repeated until it is successful.
Causes of error:
• Name of the data log is invalid
• No memory space
• 10 or more data logs are opened in SIMATIC
Memory Card
Procedure:
• Assign a valid name to the Data Log.
• You can find additional information about valid
names in the section "Archiving and buffering
(S7-CPU) (Page 59)".
• Adapt the storage capacity of the SIMATIC
Memory Card used.
• Release the lock on the used SIMATIC Memory
Card.
• Download software (all) to PLC. While down-
loading software (all), PLC will be restarted, and
data logging will continue.
8602 Error opening data Error open- statusOpenFct Opening the data log is repeated until it is success-
log ing ful.
Causes of error:
• Data Log is not available
• Data Log is already open
Procedure:
• Close the data log before opening.
• Ensure that the Data Log has already been cre-
ated.
• Release the lock on the used
SMATIC Memory Card.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 215
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8603 Error writing data Error writing statusWriteFct Writing to the data log is repeated until it is success-
log ful.
Causes of error:
• Data Log is not available
• No memory space
Procedure:
• Ensure that the Data Log has already been cre-
ated.
• Release the lock on the SIMATIC Memory Card
used.
8604 Error deleting data Error delet- statusDeleteFct The Data Log file is not deleted
log ing Causes of error:
• Data Log is not available
• Data Log is write protected
• No memory space
Procedure:
• Close the data log file.
• Adapt the storage capacity of the SIMATIC
Memory Card used.
• Release the lock on the used SIMATIC Memory
Card.
8605 Error closing data Error during statusCloseFct Closing the data log is repeated until it is successful.
log closing Causes of error:
• Data Log is not available
• Data Log is already closed
Procedure:
• Open the Data Log before closing.
• Ensure that the Data Log has already been cre-
ated.
• Release the lock on the SIMATIC Memory Card
used.

SIMATIC Energy Suite V19.0

216 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8611 Maximum number Parameter noRecords The size of the data log is limited by the system to 1
of data records too assignment GB. The capacity of the SIMATIC Memory Card limits
high error the number of available data logs.
Causes of error:
• The maximum number of data records is ex-
ceeded.
Procedure:
• Adapt the storage capacity of the SIMATIC
memory card used (for example, by deleting the
old data logs).
8612 Number of data logs Parameter noDataLogs The number of data logs corresponds to the "Num-
invalid (<2 or >10) assignment ber of data logs" setting in the "Archiving" area for
error the "PLC (SIMATIC Memory Card)" archiving type.
Causes of error:
• The number of data logs is out of range.
Procedure:
• Specify a valid number of data logs under "CPU >
Acquistion Objects > Energy Program Settings >
Archiving and buffering > Number of data logs".

The additional alarm texts ("Description" column) are written in the "EnS_Alarms" text list of
the "Program_Alarm2" alarm block and are output with the error codes in the alarm.

See also
Description of EnS_BufferRead (Page 229)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 217
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.1.4 Alarms of EnS_ArchiveDataLog

The alarms are generated with the instruction "Program_Alarm" A multi-instance of the
"Program_Alarm" data type is created under the "Static" tag of the "EnS_ArchiveDataLog"
function block for each alarm. You can find additional information on "Program_Alarm" in the
online help of the TIA Portal information system under "Extended instructions > Alarms".
The following table shows the alarms generated by the "EnS_ArchiveDataLog" function block:

Alarm block Alarm text Alarm class

Program_Alarm1 Parameter assignment error With acknowl-
edgment
Program_Alarm2 Logging error: <text list: EnS_Alarms:#status> With acknowl-
edgment
Program_Alarm3 Energy log full: <Tag:#dataLogNameLast > With acknowl-
edgment
Program_Alarm4 Create energy Log: <Tag:#dataLogNameAct > With acknowl-
edgment
Program_Alarm5 Delete energy log: <Tag:#datalogNameDel > With acknowl-
edgment
Program_Alarm6 Data loss of <Tag:#bufferWork.noDeletedItems" data rec- With acknowl-
ords* edgment

* The "bufferWork.noDeletedItems" parameter contains the number of records that will be

overwritten with a buffer overflow.
The additional alarm texts for "Program_Alarm2" are described in the "EnS_Alarms" text list.
The error codes (status) are output in the alarm text and contain additional alarm text of the
respective error codes.
The following table shows the error codes with additional alarm texts of the
"Program_Alarm2" alarm blocks:

Alarm block Error code Alarm text Parame- Function block

(W#16#...) ter
Program_Alarm2 8511 Error reading from buffer status EnS_BufferRead
(Page 229)
8601 Error creating data log EnS_ArchiveDataL
8602 Error opening data log og
8603 Error writing data log
8604 Error deleting data log
8605 Error closing data log

SIMATIC Energy Suite V19.0

218 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

The associated values for the alarms are assigned as follows:

Alarm block Associated Parameter Description

value
Program_Alarm1 1 sD Free
2 - Not used
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used
Program_Alarm2 1 status Error status information
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used
Program_Alarm3 1 dataLogNameLast Name of the full data log
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used
Program_Alarm4 1 dataLogNameAct Name of the generated data log
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 219
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Alarm block Associated Parameter Description

value
Program_Alarm5 1 dataLogNameDel Name of the deleted data log
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used
Program_Alarm6 1 buffer- Number of deleted data records on
Work.noDeletedItems buffer overflow
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

The alarms can be changed.

The "SD" input parameter is used as an associated value. You can connect the parameters
with additional information that is displayed in the alarm.
The alarms can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization (Page 255)".

SIMATIC Energy Suite V19.0

220 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.2 EnS_ArchiveHMI: Write energy values to data logs

A.2.2.1 Description of EnS_ArchiveHMI

Description
The "EnS_ArchiveHMI" function block (FB) periodic writes energy data from the data block
(DB) for buffering "EnS_BufferDB (Page 265)" to the data log of WinCC Professional/WinCC
Unified. To do this, the "EnS_ArchiveHMI" FB cyclically requests the DB for buffering
"EnS_BufferDB" for available data records with energy data. For existing data records, the
"EnS_ArchiveHMI" function block (FB) sends a request to the Energy Suite WinCC
Professional/WinCC Unified component to retrieve the energy data from the DB for buffering
and write to the data log.

Writing the data logs

The archiving of energy data to data logs is only performed when the following requirements
are met:
• The DB for buffering contains new data records (bufferWork.noItems > 0).
• The DB is available for buffering (bufferWork.busy = FALSE).
• The HMI connection to WinCC Professional/WinCC Unified has been established.
If the requirements are met, the reading of data from the DB is activated for buffering. The
"EnS_ArchiveHMI" FB sends a request to transfer data to WinCC Professional/WinCC Unified.
The request at the "request" parameter with the "EnS_typeHMIWriteCtrl (Page 277)" data type
contains read and write pointers, and the number of data records to be archived.
Then the Energy Suite WinCC Professional/WinCC Unified component reads the data from the
DB for buffering and writes it into the data log. The "statusWrite" parameter of the
"EnS_typeHMIWriteStat (Page 278)" data type contains the number of written data records
and the updated read pointer. During the writing process, the WinCC Professional/WinCC
Unified component, Energy Suite, updates the number of written data records and the write
pointer after every written data record.

Note
Individual instances of "EnS_BufferWrite (Page 231)", "EnS_BufferRead (Page 229)" or WinCC
script can access the data block for buffering. Only read access to the data block is possible at
the same time.
The buffer control and status information of the global DB "EnS_BufferWorkDB (Page 266)"
are provided at the "bufferWork" parameter.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 221
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Watchdog
The connection between the CPU and WinCC Professional/WinCC Unified is monitored using
the watchdog counter. The "EnS_ArchiveHMI" FB sets the watchdog counter at the
"request.watchdog" parameter. The content of the "request.watchdog" parameter is copied to
the "statusWrite.watchdog" parameter.
• If the WinCC Professional/WinCC Unified component, Energy Suite, acknowledges the time
monitoring, the "EnS_ArchiveHMI" FB increments the watchdog counter.
• If no acknowledgment is made within the monitoring time, the error code "16#8606" is
output at the "status" parameter. In addition, an active request is reset and no further
request is sent to the watchdog until the error is eliminated.
An alarm with information about the data loss is generated once the error is eliminated.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 225)" parameter
contains additional error information.
If the WinCC Professional/WinCC Unified component, Energy Suite, does not respond to the
request of the "EnS_ArchiveHMI" FB during the monitoring period and no watchdog error
occurs, the error code "16#8605" is output at the "status (Page 225)" parameter. Once the
waiting period has expired and the request has been successfully fulfilled by the Energy Suite,
WinCC Professional/WinCC Unified, the request is sent again.

SIMATIC Energy Suite V19.0

222 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.2.2 WinCC Professional component

Description
The Energy Suite WinCC Professional/WInCC Unified component writes energy data to the
data log of WinCC Professional/WInCC Unified.

Alarms
If errors occur, the WinCC Professional/WInCC Unified component generates system events in
WinCC Professional/WInCC Unified.
The following table shows the alarms:

Alarm text Alarm class

Archiving error <text list: EnS_Alarms:#status> System
Archiving continues System
Possible data loss System

Reaction to error
If an error occurs, the error code is output with the additional alarm text in the system event
by WinCC Professional/WInCC Unified. The additional alarm text is displayed in the following
table under "Description".
Furthermore, the error codes with additional alarm texts at the
"statusWrite.status"/"statusHMI" parameters of the instance DB of the "EnS_ArchiveHMI"
function block are output to the CPU.
The following table shows the error codes of the WinCC Professional/WInCC Unified
component:

Error code Description Error type Copied to parameter

(W#16#...)
8621 Connection interrupted Time monitoring error statusWrite.status
8622 Access to the data log denied Error writing statusWrite.status
8623 Writing of the energy data to Error writing statusWrite.status
the data log canceled
8624 Possible data loss Data error statusWrite.status
8625 Access to the data block for Data error statusWrite.status
buffering interrupted
8631 Tag not configured Parameter assignment statusWrite.status
error

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 223
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.2.3 Parameters of EnS_ArchiveHMI

The following table shows the function block "EnS_ArchiveHMI":

Parameter Declaration Data type Default Description HMI *

statusWrite Input EnS_typeHMIWriteSt - Status information for writing the en- -
at (Page 278) ergy values to the data log
monitoringTime Input TIME T#5s Monitoring time for writing the energy -
values to the data log
monitoring- Input TIME T#10s Monitoring time for watchdog -
TimeWatchdog
waitTime Input TIME T#1m Waiting time for repeating the request -
to write the energy data to the data log
bufferDB Input DB_ANY - Pointer to data block for buffering -
sD Input VARIANT - Associated value for alarms -
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated -
press
request Output EnS_typeHMIWriteCt - Request for writing the energy data to X
rl (Page 277) data log
busy Output BOOL FALSE TRUE = Writing the energy data to data -
log is enabled
done Output BOOL FALSE TRUE = Writing the energy data to data -
log was successful
error Output BOOL FALSE TRUE = Error -
status Output WORD - Error status information (Page 225) -
statusHMI Output WORD - Error status information -
errorAlarm1 Output BOOL FALSE TRUE = Error "Program_Alarm1" -
statusAlarm1 Output WORD - Error status information of "Pro- -
gram_Alarm1"
alarmState1 Output BYTE - Alarm status of "Program_Alarm1" -
errorAlarm2 Output BOOL FALSE TRUE = Error "Program_Alarm2" -
statusAlarm2 Output WORD - Error status information of "Pro- -
gram_Alarm2"
alarmState2 Output BYTE - Alarm status of "Program_Alarm2" -
errorAlarm3 Output BOOL FALSE TRUE = Error "Program_Alarm3" -
statusAlarm3 Output WORD - Error status information of "Pro- -
gram_Alarm3"
alarmState3 Output BYTE - Alarm status of "Program_Alarm3" -
orgData Output EnS_typeOrgData - Organizational data -
(Page 279)
bufferWork Output EnS_typeBufferWork - buffer control and status information -
(Page 268)

SIMATIC Energy Suite V19.0

224 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.2.4 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8603 Error writing energy Error writing statusHMI Internal error
data to the data log Causes of error:
• HMI connection to the S7-CPU has closed
• Data Log is not available
• Name of the data log is invalid
Procedure:
• No action needs to be taken when an internal
error occurs.
8606 Timeout writing the Error writing statusWrite The period within which the energy data from the
energy data to the .busy / S7 CPU are transferred to the data log has expired.
data log statusWrite Causes of error:
.done /
• Energy Suite SCADA component does not re-
statusWrite-error
spond to the request to write the energy data
within the monitoring time.
• HMI connection to the S7-CPU has closed
• Data loss
8607 Watchdog error Error writing statusWrite.error Internal error
Causes of error:
The Energy Suite SCADA component was not
acknowledged within the monitoring time.
Procedure:
• No action needs to be taken when an internal
error occurs.
8611 Monitoring time < 0 Parameter monitoringTime Internal error
or > 1 hour assignment Causes of error:
error
• Monitoring time is invalid
• Watchdog error has not occurred
Procedure:
• No action needs to be taken when an internal
error occurs.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 225
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8612 Monitoring time for Parameter monitoring- Internal error
watchdog < 0 or > 1 assignment TimeWatchdog Causes of error:
hour error
• The monitoring time for Watchdog is invalid
Procedure:
• No action needs to be taken when an internal
error occurs.
8613 Wait time < 0 or > 1 Parameter waitTime Internal error
hour assignment Causes of error:
error
• Waiting time for repeating the request to write
the energy data to the data log is invalid
Procedure:
• No action needs to be taken when an internal
error occurs.

The additional alarm texts ("Description" column) are written in the "EnS_Alarms" text list of
the "Program_Alarm2" alarm block and are output with the error codes in the alarm.

SIMATIC Energy Suite V19.0

226 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.2.5 Alarms of EnS_ArchiveHMI

The alarms are generated with the instruction "Program_Alarm" A multi-instance of the
"Program_Alarm" data type is created under the "Static" tag of the "EnS_ArchiveHMI" function
block for each alarm. You can find additional information on "Program_Alarm" in the online
help of the TIA Portal information system under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_ArchiveHMI" function block:

Alarm block Alarm text Alarm class

Program_Alarm1 Parameter assignment error With acknowl-
edgment
Program_Alarm2 Archiving error <text list: EnS_Alarms:#status> With acknowl-
edgment
Program_Alarm3 Data loss of <Tag:#bufferWork.noDeletedItems" data records With acknowl-
* edgment

* The "bufferWork.noDeletedItems" parameter contains the number of records that have

been overwritten during the buffer overflow. The data block for buffering is emptied
(bufferWork.noItems = 0) for each buffer overflow.
The additional alarm texts of the "Program_Alarm2" alarm block are written in the
"EnS_Alarms" text list. The error codes (status) are output in the alarm text and contain
additional alarm text of the respective error codes.
The following table shows the error codes with additional alarm texts of the
"Program_Alarm2" alarm blocks:

Alarm block Error code Alarm text Parame- Function block

(W#16#...)* ter
Program_Alarm2 8606 Timeout writing the energy data status EnS_ArchiveHMI
to the data log
8607 Connection to the data log lost EnS_ArchiveHMI

* The error code in the program editor can be displayed as integer or hexadecimal value. You
can find additional information about switching the display format in the online help of the
TIA Portal information system under "Changing display formats in the program status".
The following table shows the alarm blocks with assigned associated values:

Alarm block Associated Parameter Description

value
Program_Alarm1 1 sD Free
2 - Not used
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 227
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Alarm block Associated Parameter Description

value
Program_Alarm2 1 status Error status information
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used
Program_Alarm3 1 buffer- Number of data records overwritten by
Work.noDeletedItems a buffer overflow
2 sD Not used
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

The alarms can be changed.

The "sD" input parameter as an associated value. You can connect the parameters with
additional information that is displayed in the alarm.
The alarms can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization (Page 255)".

SIMATIC Energy Suite V19.0

228 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.3 EnS_BufferRead: Reading energy values from data blocks

A.2.3.1 Description of EnS_BufferRead

Description
The "EnS_BufferRead" function block reads data from the "EnS_BufferDB (Page 265)" data
block.
The "EnS_BufferRead" function block is called internally by the "EnS_ArchiveDataLog
(Page 211)" function block.
The following picture show the circuitry of the parameter:

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 230)" parameter
contains additional error information.

Alarms
The block has no signaling characteristics. Alarms are created by calling function block.

See also
EnS_BufferWorkDB (Page 266)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 229
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.3.2 Parameters of EnS_BufferRead

The following table shows the function block "EnS_BufferRead":

Parameter Declaration Data type Default Description

bufferDB Input DB_ANY - Reference to the data block for buffering
data Output EnS_typeValue - Read data from the buffer
(Page 280)
busy Output BOOL FALSE TRUE = Processing is active
done Output BOOL FALSE TRUE = Data successfully processed
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 230)
bufferWork InOut EnS_typeBufferWork - Buffer monitoring and status information
(Page 268)
request InOut EnS_typeBufferRead - Buffer monitoring information
Ctrl (Page 267)

A.2.3.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8511 Error reading from Error reading buffer- The reading continues until it is successful.
buffer Work.readStat.st Causes of error:
atusReadFct
• Wrong data block is connected or no data block
is present.
Procedure:
• Correct the program.
8512 Data loss * buffer- Causes of error:
Work.noDeletedI
• Data loss after buffer overflow A buffer overflow
tems
occurs when the buffer cannot be cleared, for
example, because the connection to WinCC (for
archiving in WinCC) is interrupted.
Procedure:
• Establish the connection to WinCC.
• Adjust the size of the data block for buffering.

* The "bufferWork.noDeletedItems" parameter contains data records that are overwritten

with a buffer overflow. The number of deleted data records is part of the alarm that is output
by the "EnS_ArchiveDataLog (Page 211)" FB.

SIMATIC Energy Suite V19.0

230 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.4 EnS_BufferWrite: Write energy values to data blocks

A.2.4.1 Description of EnS_BufferWrite

Description
The "EnS_BufferWrite" function block writes data (periodic energy data) to the data block
"EnS_BufferDB (Page 265)".
The "EnS_BufferWrite" is called internally by the "EnS_EnergyDataBasic (Page 250)" block.
"EnS_BufferWrite" is linked to "EnS_BufferWorkDB (Page 266)" ("bufferWork" parameter) for
access control.
The following picture show the circuitry of the parameter:

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 233)" parameter
contains additional error information.

Alarms
The block has no signaling characteristics. Alarms are created by calling function block.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 231
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.4.2 Parameters of EnS_BufferWrite

The following table shows the function block "EnS_BufferWrite":

Parameter Declaration Data type Default Description

bufferDB Input DB_ANY - Reference to the data block for buffering
busy Output BOOL FALSE TRUE = Processing is active
done Output BOOL FALSE TRUE = Data successfully processed
error Ouput BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 233)
bufferWork InOut EnS_typeBufferWork - Buffer monitoring and status information
(Page 268)
request InOut EnS_typeBufferWrite - Buffer monitoring information
Ctrl (Page 270)
energyMeta InOut EnS_typeEnergy- - Measuring point-specific data
Meta (Page 274)

SIMATIC Energy Suite V19.0

232 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.4.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8501 Error writing to the Error writing bufferWork The writing is repeated until it is successful.
buffer .writeStat.status Cause of error:
WriteFct
• Wrong data block is connected or no data block
is present.
Procedure:
• Correct the program.
8502 Alarm: Buffer at bufferWork Cause of error:
100%, loss of data * .noItems /
• Data loss after buffer overflow
bufferWork
.maxItem • A buffer overflow occurs when the buffer can-
not be cleared, for example, because the con-
nection to WinCC (for archiving in WinCC) is
interrupted.
Procedure:
• Make a connection to WinCC (archiving with
WinCC) or eliminate the error (for example,
memory full) on SIMATIC memory card.
8503 Warning: Buffer bufferWork Cause of error:
level above 80%, .noItems /
• The number of ARRAY elements in the data
imminent loss of bufferWork
data block is >= 0.8 * maximum number of ARRAY
.maxItem
elements.
Procedure:
• Increase the ARRAY limits in the properties of
the data block.
8504 Warning: Buffer bufferWork Cause of error:
level above x%, .noItems /
• The number of ARRAY elements in the data
imminent loss of bufferWork
data ** block is < 0.8 * maximum number of ARRAY el-
.maxItems
ements.
Procedure:
• Increase the ARRAY limits in the properties of
the data block.

* The "bufferWork.noDeletedItems" parameter contains data records that are overwritten

with a buffer overflow. The number of deleted data records is part of the alarm that is output
by the "EnS_ArchiveDataLog (Page 211)" FB.
** The warning range is configured under "bufferWork.bufferLimit".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 233
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.5 EnS_CalcEnergyData: Calculating energy values

A.2.5.1 Description of EnS_CalcEnergyData

Description
The "EnS_CalcenergyBasic" function block calculates the energy consumption and the
average power over the individually configured archiving period (e.g. 15 min).
You can connect the block as follows:
• Power input
• Energy input
• Energy and power input

Block structure with connected power input

The graphic below shows the block structure with a connected power input:

Current power
"power.value" is passed to the power output "energyBasic.actPower".
A dead range function can be configured for the calculated power value ("zeroCut"
parameter). If the power value amounts to less than the configured value, the calculated
power value is set to 0. Disable the dead range function by assigning "zeroCut" the value 0.
Current energy
At the start of the new archiving period, the current energy value "actEnergy" and the elapsed
time of archiving period "syncData.syncPeriod" are reset.
"energyBasic.actEnergy" is calculated during the archiving period using the current power
value of the current energy consumption.

SIMATIC Energy Suite V19.0

234 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

The calculated energy value is cyclically added to the current energy value
"energyBasic.actEnergy".
Energy counter value
"energyBasic.actEnergyCounter" and "energyBasic.energyCounter" are set to 0.

Block structure with connected energy input

The following graphic shows the block structure at a connected energy input.

Current energy
The current power consumption "energyBasic.actEnergy" is calculated by subtracting the
current energy counter value "energy.value" from the previous counter value.
At the start of the new archiving period, the current energy value "energyBasic.ectEnergy"
and the elapsed time of the archiving period "syncData.syncPeriod" are reset.
Current power
The current power "energyBasic.actPower" is calculated at the end of the acquisition interval
("baseAcqTime" + "addAcqTime") based on the energy consumption.
Acquisition interval:
The acquisition interval for the power calculation is defined by the "baseAcqTime" and
"addAcqTime" parameters. "baseAcqTime" specifies the minimum acquisition interval.
"addAcqTime" specifies the additional acquisition interval.
The difference of the count is determined between the beginning and end of the acquisition
interval.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 235
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

To calculate the current power, the block waits at least the default acquisition interval
"baseAcqTime". Calculation of the current power "energyBasic.actPower" starts when one of
the requirements is met:
• The count value has changed.
• The additional acquisition interval "addAcqTime" has expired.
• The consumer has been switched off. In this case, the "energy.consumerStatus" parameter
is set to FALSE.
This condition is evaluated only when the consumer status is available
("energyMeta.consumerStatusEnable" = TRUE)
Energy counter value
The current energy counter value "energy.value" is copied to "energyBasic.actEnergyCounter"
and "energyBasic.energyCounter" at the end of the archiving period.

Block structure with connected energy and power input

The graphic below shows the block structure with a connected energy and power input:

Current power
"power.value" is passed to the power output "energyBasic.actPower".
A dead range function can be configured for the calculated power value ("zeroCut"
parameter). If the power value amounts to less than the configured value, the calculated
power value is set to 0. Disable the dead range function by assigning "zeroCut" the value 0.
Current energy
The current energy consumption "energyBasic.actEnergy" is calculated by subtracting the
current counter value "energy.value" from the initial counter value.

SIMATIC Energy Suite V19.0

236 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

At the start of the new archiving period, the current energy value "energyBasic.actEnergy"
and the elapsed time of the archiving period "syncData.syncPeriod" are reset.
Energy counter value
The current energy counter value "energy.value" is copied to "energyBasic.actEnergyCounter"
and "energyBasic.energyCounter" at the end of the archiving period.
Average power / energy consumed
At the end of the archiving period "syncData.syncPeriod", the average power consumption
"energyBasic.power" is calculated from the energy used "energyBasic.energy".
Status
The calculations are only performed if the input value is valid.
The status of the input value is written to the data structures "energy" ("energy.status") and
"power" ("power.status").
If the input value is invalid, the corresponding output parameters are set to 16#FFFF_FFFF .
The status is available for downstream blocks for further logging and evaluations.
Momentary values with the status 16#8301 are valid. However, the values are not suitable
for calculating the consumed energy and the average power consumption in the current
archiving period (for example, 15 minute period).. The values for the average momentary
power consumption and the consumed energy are marked with the status 18#8001 .

Startup
During startup, all values are reset and the timers are restarted.

Note
During an incomplete archiving period, the values are set to the status "16#8301" (bad input
values during the archiving period).

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 238)" parameter
contains additional error information.

Alarms
The block has no signaling characteristics.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 237
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.5.2 Parameters of EnS_CalcEnergyData

The following table shows the function block "EnS_CalcEnergyData":

Parameter Declaration Data type Default Description

power Input EnS_typeAnalog- - Input data power
Value (Page 267)
energy Input EnS_typeEnergy- - Input data energy
Counter (Page 273)
energyBasic Output EnS_typeEnergy- - Basic energy data
Basic (Page 272)
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 238)
orgData InOut EnS_typeOrgData - Organization data
(Page 279)
syncData InOut EnS_typeSync - Synchronization data
(Page 279)
energyMeta InOut EnS_typeEnergy- - Measuring point-specific data
Meta (Page 274)

A.2.5.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8301 Incorrect input val- Hardware energy.status / Internal error
ues during the ar- fault power.status Cause of error:
chiving period
• Error occurred during archiving period and has
already been corrected.
Procedure:
• No action needs to be taken when an internal
error occurs.
8311 Linking error calcu- Connection energy.status / Cause of error:
lation error power.status • The "energy" and "power" parameters are not
interconnected.
Procedure:
• Program the interconnection.

SIMATIC Energy Suite V19.0

238 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8312 Calculation interval Parameter energyMeta Cause of error:
"energyMeta assignment .baseAcqTime
• The duration of the calculation interval is inva-
.baseAcqTime" < 0 error
lid.
Procedure:
• Use valid values for the duration of the calcula-
tion interval: 0 - 3600
8313 Extension of calcula- energyMeta Cause of error:
tion interval .baseAcqTime /
• The duration of the extension of calculation
"energyMeta energyMeta interval is invalid.
.addAcqTime" < 0 .addAcqTime
Procedure:
• Use valid values for the duration of the exten-
sion of calculation interval: 0 - 3600
8314 Limit for zero point energyMeta Cause of error:
"energyMeta .zeroCut
• The value of the limit for the zero point is inva-
.zeroCut" < 0.0
lid.
Procedure:
• Use the valid values for the zero point limit: 0.0 -
3.402823e+38.
8315 "energy.value" >= energy.value / Cause of error:
"energyMeta energyMeta • The energy counter value on the "energy.value"
.overflowCntValue" .overflowCnt-
parameter is greater than or equal to the over-
Value
flow value on the "energyMe-
ta.overflowCntValue" parameter.
• The "overflowCntValue" parameter is not con-
figured correctly (too small).
Procedure:
• Correct the configuration.
• Increase the overflow value.
8316 Normalization factor Parameter energyMeta Cause of error:
"energyMeta assignment .normFactorOut
• The normalization factor at the "energyMe-
.normFactorOut" ≤ error
0.0 or > 9999999.0 ta.normFactorOut" parameter is invalid.
Procedure:
• Use valid values for the normalization factor: 0.0
- 9999999.0.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 239
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.6 EnS_DrvAnalogValue: Acquire power values of the REAL type

A.2.6.1 Description of EnS_DrvAnalogValue

Description
You use the "EnS_DrvAnalogValue" function block to acquire a power value. The input signal
is normalized.
The output value in the "Output" structure is passed to the "EnS_CalcEnergyData (Page 234)"
function block.
When electrical energy is measured, the output value has the "Wh" unit. If no electrical
measured quantity is measured, for example, the flow rate, the output value has the unit
"m³/h", for example.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 241)" parameter
contains additional error information.

A.2.6.2 Parameters of EnS_DrvAnalogValue

The following table shows the function block "EnS_DrvAnalogValue":

Parameter Declaration Data type Default Description

input Input REAL 0.0 Analog input signal
normFactor Input REAL 1.0 Normalization factor
hWFault Input BOOL FALSE TRUE = Hardware error of the input signal
sD Input VARIANT - Associated value for alarm message
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated
press
output Output EnS_typeAnalogValue - Normalized output signal
(Page 267)
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 241)
errorAlarm Output BOOL FALSE TRUE = Error of alarm block "Program_Alarm"
statusAlarm Output WORD - Error status information of the alarm block "Pro-
gram_Alarm"
alarmState Output BYTE - Alarm status of the alarm block "Pro-
gram_Alarm"
orgData InOut EnS_typeOrgData - Organization data
(Page 279)
energyMeta InOut EnS_typeEnergyMeta - Measuring point-specific data
(Page 274)

SIMATIC Energy Suite V19.0

240 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.6.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8001 Hardware fault on Hardware hWFault Causes of error:
measuring device fault
• Bad terminal on measuring device
• Bad address
Procedure:
• Check the connection of the measuring device
or correct the address.
8011 Normalization factor Parameter normFactor Causes of error:
<= 0.0 or > assignment
9999999.0 error • Invalid value at "Normalization factor" setting
Procedure:
• Enter a valid value (0.0 - 9999999.0) for the
"Normalization factor" setting.

A.2.6.4 Alarms of EnS_DrvAnalogValue

The alarms are generated with the instruction "Program_Alarm" You can find additional
information on "Program_Alarm" in the online help of the TIA Portal information system
under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_DrvAnalogValue" function block:

Alarm block Alarm text Alarm class

Program_Alarm Hardware fault With acknowl-
edgment

The alarm can be changed.

The "sD" input parameter as an associated value. You can connect the parameters with
additional information that is to be displayed in the alarm.
The alarm can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization (Page 255)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 241
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.7 EnS_DrvCounterLInt: Acquire energy counter values of the LINT type

A.2.7.1 Description of EnS_DrvCounterLInt

Description
You use the "EnS_DrvCounterLInt" function block to acquire an integral energy meter value of
the type LInt (64-bit). The input signal is converted to a standardized energy counter value.
The output value from the "EnS_CalcEnergyData (Page 234)" function block is processed as an
energy counter value.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 243)" parameter
contains additional error information.

A.2.7.2 Parameters of EnS_DrvCounterLInt

The following table shows the function block "EnS_DrvCounterLInt":

Parameter Declaration Data type Default Description

input Input LINT 0.0 Input counter value
consumerStatus Input BOOL FALSE Consumer status bit: TRUE = On, FALSE = Off
hWFault Input BOOL FALSE TRUE = Hardware error of the input signal
sD Input VARIANT - Associated value for alarm message
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated
press
output Output EnS_typeEnergy- - Output counter value
Counter (Page 273)
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 243)
errorAlarm Output BOOL FALSE TRUE = Error of alarm block "Program_Alarm"
statusAlarm Output WORD - Error status information of the alarm block
"Program_Alarm"
alarmState Output BYTE - Alarm status of the alarm block "Pro-
gram_Alarm"
orgData InOut EnS_typeOrgData - Organization data
(Page 279)
energyMeta InOut EnS_typeEnergy- - Measuring point-specific data
Meta (Page 274)

SIMATIC Energy Suite V19.0

242 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.7.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8001 Hardware error of Hardware hWFault Causes of error:
the input device fault
• Bad terminal on measuring device
• Bad address
Procedure:
• Check the connection of the measuring device
8011 Normalization factor Parameter energyMeta Causes of error:
<= 0.0 or > assignment .normFactorIn
• Invalid value at "Normalization factor" setting
9999999.0 error
Procedure:
• Enter a valid value (0.0 - 9999999.0) for the
"Normalization factor" setting.
8012 Counter overflow energyMeta Causes of error:
value < 1.0 or > .overflowCntVal
1.0e+21 ue • Invalid value at "Overflow value" setting
Procedure:
• Enter a valid value (1.0 - 1.0e+21) for the user-
defined "Overflow value" setting.

A.2.7.4 Alarms of EnS_DrvCounterLInt

The alarms are generated with the instruction "Program_Alarm" You can find additional
information on "Program_Alarm" in the online help of the TIA Portal information system
under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_DrvCounterLInt" function block:

Alarm block Alarm text Alarm class

Program_Alarm Hardware fault With acknowl-
edgment

The alarm can be changed.

The "sD" input parameter as an associated value. You can connect the parameters with
additional information that is to be displayed in the alarm.
The alarm can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization (Page 255)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 243
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.8 EnS_DrvCounterLReal: Acquire energy counter values of the LREAL type

A.2.8.1 Description of EnS_DrvCounterLReal

Description
You use the "EnS_DrvCounterLInt" function block to acquire a floating point energy meter
value of the type LREAL (64-bit). The input signal is converted into a normalized energy value.
The output value from the "EnS_CalcEnergyData (Page 234)" function block is processed as an
energy counter value.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 245)" parameter
contains additional error information.

A.2.8.2 Parameters of EnS_DrvCounterLReal

The following table shows the function block "EnS_DrvCounterLReal":

Parameter Declaration Data type Default Description

input Input LREAL 0.0 Input counter value
consumerStatus Input BOOL FALSE User status bit: 1 = On, 0 = Off
hWFault Input BOOL FALSE FALSE = Hardware error of the input signal
sD Input VARIANT - Associated value for alarm message
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated
press
output Output EnS_typeEnergy- - Output count values
Counter (Page 273)
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 245)
errorAlarm Output BOOL FALSE TRUE = Error of alarm block "Program_Alarm"
statusAlarm Output WORD - Error status information of the alarm block "Pro-
gram_Alarm"
alarmState Output BYTE - Alarm status of the alarm block "Pro-
gram_Alarm"
orgData InOut EnS_typeOrgData - Organization data
(Page 279)
energyMeta InOut EnS_typeEnergy- - Measuring point-specific data
Meta (Page 274)

SIMATIC Energy Suite V19.0

244 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.8.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8001 Hardware fault on Hardware hWFault Causes of error:
measuring device fault
• Bad terminal on measuring device
• Bad address
Procedure:
• Check the connection of the measuring device
or correct the address.
8011 Normalization factor Parameter energyMeta Causes of error:
<= 0.0 or > assignment .normFactorIn
9999999.0 error • Invalid value at "Normalization factor" setting
Procedure:
• Enter a valid value (0.0 - 9999999.0) for the
"Normalization factor" setting.
8012 Counter overflow energyMeta Causes of error:
value < 1.0 or > .overflowCntVal
• Invalid value at "Overflow value" setting
1.0e+21 ue
Procedure:
• Enter a valid value (1.0 - 1.0e+21) for the user-
defined "Overflow value" setting.

A.2.8.4 Alarms of EnS_DrvCounterLReal

The alarms are generated with the instruction "Program_Alarm" You can find additional
information on "Program_Alarm" in the online help of the TIA Portal information system
under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_DrvCounterLReal" function block:

Alarm block Alarm text Alarm class

Program_Alarm Hardware fault With acknowl-
edgment

The alarm can be changed.

The "sD" input parameter as an associated value. You can connect the parameters with
additional information that is displayed in the alarm.
The alarm can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Oganization (Page 255)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 245
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.9 EnS_DrvPulse: Acquiring pulse signals

A.2.9.1 Description of EnS_DrvPulse

Description
The "EnS_DrvPulse" function block adds the acquired pulses, converts them with the
configured normalization factor and calculates an energy counter value of the LREAL type.
The output value from "EnS_CalcEnergyData (Page 234)" is processed as a normalized energy
counter value.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 247)" parameter
contains additional error information.

A.2.9.2 Parameters of EnS_DrvPulse

The following table shows the function block "EnS_DrvPulse":

Parameter Declaration Data type Default Description

input Input BOOL FALSE Pulse input
consumerStatus Input BOOL FALSE User status bit: TRUE = On, FALSE = Off
hWFault Input BOOL FALSE TRUE = Hardware error of the input signal
sD Input VARIANT - Associated value for alarm message
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated
press
output Output EnS_typeEnergy- - Output count values
Counter (Page 273)
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 247)
errorAlarm Output BOOL FALSE TRUE = Error Program_Alarm
statusAlarm Output WORD - Error status information of the "Program_Alarm"
alarm block
alarmState Output BYTE - Alarm status of the "Program_Alarm" alarm
block
orgData InOut EnS_typeOrgData - Organization data
(Page 279)
energyMeta InOut EnS_typeEnergy- - Measuring point-specific data
Meta (Page 274)

SIMATIC Energy Suite V19.0

246 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.9.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8001 Hardware fault on Hardware hWFault Causes of error:
measuring device fault
• Bad terminal on measuring device
• Bad address
Procedure:
• Check the connection of the measuring device
or correct the address.
8011 Normalization factor Parameter energyMe- Causes of error:
<= 0.0 or > assignment ta.normFactorIn
9999999.0 error • Invalid value at "Normalization factor" setting
Procedure:
• Enter a valid value (0.0 - 9999999.0) for the
"Normalization factor" setting.
8012 Counter overflow energyMe- Causes of error:
value < 1.0 or > ta.overflowCntV
• Invalid value at "Overflow value" setting
1.0e+21 alue
Procedure:
• Enter a valid value (1.0 - 1.0e+21) for the user-
defined "Overflow value" setting.

A.2.9.4 Alarms of EnS_DrvPulse

The alarms are generated with the instruction "Program_Alarm" You can find additional
information on "Program_Alarm" in the online help of the TIA Portal information system
under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_DrvPulse" function block:

Alarm block Alarm text Alarm class

Program_Alarm Hardware fault With acknowl-
edgment

The alarm can be changed by the user.

The "sD" input parameter as an associated value. You can connect the parameters with
additional information that is to be displayed in the alarm.
The alarm can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization (Page 255)".

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 247
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.10 EnS_EnergyDataAdv: Providing advanced energy values

A.2.10.1 Description of EnS_EnergyDataAdv

Description
The "EnS_EnergyDataAdv" function block provides advanced energy data record collected
from a measuring point. The function block is used as a central interface to WinCC
Professional or other programs (for example, SIMATIC Energy Manager Pro).

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 248)" parameter
contains additional error information.

Alarms
The block has no signaling characteristics.

A.2.10.2 Parameters of EnS_EnergyDataAdv

The following table shows the block parameters of the "EnS_EnergyDataAdv" block:

Parameter Declaration Data type Default Description HMI *

advData Input EnS_typeEnergyAdv - Advanced measured data record X
(Page 271)
error Output BOOL - TRUE = Error -
status Output WORD - Error status information (Page 248) -
orgData InOut EnS_typeOrgData - Organization data -
(Page 279)
energyMeta InOut EnS_typeEnergyMet - Measuring point-specific data -
a (Page 274)

* The highlighted parameters are assigned the system attribute "Accessible for HMI" and
"Visible for HMI". They are used for operator control and monitoring functions on the HMI
device, for example, for displaying a current value in a faceplate.

A.2.10.3 Parameter status

The "error" output parameter is set when an error occurs in a lower-level function block.
The "status" parameter contains additional error information. The error information is
displayed in the "status" parameter until the error is cleared. Only then is the information
about the next pending error displayed.
The block’s output parameter "status" represents the status value of advanced data collected
from hardware driver blocks (linked to input advData.status).

SIMATIC Energy Suite V19.0

248 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.11 EnS_EnergyDataAdvMinMax: Providing advanced minimum and maximum

values

A.2.11.1 Description of EnS_EnergyDataAdvMinMax

Description
The "EnS_EnergyDataAdvMinMax" function block provides minimum and maximum values of
the advanced energy data for the output, for example, in WinCC Professional.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The error information of the lower-
level function block (from measurement hardware, for example) are output at the "status
(Page 249)" output. The error information is displayed in the "status" parameter until the
error is cleared. Only then is the information about the next pending error displayed.

Alarms
The block has no signaling characteristics.

A.2.11.2 Parameters of EnS_EnergyDataAdvMinMax

The following table shows the function block "EnS_EnergyDataAdvMinMax":

Parameter Declaration Data type Default Description HMI *

advDataMin Input EnS_typeEnergyAdv - Data record with minimum values of X
(Page 271) the advanced energy values
advDataMax Input EnS_typeEnergyAdv - Data record with maximum values of X
(Page 271) the advanced energy values
error Output BOOL - TRUE = Error
status Output WORD - Error status information (Page 249)
orgData InOut EnS_typeOrgData - Organizational data
(Page 279)
energyMeta InOut EnS_typeEnergy- - Process tag specific data
Meta (Page 274)

* The selected parameters receive the system attribute "Available for HMI" and "Visible in
HMI". They are used for operator control and monitoring functions on the HMI device, for
example, for displaying a current value in the faceplate.

A.2.11.3 Parameter status

The "error" output parameter is set when an error occurs in a lower-level function block.
The "status" parameter contains additional error information. The error information is
displayed in the "status" parameter until the error is cleared. Only then is the information on
the next pending error displayed.
The block’s output parameter "status" represents the status value of advanced data collected
from hardware driver blocks (linked to inputs advDataMin.status and advDataMax.status).

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 249
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.12 EnS_EnergyDataBasic: Providing metadata and energy values

A.2.12.1 Description of EnS_EnergyDataBasic

Description
The "EnS_EnergyDataBasic" function block provides basic metadata and energy data record
collected from a measuring point. The function block is used as a central interface to WinCC
Professional or other programs (for example, SIMATIC Energy Manager Pro).

Metadata
The metadata at the "energyMeta" parameter with the "EnS_typeEnergyMeta (Page 274)"
data type contains general information about the acquistion object or the measurement
hardware.

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 252)" parameter
contains additional error information.

A.2.12.2 Parameters of EnS_EnergyDataBasic

The following table shows the function block "EnS_EnergyDataBasic":

Parameter Declaration Data type Default Description HMI *

energyMeta Input EnS_typeEnergyMet - Measuring point-specific data X
a (Page 274)
energyBasic Input EnS_typeEnergyBasi - Basic energy data X
c (Page 272)
bufferDB Input DB_ANY - Pointer to the data block for buffering -
sD Input VARIANT - Associated value for alarm messages -
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated X
press
error Output BOOL FALSE TRUE = Error -
status Output WORD - Error status information (Page 252) -
status1 Output WORD - Error status information 1 -
status2 Output WORD - Error status information 2 -
status3 Output WORD - Error status information 3 -
status4 Output WORD - Error status information 4 -
status5 Output WORD - Error status information 5 -
errorAlarm1 Output BOOL FALSE TRUE = Error Program_Alarm1 -

SIMATIC Energy Suite V19.0

250 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Parameter Declaration Data type Default Description HMI *

statusAlarm1 Output WORD - Error status information Pro- -
gram_Alarm1
alarmState1 Output BYTE - Alarm status Program_Alarm1 -
errorAlarm2 Output BOOL FALSE TRUE = Error Program_Alarm2 -
statusAlarm2 Output WORD - Error status information Pro- -
gram_Alarm2
alarmState2 Output BYTE - Alarm status Program_Alarm2 -
errorAlarm3 Output BOOL FALSE TRUE = Error Program_Alarm3 -
statusAlarm3 Output WORD - Error status information Pro- -
gram_Alarm3
alarmState3 Output BYTE - Alarm status Program_Alarm3 -
errorAlarm4 Output BOOL FALSE TRUE = Error Program_Alarm4 -
statusAlarm4 Output WORD - Error status information Pro- -
gram_Alarm4
alarmState4 Output BYTE - Alarm status Program_Alarm4 -
errorAlarm5 Output BOOL FALSE TRUE = Error Program_Alarm5 -
statusAlarm5 Output WORD - Error status information Pro- -
gram_Alarm5
alarmState5 Output BYTE - Alarm status Program_Alarm5 -
orgData InOut EnS_typeOrgData - Organization data -
(Page 279)
bufferWork InOut EnS_typeBufferWork - Buffer monitoring and status infor- -
(Page 268) mation

* The selected parameters receive the system attribute "Available for HMI" and "Visible in
HMI". They are used for operator control and monitoring functions on the HMI device, for
example, for displaying a current value in the faceplate.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 251
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.12.3 Parameter status

The error information of the lower-level function blocks (for example, "EnS_TimeSync") are
added to the "status1", "status5" output parameter. The error information is displayed in the
"status" parameter until the error is cleared. Only then is the information of the next pending
error displayed.
The error information of the "EnS_EnergyDataBasic" block and its subordinates listed below
are added to the output parameters "Status1" to "Status3".

Status Message text Parameter Function blocks

16#801x Hardware Status1 EnS_Drvxxx
16#821x Time synchronization EnS_TimeSync
16#831x Calculation EnS_CalcEnergyData
16#8311 Linking error calculation
16#800x Hardware fault Status2 EnS_Drvxxx
16#8201 External synchronization signal lost EnS_TimeSync
16#8202 External synchronization signal not within valid
time range
16#8203 Time leap synchronization time
16#8501 Error writing to the buffer Status3 EnS_WriteBuffer
16#8502 Alarm: Buffer at 100%, loss of data
16#8503 Warning: Buffer level above 80%, imminent loss
of data
16#8504 Reserved (Warning: Buffer level above x %, immi-
nent loss of data) *
16#8512 Possible data loss EnS_ReadBuffer

*The warning level can be configured in EnS_BufferWork.BufferLimit.

A.2.12.4 Alarms of EnS_EnergyDataBasic

The alarms are generated with the instruction "Program_Alarm" You can find additional
information on "Program_Alarm" in the online help of the TIA Portal information system
under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_EnergyDataBasic" function block:

Alarm block Alarm text Alarm class

Program_Alarm1 Parameter assignment error <text list: EnS_Alarms:#status1> With acknowl-
edgment
Program_Alarm2 <Text list: EnS_Alarms:#status2> With acknowl-
edgment
Program_Alarm3 Archiving error <text list: EnS_Alarms:#status3>. With acknowl-
edgment
Program_Alarm4 Reserved (warning for limit violation) With acknowl-
edgment
Program_Alarm5 Reserved (warning for limit violation) With acknowl-
edgment

SIMATIC Energy Suite V19.0

252 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

The additional alarm texts are written in the "EnS_Alarms" text list. The output parameters
<"status1" to "status5" contain the value for the error information of the
"EnS_EnergyDataBasic" FB and its lower-level FBs.

Alarm block Error code Alarm text Parame- Function block

(W#16#...) ter
Program_Alarm1 801x Hardware status1 EnS_Drvxxx
821x Time synchronization EnS_TimeSync
(Page 256)
831x Calculation EnS_CalcEnergy-
8311 Linking error calculation Data (Page 234)
Program_Alarm2 800x Hardware fault status2 EnS_Drvxxx
8201 External synchronization signal EnS_TimeSync
lost (Page 256)
8202 External synchronization signal
not within valid time range
8203 Time leap synchronization time
ProgramAlarm3 8501 Error writing to the buffer status3 EnS_BufferWrite
8502 Alarm: Buffer at 100%, loss of (Page 231)
data
8503 Warning: Buffer level above
80%, imminent loss of data
8504 Warning: Buffer level above x%,
imminent loss of data
8512 Possible data loss EnS_BufferRead
(Page 229)

The associated values are assigned as follows:

Alarm block Associated Parameter Meaning

value
Program_Alarm1 1 status1 Error status information 1
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used
Program_Alarm2 1 status2 Error status information 2
2 sD Free
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 253
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Alarm block Associated Parameter Meaning

value
Program_Alarm3 1 status3 Error status information 3
2 Reserved* Reserved
3 sD Free
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

* The associated values are reserved for future use.

The alarm can be changed.
The "sD" input parameter as an associated value. You can connect the parameters with
additional information that is displayed in the alarm.
The alarm can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization (Page 255)".

SIMATIC Energy Suite V19.0

254 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.13 EnS_Organization: Providing organizational data

A.2.13.1 Description of EnS_Organization

Description
The "EnS_Organization" function block provides central organizational data that is accessed
by other function blocks. The block must be called once by each cyclic interrupt OB.
The block manages the following data:
• Start-up flag ("orgData.startup")
The startup flag is a parameter of the BOOL type. The parameter is at the "orgData.startup"
output parameter of the "EnS_Organization" function block. The function block uses this
parameter to signal if the program is still in the startup phase. You set the number of
cycles for the startup phase at the input parameter "runUpCyc" of the function block. The
default is a startup phase of ten cycles.
• Alarm suppression ("orgData.messageSuppress")
You can use the parameter to specify if messages from the user program of the CPU are to
be suppressed.
• Momentary time stamp (UTC) of the CPU
The momentary time stamp corresponds to the CPU system time.

Startup
The block sets the "orgData.startup" output parameter for the number of configured startup
cycles "runUpCyc" and suppresses the alarms using the "orgData.messageSuppress"
parameter.

Reaction to error
When an error occurs, the output parameter "error" is set. The "status" parameter contains
additional error information.

Alarms
The block has no signaling characteristics.

A.2.13.2 Parameters of EnS_Organization

The following table shows the function block "EnS_Organization":

Parameter Declaration Data type Default Description

runUpCyc Input UINT 10 Number of start-up cycles
messageSup- Input BOOL FALSE TRUE = Alarm suppression activated
press
orgData Output EnS_typeOrgData - Organization data
(Page 279)
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 255
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.14 EnS_TimeSync: Synchronize timers

A.2.14.1 Description of EnS_TimeSync

Description
The block is used as a central clock to synchronize the block for energy acquisition
"EnS_CalcEnergyData (Page 234)".
The clock pulse can be specified as follows:
The "syncData.syncPulse" clock generator is triggered once per archiving period by an
external synchronization pulse "extSyncPulse", for example, from a power supply company, or
the internal CPU time. The block evaluates the from rising edge of the synchronization pulse.
The time stamp for the synchronization pulse at the "syncData.syncTimeStamp" parameter is
rounded up or down to the nearest whole time value, for example, 15 minutes.
The synchronization pulse is only acquired within a specified range of validity. You define the
range of validity with the "validTimeRange" block parameter. Tolerance can be set for a
premature synchronization pulse. Premature synchronization pulses are still considered valid
if they are acquired up to one CPU cycle too early. Premature synchronization pulses depend
on the cycle time of the cyclic interrupt OB in which the "EnS_TimeSync" block is called.
If the cyclic interrupt OB is called once per second, the external synchronization pulse must
be set no earlier than the 59th second.
If the cyclic interrupt OB is called twice per second, the external synchronization pulse must
be set no earlier than the 58th second.
If the external synchronization pulse is set too early by a power supply company, the
synchronization pulse of the block is not set and the error status 16#8202 is set.
Invalid pulses are identified by the status "16#8202" and acknowledged with a message.
• External synchronization "extEnable" = TRUE
Examples:
– External synchronization pulse "extSyncPulse" set to early:
External synchronisation pulse momentary CPU time stamp between the
"validTimeRange" and the next period is less than the calculation interval of the
function block. In this case, the synchronization time stamp is rounded up to the
nearest whole value of the period.
Calculation interval: 1 s
Period: 15 min
Current CPU time: 6:59:59:500
Synchronization time stamp: 7:00:00:000

SIMATIC Energy Suite V19.0

256 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

– External synchronization pulse "extSyncPulse" set to late:

The time period between the current CPU time stamp and the last period is less than
the "validTimeRange". In this case, the synchronization time stamp is rounded down to
the last whole value of the period.
Calculation interval: 1 s
Period: 15 min
Scope: 10 s
Current CPU time 7:00:00:001
Synchronization time stamp: 7:00:00:000
– External synchronization pulse "extSyncPulse" is out of range:
The time period between the current CPU time stamp and the last period is greater
than the "validTimeRange". In this case, the synchronization time stamp is discarded
and an error message (status = 16#8202) appears.
Calculation interval: 1 s
Period: 15 min
Scope: 10 s
Current CPU time: 7:00:20:000
Synchronization time stamp: Error message (status = 16#8202)
• Set the "syncPeriod" parameter
If external synchronization is disabled "extEnable" = FALSE, the "syncPeriod" parameter
contains the period of time for the synchronization, for example, 15 minutes.
• The archiving of energy data behaves as follows when a synchronization pulse is missing:
– The energy data for archiving period is calculated until the synchronization pulse is set.
– The power values are averaged over the complete archiving period beginning with the
last synchronization pulse.
– The energy count values are accumulated over the complete archiving period
beginning with the last synchronization pulse.
Time stamps are output as UTC (Coordinated Universal Time).
You can create multiple instances of this block, and thereby produce more archiving periods.
The usual periods are 15 minutes for electrical energy and 60 minutes for non-electrical
media.

Startup
During startup, the internally running timers are restarted.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 259)" parameter
contains additional error information.

Alarms
The block has no signaling characteristics.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 257
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.14.2 Parameters of EnS_TimeSync

The following table shows the function block "EnS_TimeSync":

Parameter Declaration Data type Default Description

extEnable Input BOOL FALSE TRUE = Enable for external synchronization
extSyncPulse Input BOOL FALSE External synchronization pulse
syncPeriod Input TIME T#15m Archiving period
pulseTime Input TIME T#2s Duration of the synchronization pulse
validTimeRange Input TIME T#10s Scope for the external synchronization pulse
monitoring- Input TIME T#2s Reserved
TimeExtSync
modeExtSync Input BOOL FALSE Reserved
offsetUTCToLo- Input TIME T#0s Offset of UTC Coordinated Universal Time from
calTime the local time
validTime- Input TIME T#10s Valid time range difference for NTP time syn-
RangeNTP chronization
syncData Output EnS_typeSync - Synchronization data
(Page 279)
curTimeStamp Output DT - Momentary time stamp at block call
error Output BOOL FALSE TRUE = Error
status Output WORD - Error status information (Page 259)
orgData InOut EnS_typeOrgData - Organization data
(Page 279)
resetEr- InOut BOOL FALSE Reserved
rorExtSync

SIMATIC Energy Suite V19.0

258 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.14.3 Parameter status

The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8201 The external syn- Hardware extSyncPulse Causes of error:
chronization pulse fault
• External synchronization pulse lost
extSyncPulse was
lost during the Procedure:
syncPeriod archiving • Check the hardware address of the pulse.
period.
• If the external pulse is unreliable, use the inter-
nal time synchronization (CPU time as clock).
8202 The external syn- extSyncPulse / Causes of error:
chronization pulse validTimeRange
• External synchronization pulse was set outside
extSyncPulse was
not set within the the range of validity.
validTimeRange The default setting for the range of validity is 10 s .
range of validity. Procedure:
• If the external pulse is unreliable, use the inter-
nal time synchronization (CPU time as clock).
8203 The time interval of Time error curTimeStamp / Internal error
the current time syncPeriod Causes of error:
stamp is longer than
the duration of the • The time interval of the current time stamp is
syncPeriod archiving longer than the duration of the archiving period.
period. Procedure:
• If the external pulse is unreliable, use the inter-
nal time synchronization (CPU time as clock).
8204 NTP time synchroni- Time error curTimeStamp / Internal error
zation has occurred syncPeriod Causes of error:
• PLC CPU time has synchronized with NTP server

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 259
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8211 The duration of the Parameter syncPeriod / Causes of error:
syncPeriod archiving assignment pulseTime
• The duration of the synchronization pulse is
period is shorter error
than: longer than the duration of the archiving period
or longer than 1 minute.
• Duration of the
Procedure:
synchronization
pulse pulseTime • If the external pulse is unreliable, use the inter-
or nal time synchronization (CPU time as clock).
• 1 minute
8212 The duration of the syncPeriod Causes of error:
syncPeriod archiving
• The duration of the syncPeriod archiving period
period is longer than
one day (24 hours). is longer than one day (24 hours).
Procedure:
• Enter a valid value (1 min - 24 h) at the setting
for the duration of the archiving period.
8213 The duration of the syncPeriod Causes of error:
syncPeriod archiving
• The duration of the syncPeriod archiving period
period is not an
integer value. is not an integer value.
Procedure:
• Enter a valid value (integer) at the setting for
the duration of the archiving period.
8214 The duration of the syncPeriod Causes of error:
syncPeriod archiving
• The duration of the syncPeriod archiving period
period is not an
integer part of one is not an integer part of one hour/one day.
hour/one day. Procedure:
The following are • Enter a valid value at the setting for the duration
valid, for example:
of the archiving period.
• 1 minute
• 5 minutes
• 15 minutes
• 12 hours
The following are
invalid, for example:
• 7 minutes
• 11 minutes
• 5 hours

SIMATIC Energy Suite V19.0

260 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

Error code Description Error type Copied to pa- Solution

(W#16#...) rameter
8215 The offset of the extSyncPulse Causes of error:
standard UTC time
• The offset of the UTC to the local time is not a
to the local time is
not a multiple of 15 multiple of 15 minutes or shorter than
minutes or shorter 15 minutes.
than 15 minutes. Procedure:
The following are
• Enter a valid value for the offset of the standard
valid, for example:
UTC time to the local time.
• 1 hour
• 4 hours
• 30 minutes
The following are
invalid, for example:
• 10 minutes
• 25 minutes

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 261
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.14.4 Alarms of EnS_TimeSync

The alarms are generated with the instruction "Program_Alarm" You can find additional
information on "Program_Alarm" in the online help of the TIA Portal information system
under "Extended instructions > Alarms".
The following table shows the alarms of the "EnS_TimeSync" function block:

Alarm block Alarm text Alarm class

Program_Alarm <Keyword: CpuName> : <Text list: With acknowledgment
EnS_Alarms: #status

The additional alarm texts are written in the "EnS_Alarms" text list. The output parameters
"status" contain the value for the error information of the "EnS_TimeSync" FB and its lower-
level FBs.

Alarm block Error code (W#16#...) Alarm text Parameter Function block
Program_Alarm 8204 PLC time synchroniza- status EnS_TimeSync
tion has occured.
Difference in time was
@2%f@ sec

The associated values are assigned as follows:

Alarm block Associated value Parameter Meaning

Program_Alarm 1 status Error status information
2 sD Not used
3 - Not used
4 - Not used
5 - Not used
6 - Not used
7 - Not used
8 - Not used
9 - Not used
10 - Not used

The alarms can be changed.

The "SD" input parameter is used as an associated value. You can connect the parameters
with additional information that is displayed in the alarm.
The alarms can be suppressed with "messageSuppress" or overridden with
"orgData.messageSuppress" of the function block "EnS_Organization".

SIMATIC Energy Suite V19.0

262 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.15 EnS_EnergyDataAdd: Linking the additional data

A.2.15.1 Description of EnS_EnergyDataAdd

Description
The EnS_EnergyDataAdd block is generated upon program generation when 'Activate
additional energy data' is enabled for acquisition object. This allows additional energy data to
link to the interface blocks. The EnS_EnergyDataAdd function block collects the additional
energy data and acts as an interface to an HMI device.
User can link up to 12 values to the input parameter 'addDataUserInput'. And parameter
'setError' can also be linked by user to indicate error in fetching additional values.
During program generation the interface blocks (<Acquisition object name>_Add) for each
acquisition object will be referred in the FC EnS_InterfaceAdd_CycInt200msFC.
Recommendations for linking additional values:
1. User program for linking of values to be called in 200ms OB as interface block is called in
200ms OB.
2. Linking to be done in program outside Energy Suite program folder to avoid loss of user
program on regeneration of energy program.
Example for linking value:

Startup
The block has no startup characteristics.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 264)" parameter
contains additional error information.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 263
Energy Suite blocks - Acquisition
A.2 Function blocks (FBs)

A.2.15.2 Parameters of EnS_EnergyDataAdd

The following table shows the block parameters of the "EnS_EnergyDataAdd" block:

Parameter Declaration Data type Default Description

addDataUserInput Input EnS_typeEnergyAdd - Additional energy

data linked by user

setError Input Bool FALSE 1=Error in fetching

additional data
addDataOut Output EnS_typeEnergyAdd Additional energy
data output
error Output Bool FALSE 1=Error
status Output Word 16#0 Error status infor-
mation
orgData InOut EnS_typeOrgData Superordinate
organization data
energyMeta InOut EnS_typeEnergyMeta Energy meta data

A.2.15.3 Parameter status

The "error" output parameter is set when an error occurs in a lower-level function block. The
output error is true when ‘setError’ is True.
The "status" parameter contains additional error information. The error information is
displayed in the "status" parameter until the error is cleared. Only then is the information
about the next pending error displayed.

Status Meaning
16#7001 No error, ‘error’ = false
16#8000 Error present, ‘setError’ input = true

SIMATIC Energy Suite V19.0

264 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.3 Data blocks (DBs)

A.3 Data blocks (DBs)

A.3.1 EnS_BufferDB

A.3.1.1 Description of EnS_BufferDB

Description
The global data block "EnS_BufferDB" contains periodically acquired energy data in an array.
The energy data is written by the "EnS_EnergyDataBasic (Page 250)" function block to the
"EnS_BufferDB" data block. For this, the "EnS_BufferWrite (Page 231)" function block is called
internally by the "EnS_EnergyDataBasic" function block.
The energy data is read from the "EnS_BufferDB" data block by the "EnS_ArchiveDataLog
(Page 211)" function block or the Energy Suite SCADA component. For this, the
"EnS_BufferRead (Page 229)" function block is called internally by the "EnS_ArchiveDataLog"
function block.
You can adjust the size of arrays according to your requirements and the memory capacity of
the CPU. To do this, set the number of desire ARRAY elements in the properties of the
"EnS_BufferDB" data block. In the "EnS_BufferWorkDB (Page 266)" block, you also set a
number of other parameters, for example, a fill level warning.
Each array element corresponds to the value of the type "EnS_typeValue (Page 280)". Four
more values are contained in it
• Tag name
• Value
• Time stamp
• Status
You can add several data blocks to a CPU as long as the CPU has enough free memory
available for buffering. A pair always includes two data blocks, "EnS_BufferDB" and
"EnS_BufferWorkDB".

A.3.1.2 Structure of EnS_BufferDB

The following table shows the structure of the data block "EnS_BufferDB":

Element Data type Description

EnS_BufferDB ARRAY[0..n] of "EnS_typeValue" n+1 elements of calculated data
values

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 265
Energy Suite blocks - Acquisition
A.3 Data blocks (DBs)

A.3.2 EnS_BufferWorkDB

A.3.2.1 Description of EnS_BufferWorkDB

Description
The "EnS_BufferWorkDB" data block is a global data block of the type "EnS_typeBufferWork
(Page 268)". The data block contains the control and status information of the buffer DB
"EnS_BufferDB (Page 265)". The values of the "EnS_BufferWorkDB" data block are evaluated
and described internally by the "EnS_BufferRead (Page 229)" and "EnS_BufferWrite
(Page 231)" function blocks for the coordination of the read and write access to the buffer DB
"EnS_BufferDB".

A.3.2.2 Structure of EnS_BufferWorkDB

The following table shows the structure of the data block "EnS_BufferWorkDB":

Element Data type Description

EnS_BufferWorkDB EnS_typeBufferWork (Page 268) Buffer monitoring and status
information

SIMATIC Energy Suite V19.0

266 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4 User-defined data types (UDTs)

A.4.1 EnS_typeAnalogValue

A.4.1.1 Description of EnS_typeAnalogValue

Description
The "EnS_typeAnalogValue" PLC data type describes the interface between the function block
for analog inputs ".EnS_DrvAnalogValue (Page 240)" and the function block for periodic
calculation of energy data "EnS_CalcEnergyData (Page 234)".

A.4.1.2 Structure of EnS_typeAnalogValue

The following table shows the parameters of the "EnS_typeAnalogValue" PLC data type:

Parameter Data type Default Description

value REAL 0.0 Process value
status WORD 16#FFFF Status of the process value

A.4.2 EnS_typeBufferReadCtrl

A.4.2.1 Description of EnS_typeBufferReadCtrl

Description
The "EnS_typeBufferReadCtrl" PLC data type contains the required control information for
reading data from the data block for buffering "EnS_BufferDB (Page 265)".

A.4.2.2 Structure of EnS_typeBufferReadCtrl

The following table shows the parameters of the "EnS_typeBufferReadCtrl" PLC type data:

Parameter Data type Default Description

req BOOL FALSE Request to read data from the
data block for buffering
"EnS_BufferDB (Page 265)"

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 267
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.3 EnS_typeBufferReadStat

A.4.3.1 Description of EnS_typeBufferReadStat

Description
The "EnS_typeBufferReadStat" PLC data type contains the data to be read and the status
information for reading from the data block for buffering "EnS_BufferDB (Page 265)".

A.4.3.2 Structure of EnS_typeBufferReadStat

The following table shows the parameters of the "EnS_typeBufferReadStat" PLC data type:

Parameter Data type Default Description

data EnS_typeValue - Data read from the buffer
(Page 280)
busy BOOL FALSE TRUE = Processing is active
done BOOL FALSE TRUE = Data successfully pro-
cessed
error BOOL FALSE TRUE = Error reading
status WORD 16#0000 Status of the buffer
statusReadFct WORD 16#0000 Status of "ReadFromArrayDB"

A.4.4 EnS_typeBufferWork

A.4.4.1 Description of EnS_typeBufferWork

Description
The "EnS_typeBufferWork" PLC data type contains all the control and status information for
writing and reading data in the data block for buffering "EnS_BufferDB (Page 265)".

SIMATIC Energy Suite V19.0

268 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.4.2 Structure of EnS_typeBufferWork

The following table shows the parameters of the "EnS_typeBufferWork" PLC data type:

Parameter Data type Default Description

readCtrl EnS_typeBufferReadCtrl - Control information of the buffer
(Page 267) for reading data
readStat EnS_typeBufferReadStat - Data and status information of the
(Page 268) buffer for reading data
writeCtrl EnS_typeBufferWriteCtrl - Control information of the buffer
(Page 270) for writing data
writeStat EnS_typeBufferWriteStat - Status information of the buffer
(Page 270) for writing data
busy BOOL FALSE TRUE = Processing is active
done BOOL FALSE TRUE = Data successfully pro-
cessed
error BOOL FALSE TRUE = Error in data processing
status WORD 16#0000 Status of the buffer
maxItem UDINT 0 Maximum number of data records
of "EnS_BufferDB"
maxItemRead UDINT 0 Reserved
maxCycleWrite UDINT 30 Maximum number of cycles for
writing data
cycleWrite UINT 0 Number of cycles for writing data
noItems UDINT 0 Number of written data records
from "EnS_BufferDB"
noDeletedItems UDINT 0 Number of deleted data records
from "EnS_BufferDB" with a buffer
overflow
writeItem DINT 0 Write cursor on the data record
readItem DINT 0 Read cursor on the data record
bufferLimit UINT 20 Configurable buffer limit for warn-
ings in [%] (validity range 1-79).
Starting at an 80% fill level of the
buffer, an error status is displayed
by default (see also
"EnS_BufferWrite (Page 231)").

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 269
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.5 EnS_typeBufferWriteCtrl

A.4.5.1 Description of EnS_typeBufferWriteCtrl

Description
The "EnS_typeBufferWriteCtrl" PLC data type contains the periodic energy data to be written
to the data block for buffering "EnS_BufferDB (Page 265)" and the required control
information (for example, query) for writing data.

A.4.5.2 Structure of EnS_typeBufferWriteCtrl

The following table shows the parameters of the "EnS_typeBufferWriteCtrl" PLC data type:

Parameter Data type Default Description

req BOOL FALSE Request to write data to the buff-
er.
data EnS_typeValue - Periodic energy data that are writ-
(Page 280) ten to the buffer.

A.4.6 EnS_typeBufferWriteStat

A.4.6.1 Description of EnS_typeBufferWriteStat

Description
The "EnS_typeBufferWriteStat" PLC data type contains status information for writing periodic
energy data to the data block for buffering "EnS_BufferDB (Page 265)".

A.4.6.2 Structure of EnS_typeBufferWriteStat

The following table shows the parameters of the "EnS_typeBufferWriteStat" PLC data type:

Parameter Data type Default Description

busy BOOL FALSE TRUE = Processing is active
done BOOL FALSE TRUE = Data successfully pro-
cessed
error BOOL FALSE TRUE = Error in data processing
status WORD 16#0000 Status of the buffer
statusWriteFct WORD 16#0000 Write status

SIMATIC Energy Suite V19.0

270 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.7 EnS_typeEnergyAdv

A.4.7.1 Description of EnS_typeEnergyAdv

Description
The "EnS_typeEnergyAdv" PLC data type contains advanced energy data which are read from
measuring instruments and provided to a CPU or HMI system.

A.4.7.2 Structure of EnS_typeEnergyAdv

The following table shows the parameters of the "EnS_typeEnergyAdv" PLC data type:

Parameter Data type Default Description

voltage1N REAL 0.0 Momentary voltage between
phase 1 and N
voltage2N REAL 0.0 Momentary voltage between
phase 2 and N
voltage3N REAL 0.0 Momentary voltage between
phase 3 and N
voltage12 REAL 0.0 Momentary voltage between
phase 1 and 2
voltage23 REAL 0.0 Momentary voltage between
phase 2 and 3
voltage31 REAL 0.0 Momentary voltage between
phase 3 and 1
current1 REAL 0.0 Momentary current at phase 1
current2 REAL 0.0 Momentary current at phase 2
current3 REAL 0.0 Momentary current at phase 3
frequency REAL 0.0 Momentary frequency
powerFactor1 REAL 0.0 Current power factor of Phase 1
powerFactor2 REAL 0.0 Current power factor of Phase 2
powerFactor3 REAL 0.0 Current power factor of Phase 3
totalPowerFactor REAL 0.0 Momentary total power factor
appPower1 REAL 0.0 Current apparent power of Phase
1
appPower2 REAL 0.0 Current apparent power of Phase
2
appPower3 REAL 0.0 Current apparent power of Phase
3
totalAppPower REAL 0.0 Momentary total apparent power
actPower1 REAL 0.0 Current active power of Phase 1
actPower2 REAL 0.0 Current active power of Phase 2
actPower3 REAL 0.0 Current active power of Phase 3
totalActPower REAL 0.0 Momentary total active power
reactPower1 REAL 0.0 Current reactive power of Phase 1
reactPower2 REAL 0.0 Current reactive power of Phase 2
reactPower3 REAL 0.0 Current reactive power of Phase 3

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 271
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

Parameter Data type Default Description

totalReactPower REAL 0.0 Momentary total reactive power
totalAppEnergy LREAL 0.0 Momentary total apparent energy
totalActEnergy LREAL 0.0 Momentary total active energy
totalReactEnergy LREAL 0.0 Momentary total reactive energy
status WORD 16#FFFF Status of the extended data

A.4.8 EnS_typeEnergyBasic

A.4.8.1 Description of EnS_typeEnergyBasic

Description
The "EnS_typeEnergyBasic" PLC data type contains basic energy data that are provided for a
CPU, an HMI system and archiving, for example:
• Periodically calculated energy consumption
• Average power over the period
• Current values for energy and power consumption

A.4.8.2 Structure of EnS_typeEnergyBasic

The following table shows the parameters of the "EnS_typeEnergyBasic" PLC data type:

Parameter Data type Default Description

actEnergy REAL 0.0 Momentary energy value
actPower REAL 0.0 Momentary power value
actEnergyCounter LREAL 0.0 Current energy counter value
actStatus WORD 16#FFFF Status of actual values
energy REAL 0.0 Cumulative energy value at the
end of the archiving period
power REAL 0.0 Average power value at the end of
the archiving period
energyCounter LREAL 0.0 Energy counter value at the end of
the archiving period
status WORD 16#FFFF Status of the cumulative energy
and average power
syncData EnS_typeSync - Synchronization data
(Page 279)

SIMATIC Energy Suite V19.0

272 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.9 EnS_typeEnergyCounter

A.4.9.1 Description of EnS_typeEnergyCounter

Description
The "EnS_typeEnergyCounter" PLC data type contains an interface between the driver
function block for energy counter values "EnS_DrvCounterLInt (Page 242)",
"EnS_DrvCounterLReal (Page 244)" and the function block for the periodic calculation of
energy data "EnS_CalcEnergyData (Page 234)".

A.4.9.2 Structure of EnS_typeEnergyCounter

The following table shows the parameters of the "EnS_typeEnergyCounter" PLC data type:

Parameter Data type Default Description

value LREAL 0.0 Energy counter value
normValue LREAL 0.0 Normalized energy count value
consumerStatus BOOL FALSE Consumer status: TRUE = On,
FALSE = Off
status WORD 16#FFFF Status of the energy value

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 273
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.10 EnS_typeEnergyMeta

A.4.10.1 Description of EnS_typeEnergyMeta

Description
The "EnS_typeEnergyMeta" PLC data type contains information about the measuring point.
The information is used for display in the CPU or in an HMI system.

A.4.10.2 Structure of EnS_typeEnergyMeta

The following table shows the parameters of the "EnS_typeEnergyMeta" PLC data type:

Parameter Data type Default Value range Description HMI 1)

name STRING[32] "" - Energy acquisition name X
plantIdentCode STRING[128] "" - Plant designation -
localIdentCode STRING[128] "" - Location identifier -
techUnitId DWORD 0 0 = Not configured ID for technological unit -
deviceId DWORD 0 0 = Invalid Device ID for the measuring device X
16#0000_0001 -
16#FFFF_FFFF

parentDeviceId DWORD 0 0 = Not configured Device ID of the higher-level measuring X

device (hierarchy relationship)
id ARRAY[0..9] of 0 0 = Not configured Hardware IDs of the measuring device in -
HW_IO the hardware configuration
systemParam ARRAY[0..6] of 0 - System parameters for internal use -
LREAL
connection- USINT 0 0 - 16 (see 2)) Connection type of the measuring device -
Type2)
inputType USINT 0 0 = Invalid Type of input signal X
1 = Pulse signal
2 = Energy counter
value
3 = Power value
4 = Energy counter
value and power
value
mode USINT 0 0 = Invalid Configuration of the energy flow direc- X
1 = Consumer tion
2 = Producer
3 = Storage
configType USINT 1 1 = Basic data Energy data configuration X
2 = Advance data
3 = Additional data
4 = Advance and
additional data

SIMATIC Energy Suite V19.0

274 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

Parameter Data type Default Value range Description HMI 1)

accura- REAL 0.0 0.0 = Precision set- Conversion error of the voltage trans- -
cyVoltConv ting is disabled former in [%]
Range of validity:
0.0 - 100.0
accuracyCur- REAL 0.0 0.0 = Precision set- Conversion error of the momentary cur- -
rConv ting is disabled rent transformer in \ [%]
Range of validity:
0.0 - 100.0
accuracyDevice REAL 0.0 0.0 = Precision set- Measuring error of the measuring device -
ting is disabled in [%]
Range of validity:
0.0 - 100.0
accuracyAdd REAL 0.0 0.0 = Precision set- Additional error factor in [%] -
ting is disabled
Range of validity:
0.0 - 100.0
correctionFac- REAL 0.0 0.0 = Invalid Correction factor -
tor Range of validity:
0.001 - 1d
syncPeriod REAL 900.0 60.0 - 86400.0 ( = Archiving period in [s] X
1min -1d)
Overflow- LREAL 0.0 1.0 - 1.0e+21 Overflow value of the meter X
CntValue
normFactorIn REAL 1.0 0.0 - 9999999.0 Scale factor for input values (same scale X
factor for energy and power values)
normFactorOut REAL 0.001 0.0 - 9999999.0 Scale factor for output values X
(0.001 = Output
corresponds to kWh)
zeroCut REAL 0.1 0.0 - 3.402823e+38 Limit for zero point during the energy X
consumption calculation
baseAcqTime REAL 10.0 0.0 - 3600.0 (1 h) Calculation interval for the instantaneous X
See also value of the power consumption in [s]
EnS_CalcEnergyData
(Page 234)
addAcqTime REAL 10.0 0.0 - 3600.0 (=1h) Dynamic extension of the calculation X
See also interval for the instantaneous value of the
EnS_CalcEnergyData power consumption in [s]
(Page 234)
Consumer- BOOL FALSE TRUE = on Consumer/generator status is active -
StatusEnable FALSE = off
coordina- BOOL FALSE - TRUE = Coordination of acyclic communi- -
tionEnable cation services is enabled
cyclicRd BOOL FALSE - TRUE = Cyclic reading of acyclic energy -
data is enabled
cyclicTime REAL 60.0 0.0 - 3600.0 (1 h) Period for the cyclic reading of acyclic -
energy data in [s]
unitActEnergy3) UINT 0 see 3) Unit for active energy -
unitActPower3) UINT 0 see 3) Unit for active power -
unitAppEn- UINT 0 see 3) Unit for apparent energy -
ergy3)
unitAppPower3) UINT 0 see 3) Unit for apparent power -

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 275
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

Parameter Data type Default Value range Description HMI 1)

unitReactEner- UINT 0 see 3) Unit for reactive energy -
gy3)
unitReactPow- UINT 0 see 3) Unit for reactive power -
er3)
unitPowerFac- UINT 0 see 3) Unit for power factor -
tor3)
unitCurrent3) UINT 0 see 3) Unit for current -
unitVoltage3) UINT 0 see 3) Unit for voltage -
unitFrequen- UINT 0 see 3) Unit of frequency -
cy3)
unitAmpUn- UINT 0 see 3) Unit for amplitude balance of the current -
balCurrent3)
unitAmpUn- UINT 0 see 3) Unit for amplitude symmetry of voltage -
balVoltage3)
unitAddValue3) ARRAY[0..19] 0 see 3) Reserved -
typeAddValue ARRAY[0..19] 0 0 - 16 (see Input- Reserved -
Type)
archiveEnergy BOOL FALSE - FALSE = Archiving of the energy value -
deactivated,
TRUE = Archiving of the energy value
activated
archivePower BOOL FALSE - FALSE = Archiving of the power value -
deactivated,
TRUE = Archiving of the power value
activated
archiveEner- BOOL FALSE - FALSE = Archiving of the energy counter -
gyCounter value deactivated,
TRUE = Archiving of the energy counter
value activated
archive- ARRAY[0..19] 0 - Reserved -
AddValue
1)The selected parameters are assigned the system attribute "Available for HMI" and "Visible
in HMI". They are used for operator control and monitoring functions on the HMI device, for
example, displaying a current value in a faceplate.
2) Enumeration for the connection type of the measuring device (Page 282)
3) Enumeration for units (Page 283)

See also
Parameter status (Page 233)

SIMATIC Energy Suite V19.0

276 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.11 EnS_typeHMIWriteCtrl

A.4.11.1 Description of EnS_typeHMIWriteCtrl

The EnS_typeHMIWriteCtrl PLC data type contains control information for writing the energy
data to the SCADA system.

A.4.11.2 Structure of EnS_typeHMIWriteCtrl

The following table shows the parameters of the "EnS_typeHMIWriteCtrl" PLC data type:

Parameter Data type Default Description HMI *

req BOOL FALSE Request for writing the energy X
data to the SCADA system
maxItem UDINT 0 Maximum number of data X
records in the buffer
noItems UDINT 0 Number of data records writ- X
ten in the SCADA system
noDeletedItems UDINT 0 Number of deleted data rec- X
ords with a buffer overflow
writeItems DINT 0 Write cursor on the data rec- X
ord in the buffer
readItems DINT 0 Read cursor on the data record X
in the buffer
watchdog UINT 0 Watchdog counter X

* The highlighted parameters are assigned the system parameters "Accessible for HMI" and
"Visible for HMI". The parameters are used for data exchange with the Energy Suite SCADA
component.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 277
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.12 EnS_typeHMIWriteStat

A.4.12.1 Description of EnS_typeHMIWriteStat

The EnS_typeHMIWriteStat PLC data type contains status information for the writing the
energy data to the data log of the SCADA system.

A.4.12.2 Structure of EnS_typeHMIWriteStat

The following table shows the parameters of the "EnS_typeHMIWriteStat" PLC data type:

Parameter Data type Default Description HMI *

busy BOOL FALSE TRUE = WinCC script: in pro- X
gress
done BOOL FALSE TRUE = Energy data is success- X
fully written to the SCADA
system
error BOOL FALSE TRUE = Error occurred writing X
the energy data
status WORD 16#0000 Status of the WinCC script X
noItems UDINT 0 Number of written data rec- X
ords
readItem DINT 0 Read cursor on the data record X
in the buffer
writeHMIItem DINT 0 Write cursor on the data rec- X
ord in the data log
watchdog UINT 0 Watchdog counter X

* The highlighted parameters are assigned the system parameters "Accessible for HMI" and
"Visible for HMI". The parameters are used for data exchange with the Energy Suite SCADA
component.

SIMATIC Energy Suite V19.0

278 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.13 EnS_typeOrgData

A.4.13.1 Description of EnS_typeOrgData

Description
The "EnS_typeOrgData" PLC data type contains higher-level data and settings that all blocks
access. In this way, the information can be forwarded with priority to the blocks, for example,
an alarm lock.

A.4.13.2 Structure of EnS_typeOrgData

The following table shows the parameters of the "EnS_typeOrgData" PLC data type:

Parameter Data type Default Description

startup BOOL TRUE TRUE = Startup is active
messageSuppress BOOL FALSE TRUE = Alarm suppression
currTimeStamp DT - Current time stamp (UTC format)

A.4.14 EnS_typeSync

A.4.14.1 Description of EnS_typeSync

Description
The "EnS_typeSync" PLC data type contains all the information about the archiving period
including the synchronization pulse.

A.4.14.2 Structure of EnS_typeSync

The following table shows the parameters of the "EnS_typeSync" PLC data type:

Parameter Data type Default Description HMI *

syncPeriod REAL 900.0 Archiving period in [s] X
syncTime REAL 0.0 Remaining time of the archiv- X
ing in [s]
syncPulse BOOL FALSE Synchronization pulse -
syncTimeStamp DT DT#1990-01- Time stamp of the synchroni- X
01-00:00:00.0 zation pulse
error BOOL FALSE 1 = Error -
status WORD 16#0000 Error status information -

* The selected parameters become the system parameters "Available for HMI" and "Visible for
HMI". They can be used for operator control and monitoring functions on the HMI.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 279
Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.15 EnS_typeValue

A.4.15.1 Description of EnS_typeValue

Description
The "EnS_typeValue" PLC data type contains all the information of periodically acquired
energy data to be archived, for example, to the data log. The global data block EnS_BufferDB
(Page 265)" consists of an ARRAY of the "EnS_typeValue" PLC data type.

A.4.15.2 Structure of EnS_typeValue

The following table shows the parameters of the "EnS_typeValue" PLC data type:

Parameter Data type Default Description HMI *

tagname STRING[48] "" Tag name X
value LREAL 0.0 Periodic energy value X
timeStamp Date_And_Time DT#1990-01- Time stamp of the periodic X
01-00:00:00.0 energy value
status WORD 16#0000 Status of the periodic energy X
value

A.4.16 EnS_typeEnergyAdd

A.4.16.1 Description of EnS_typeEnergyAdd

The "EnS_typeEnergyAdd" PLC data type contains additional energy data which are read from
measuring instruments and provided to a CPU or HMI system.

A.4.16.2 Structure of EnS_typeEnergyAdd

The following table shows the parameters of the EnS_typeEnergyAdd and
EnS_typeEnergyAddValue PLC data type:

Parameter Data type Default Description

actValue Array[0..11] of Additional energy data

"EnS_typeEnergy-
AddValue"
status WORD 16#0 Error status information

SIMATIC Energy Suite V19.0

280 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.4 User-defined data types (UDTs)

A.4.17 Ens_typeEnergyAddValue

A.4.17.1 Description of Ens_typeEnergyAddValue

The "EnS_typeEnergyAddValue" PLC data type contains additional energy data which are read
from measuring instruments and provided to a CPU or HMI system.

A.4.17.2 Structure of Ens_typeEnergyAddValue

The following table shows the parameters of the EnS_typeEnergyAddValue PLC data type:

Parameter Data type Default Description

name String[20] Name of additional energy data

unit String[4] Unit of additional energy data
value Lreal 0 Value of additional energy data

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 281
Energy Suite blocks - Acquisition
A.5 Definition of enumerations

A.5 Definition of enumerations

A.5.1 Enumeration for the connection type of the measuring device

The following table shows the enumeration for the connection type of the measuring
instrument:

Number Connection type

0 Not defined
1 1 phase
2 1 phase - 3 phase (symmetrical)
3 3 phases (symmetrical)
4 3 phases + N (asymmetrical) without voltage transformer / with 3 current transformers
3P4W
5 3 phases + N (asymmetrical) with voltage transformer / with 3 current transformers 3P4W
6 3 phases + N (symmetrical) without voltage transformer / with 1 current transformer
3P4WB
7 3 phases + N (symmetrical) with voltage transformer / with 1 current transformer 3P4WB
8 3 phases (asymmetrical) without voltage transformer / with 3 current transformers 3P3W
9 3 phases (asymmetrical) with voltage transformer / with 3 current transformers 3P3W
10 3 phases (asymmetrical) without voltage transformer / with 3 current transformers 3P3W
11 3 phases (asymmetrical) with voltage transformer / with 2 current transformers 3P3W
12 3 phases (symmetrical) without voltage transformer / with 1 current transformer 3P3WB
13 3 phases (symmetrical) with voltage transformer / with 1 current transformer 3P3WB
14 2 phases + N (asymmetrical) without voltage transformer / with 2 current transformers
3P4W
15 1 phase + N without voltage transformer / with 1 current transformer 1P2W
16 3 phases + N (asymmetrical) with voltage transformer / with 3 current transformers 3P3W

SIMATIC Energy Suite V19.0

282 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Acquisition
A.5 Definition of enumerations

A.5.2 Enumeration for units

The following table shows the enumeration for the units:

Number Unit
Electrical units
0 Not defined
1209 A
1210 kA
1240 V
1242 kV
1241 MV
1186 W
1190 kW
1189 MW
1188 GW
1175 Wh
1179 kWh
1178 MWh
1177 GWh
1342 %
1077 Hz
Non-electrical units
1034 m³
1573 Nm³
1038 l
1041 hl
1088 kg
1092 t
32800 pcs
1598 m³/h
1590 Nm³/h
1353 l/h
1635 hl/h
1324 kg/h
1328 t/h
32801 pcs/h

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 283
Energy Suite blocks - Load management B
B.1 Energy Suite blocks for peak load management

B.1.1 Overview of Energy Suite blocks for load management

How Energy Suite load management blocks work

The load management program is constructed in a modularized way, so that for each
function can be decided to in-/exclude it and supply it separately.
However, a set of functions are vital for the basic functionality of the load management.
• A basic function set consists of a Forecast block, a Control block, an Actuator block and the
Backup/Restore block.
• For the centralized storage concept, two data blocks are included, the LmgtGeneralData
DB for the general data and the ActuatorList DB for actuator related data.
The Forecast block gets his input data from an acquisition object of an infeed, which is not
part of the load management scope, but from the energy suite.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 284
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

The following picture shows how the Energy Suite load management blocks work:

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 285
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Function blocks

Name Function
Forecast functionality for infeed energy data.
EnS_LmgtForecast_x (Page 288)
EnS_LmgtControl_Peak (Page 290) Control logic for peak load management. Calculation and evaluation of limits. Han-
dling job data for actuators.
EnS_LmgtActuator_x (Page 297) Feedback, status and control functionality.
EnS_LmgtBackupRestore Logging of limit violations and switching actions. Backup and restore functionality for
(Page 316) config data.

Data blocks

Name Function
EnS_LmgtGeneralData (Page 322) Central data storage for parameters, status, job data and control information of load
management
EnS_LmgtActuatorList (Page 323) Parameters, config data and priority list of actuators

User-defined data types

Name Function
EnS_typeLmgtActuatorElement (Page 324) Data structure for one actuator
EnS_typeLmgtActuatorMeta (Page 325) Actuator meta data
EnS_typeLmgtActuatorParameter (Page 325) Parameters of actuator
EnS_typeLmgtActuatorParameterSet (Page 326) Parameter set for one actuator
EnS_typeLmgtActuatorStatus (Page 327) Status information and actual values of actuator
EnS_typeLmgtActuatorStatusInOut (Page 328) Feedback and control values of actuator
EnS_typeLmgtAlarmElement (Page 329) Data of alarms and messages
EnS_typeLmgtControlLimitConfig (Page 329) Limit configuration of basic LMGT functions
EnS_typeLmgtControlParameters (Page 330) Data of control parameters
EnS_typeLmgtControlParameterSet (Page 331) Set of control parameters
EnS_typeLmgtControlTimeConfig (Page 331) Time configuration of basic LMGT functions
EnS_typeLmgtForecastValues (Page 332) Forecast energy data for load management
EnS_typeLmgtGeneralData (Page 333) General data
EnS_typeLmgtEnergyDiagram (Page 332) Energy diagram
EnS_typeLmgtJobRequestElement (Page 334) Job request data to actuators
EnS_typeLmgtJobRequestStack (Page 335) Data for request stack
EnS_typeLmgtJobTaskElement (Page 335) Task data to actuators
EnS_typeLmgtJobTaskStack (Page 336) Data for Task stack
EnS_typeLmgtOrganisation (Page 336) Period related data for load management
EnS_typeLmgtTriggerBR (Page 337) Trigger information for backup-restore block
EnS_typeLmgtVisualization (Page 338) Data for visualization
EnS_typeLmgtStorageElement (Page 339) Data structure of storage actuator
EnS_typeLmgtStorageParameter (Page 340) Parameters of a storage actuator
EnS_typeLmgtStorageParameterSet (Page 340) Parameters set of a storage actuator

SIMATIC Energy Suite V19.0

286 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

See also
Function blocks (Page 288)
Data blocks (Page 322)
User-defined data types (UDTs) (Page 324)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 287
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.2 Function blocks

B.1.2.1 EnS_LmgtForecast_x

Description of EnS_LmgtForecast_x

Description
The function block EnS_LmgtForecast_x calculates the forecast for average power and energy
value at the end of the periode of the infeed, which is used as a basis for the load
management.
Different algorithms shall be implemented for the forecast, which can be chosen by the user
to optimize the accuracy of the load management to minimize the number of switching
activities and optimize the forecast precision as early as possible in the period. For each
algorithm a distinct FB shall be implemented, with "x" serving as placeholder for the
abbreviation of the algorithm which is used in the FB.

Forecast algorithms

Forecast extension Description (Algorithm)

LinExt Linear extrapolation

Linear extrapolation
The energy and average power values are calculated with an extrapolation function.

Startup
The block has no start-up characteristics.
But the forecast can only be calculated after the synchronization periode is up to date and
valid. This is done by evaluation of the status of the infeed Acquistion Object (EnO).

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 289)" parameter
contains additional error information.

SIMATIC Energy Suite V19.0

288 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Parameters of EnS_LmgtForecast_x
The following table shows the function block "EnS_LmgtForecast_x":

Parameter Decla- Data type Default Description

ration
infeedEnergyBasic I "EnS_typeEnergyBasic" Basic energy structure of the infeed acquisition
object
error O Bool False TRUE: Rising edge informs that an error occurred
during the execution of the FB
status O Word 16#0 Current status of FB
forecastValues O "EnS Structure containing the forecastvalues
_typeLmgtForecastValues"

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description

(W#16#...)
0000 Done status value
8004 Error status for wrong input variables
8301 Incorrect input values during the archiving period in startup

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 289
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.2.2 EnS_LmgtControl_Peak

Description of Block EnS_LmgtControl_Peak

Description
The function block EnS_LmgtControl_Peak contains the core functionality of the load
management.
It monitors the forecast of energy and power values upon limit violations to determine the
escalation / de-escalation of actuators, to ensure that the actual power demand remains
below the defined limit.
The forecast data are delivered by EnS_LmgtForecast_x and is provided in the
‘EnS_LmgtData.energyForecast’ structure.
The LMGT control block identifies the power demand, which must be escalated to avoid a
limit violation or which power can be deescalated until the current power limit.
An escalation can result in either shedding actuators, to reduce power demand, or by
switching on generators, to provide more power in the system.
A de-escalation means additional consumers can be switched on, or generators can be
disconnected from the grid, to use the remaining power until the current power limits.
The decision, which actuators are deactivated or activated, is taken by each instance of
EnS_LmgtActuator_x individually, due to its actual condition, priority and parameter setting.

Configuration mode
The load management control block has two sets of configuration data, the parameterSet_1
and the parameterSet_2.
The input parameter ‘parameterSet’ defines which parameters shall be used for the load
management.
• User configuration: parameterSet = ‘1’
→ parameterset1 are used as current configuration set
• Runtime configuration: parameterSet = ‘2’
→ parameter set2 are used as current configuration set

SIMATIC Energy Suite V19.0

290 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Differential power / available energy until the end of the period

The LMGT calculates the current differential power and energy, which will be available at the
end of the period, based on the forecast energy/ power values and the remaining time of the
period.
The differential power is calculated from the average power forecast and the power limit. The
active power limit is determined by a percentage value from the absolut power limit value, to
get a security gap.
• Differential power:
Available power = power limit – average power forecast
The available energy is calculated from the forecast for the sum of energy until the end of the
period and the energy limit. The active energy limit is determined by a percentage value from
the absolut energy limit value, to get a security gap.
• Available energy:
Available energy = (energy limit * limit Percentage) – energy forecast.

Limit monitoring
The configured energy limits (warning, alarm and limit violation) of the forecast value are
monitored.
The power limit, which is configured by the user, will be converted to an internal energy
power limit:
• The limit warning is set, when the yellow warning limit is reached.
• The limit alarm is set, when the red alarm limit is reached.
If the forecast of the limit is violated (see peak), the LMGT starts to escalate actuators, to
reduce the power consumption (or to increase power production) to avoid a limit violation at
the end of the period.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 291
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

The limit (red dashed line) can be reduced by a percentage value (black dashed line)
(limitPercentage) as threshold. This value will be used as the active limit for escalation and
de-escalation.

Suppression delay duration

The limit monitoring is deactivated at the beginning of the period until the suppression delay
duration has been elapsed.

Limit tolerance
At the beginning of the period the accuracy of the calculated forecast values tends to be very
unprecise and could lead to frequent, unnecessary switching of actuators.
To avoid or improve this behaviour the limit can be raised with the parameter
‘limitToleranceStartValue’ for a defined time ‘limitToleranceDuration'.

SIMATIC Energy Suite V19.0

292 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

The limit tolerance duration will start after the suppression delay duration.
• limitToleranceStartValue:
Start value for the limit tolerance in percent (200% means, twice the limit value at the
beginning).
The setpoint limit (limitConfig.avgPower) of the LMGT is set to this value at the end of the
suppression delay duration (Begin of limit monitoring and linear ramp down).
• limitToleranceDuration:
Time duration for the limit tolerance
The setpoint limit of the LMGT is ramped down linearly from the start limit to the limit for
the period within the configured time, so that the active limit is reached, when the limit
tolerance duration time has been elapsed.

Escalation
If the energy forecast exceeds the configured limit for the period, the LMGT determines the
required power which must be disconnected or connected (in case of producer), to fall below
the limit.
The LMGT control block sends a job request with the (delta) energy, which shall be escalated.
• Energy consumer: switched OFF
• Energy producer: switched ON

De-escalation
If the energy forecast is below the configured limit for the period, the LMGT determines the
differential power which can be connected for approximating to the limit.
The LMGT control block sends a job request with the (delta) energy, which shall be
deescalated.
• Energy consumer: switched ON
• Energy producer: switched OFF

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 293
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Stabilization time
After switching, i.e. sending a job for escalation or de-escalation, the next job is only started
after the stabilization time is elapsed.
The purpose of this time is to allow the system to react on the job. If the demand still is
pending, after the stabilization delay has elapsed, a new job with the updated demand is
sent.

Limit violation
When a limit violation at the end of the period occurs (i.e. no actuator can be deactivated)
the logging of the runtime and configuration data is triggered.
The load management data and the actuator configuration are copied to a file on the SD card
of the PLC.
For details see Function block EnS_LmgtBackupRestore which also includes the logging
functionality.

Startup
After restart of the PLC the load management is initialized and inactive until the next
synchronization period begins, and valid infeed data are available, i.e. no escalation or de-
escalation is performed.
Escalation or de-escalation shall only be requested, when the stabilization delay time has
been elapsed.
All alarm messages are reset.
The determination of available power and energy values already take place.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 295)" parameter
contains additional error information.

SIMATIC Energy Suite V19.0

294 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Parameters of EnS_LmgtControl_Peak
The following table shows the function block "EnS_LmgtControl_Peak":

Parameter Decla- Data type Default Description

ration
enableLmgt I Bool FALSE State of load management; FALSE: Inactive; TRUE:
Active
amountActuators I UInt 0 Amount of actuators configured for load management
amountStor- I UInt 0 Amount of storage actuators configured for load man-
ageActuators agement
infeedEner- I "EnS_typeEnergyBasic" Basic energy structure of the infeed acquisition object
gyBasic
infeedEnergy- I "EnS_typeEnergyMeta" Meta energy structure of the infeed acquisition object
Meta
error O Bool FALSE TRUE: Rising edge informs that an error occurred dur-
ing the execution of the FB
status O Word 16#0000 Current status of FB
lmgtData IO "EnS_typeLmgtGeneral- All relevant data of the configured load management
Data"

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description

(W#16#...)
0000 Status value for DONE
7000 Faultless
8001 Control is not called in a Cyclic Interrupt OB
8002 Wrong OB interval
8200 Parameter ‘Mode’ invalid
8201 Error in parameter parameterSet_2 limit (power value >= 0; percentage values >= 0 and < 100)
8202 Error in parameter parameterSet_2 time (LimitToleranceStartValue >= 0; time values >= 0 and <
snycPeriod)
8203 Error in parameter parameterSet_1 limit (power value >= 0; percentage values >= 0 and < 100)
8204 Error in parameter parameterSet_1 time (LimitToleranceStartValue >= 0; time values >= 0 and <
snycPeriod)
8301 Incorrect input values during the archiving period in startup
8400 Error in internal ENO status
8401 Error in Forecast
9000 LMGT system is not enabled
9001 Limit violation occurred
9002 Lack of Actuators event occured

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 295
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Messages
The messages are implemented with the instruction ‘Program_Alarm’. The different messages
a multi-instance of the Program_Alarm block can be found in the static variables.

Message ID Message text Message class

8001 The FB is called in the wrong OB. It needs to be a cyclic interrupt OB. 0
8002 The cyclic interrupt OB which calls the FB has a cylic time larger than 1 second. 0
8200 Invalid value (>1) of the parameter 'parameterSet' in the parameter sets. 0
8201 Invalid value for at least one limit parameter in the parameterSet_2 set. 0
8202 Invalid value for at least one time parameter in the parameterSet_2 set. 0
8203 Invalid value for at least one limit parameter in the parameterSet_1 set. 0
8204 Invalid value for at least one time parameter in the parameterSet_1 set. 0
8400 Error in the infeed acquisition object. 0
8401 Invalid forecast values. 0
9000 Peak load management deactivated. 0
9001 Average power limit was exceeded. 0
9002 No actuators are available for escalation. 0
9003 Average power warning threshold reached. 0
9004 Average power alarming threshold reached. 0

SIMATIC Energy Suite V19.0

296 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.2.3 EnS_LmgtActuator_x

Description of EnS_LmgtActuator_x

Description
The function block EnS_LmgtActuator_x contains the functionality of an actuator for
evaluation of status, feedback and control logic considering the job information, which the
EnS_LmgtControl_x provides regarding the delta energy, which is required to stay below the
limit until the end of the period.
Different types shall be implemented for the actuator, regarding which kind of type the
actuator is.
For each type a distinct FB shall be implemented, with “x” serving as placeholder for the
actuator type.

Actuator types

Actuator Description
type
Consumer Consumes power/ energy while switched on, Releases power on escalation
Producer Produce power/ energy while switched on, Provides power on escalation
Storage Both produces and consumes power/energy while switched on. Releases power or
consumes power based on escalation/de-escalation

Configuration mode
The load management actuator block has two sets of configuration data, the parameter set1
and the parameter set2.
The input parameter ‘parameterSet’ defines which parameters shall be used for the load
management.
• User configuration: parameterSet 1 = ‘1’
→ parameterSet 1 are used as current configuration set
• Runtime configuration: parameterSet 2= ‘2’
→ parameterSet 2 are used as current configuration set
You can activate either Parameter set1 or Parameter set2 based on the requirements from the
Load management runtime faceplates.

Priority list
The priority list contains the information about the sequence, in which actuators shall be
escalated and de-escalated. The sequence of the actuators is determinend during runtime
and can be changed at any time, assuming the actuator is de-escalated. The action then will
instantly take effect.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 297
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Priority
The actuators are switched in a sequence, which is given by the priority list.
• Priority “0” - All calculations are stopped and disables the actuator for the respective Load
management system.
• Priority “1” is the highest priority (Lowest priority from the process point of view).
Priority order for escalation is ascending (e. g. 1,2,3, …), so actuators with a low priority
number (e. g. 1) are escalated before these with higher numbers, and therefore escalateded
more often.
Priority order for de-escalation is descending (e. g. 3, 2, 1), so actuators with a high priority
number (e.g. 10) are de-escalted before those with a low priority number (because they are
more relevant for the process).

Note
At any time, only one actuator/ group from the current priority will be escalated. If an
actuator (priority) was switched the program will continue with the next priority from the
priority list. (The actuators of only one rolling ID are escalated at the same time within a
rolling sequence. -> Several actuators can have the same prio & rollID)

Priority groups
Actuators with the same priority (priority) and rolling sequence identifier (rollingIdentifier)
belong to a priority group and are always switched at the same time (in the same cycle).

Rolling sequence
Actuators with the same priority (priority) and different rolling sequence identifiers
(rollingIdentifier) belong to a rolling sequence. Actuators are switched alternating, whereas
actuators with the same rolling sequence identifier are switched at the same time (in the
same cycle).

Procedure
Each actuator instance checks its status and the request stack for incoming jobs at its call. The
actuator then determines autonomously, due to the parameters and current state, if he can
serve the request. The result of the determination is written back into the request stack, as
feedback for the LMGT Control block and the next actuator will be called.
In the next cycle the LMGT Control block will evaluate the feedback from the actuators and
will write a corresponding job into the task stack.

SIMATIC Energy Suite V19.0

298 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

This task includes the priority and rolling ID, as well as the energy which should be de-/
escalated. Each actuator instance checks if it is part of this priority and rolling ID, and
performs the switching action, if so.

Switching sequence example

• Start with priority number 1 (Highest priority)
• Consider priority:
Example:
Actuator 1: priority = 1, rollingIdentifier = 1 → switching order = 1
Actuator 2: priority = 2, rollingIdentifier = 1 → switching order = 2
Actuator 3: priority = 10, rollingIdentifier = 1 → switching order = 3
• Consider priority group:
Actuators in a priority group (rolling sequence identifier = 1)
Example:
Actuator 1: priority = 5, rollingIdentifier = 1 → switching order = 1
Actuator 2: priority = 5, rollingIdentifier = 1 → switching order = 1
Actuator 3: priority = 5, rollingIdentifier = 1 → switching order = 1
• Consider priority group and rolling sequence:
Actuators in a priority group and different rolling sequence identifier
Example:
Actuator 1: priority = 5, rollingIdentifier = 2 → switching order = 2
Actuator 2: priority = 5, rollingIdentifier = 1 → switching order = 1
Actuator 3: priority = 5, rollingIdentifier = 3 → switching order = 3

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 299
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

• Actuators in a priority group and the same rolling sequence identifier

Example:
Actuator 1: priority = 5, rollingIdentifier = 2 → switching order = 2
Actuator 2: priority = 5, rollingIdentifier = 2 → switching order = 2
Actuator 3: priority = 5, rollingIdentifier = 1 → switching order = 1

Power / energy values

The power and energy values, which are required for the escalation and de-escalation logic,
are written to the structure ‘status’ in the EnS_ActuatorConfig DB.
• actPower:
Actual power value, which is derived from the feedback (feedbackBoolean (for consumers
and producers) / feedbackState (for storage) / feedbackAnalog ) and / or the typical power
• escalationEnergy:
Energy value which is available for escalation (considering connect / disconnect times and
dead times)
• deescalationEnergy:
Energy value which is available for de-escalation (considering connect / disconnect times
and dead times)
actPower = actual Power (input actPower) or typical/ standby Power (from configuration) de-/
escalationEnergy = forecast Energy – Energy limit (active limit)

Feedback
Four different types of feedback are supported for the actuator:
1. Power value: Actual power value (fedAnalog) shall be considered, when acknowledging
escalation / de-escalation.
2. Acquisition object: Feedback from an acquisition object of the Energy Suite.
3. Status feedback:
– Consumers/Producers: The switch status (fedBoolean) delivers the on / off status of the
actuator. The configured typical/ standby power value shall be considered, when
acknowledging escalation / de-escalation
– Storage: The status feedback(fedState) delivers the Idle(0)/Charge(1)/Discharge(2)
status of the actuator. The configured typical powers for charging and discharging
shall be considered, when acknowledging escalation/de-escalation.
4. No feedback: The feedback is determined by the block assuming the status as the control
output (ctrlAnalog along with ctrlBoolean(consumers/producers)/ctrlState(storage)). The
configured typical power value (typical/ standby Power) will be considered, when
acknowledging escalation / de-escalation.

SIMATIC Energy Suite V19.0

300 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Escalation
Different commands are set depending on the actuator types (actuatorType), when an
escalation request (jobType = 1) has been received and the block gets the order that the
actuator shall escalate:
1. Consumer: Disconnect (controlBoolean = FALSE)
2. Producer: Connect (controlBoolean = TRUE)
3. Storage: Discharge (controlState= 2)

De-escalation
Different commands are set depending on the actuator types (actuatorType), when a de-
escalation request (jobType = 2) has been received and the block gets the order that the
actuator shall de-escalate:
1. Consumer: Connect (controlBoolean = TRUE)
2. Producer: Disconnect (controlBoolean = FALSE)
3. Storage: Charge (controlState = 1)

Partial load functionality (Consumers / Producers)

With the parameter “partialConsumption” the partial load functionality of an Actuator can be
enabled. That means that the power demand or the power supply of the actuator can be
varied
(0 - 100%). The actuator calculates the remaining power or the exceeding power amount
which is as close as possible to the power limit and will reduce/ expand power consumption
accordingly.
This variable power value is internally handled as percentage value, so in case of a priority
group of actuators with different nominal power each actuator determines the absolute value
accordingly.
The partial load function will only be used by the last actuator of the priority group in the task
job, if it is a partial load actuator. Otherwise the actuator will be switched at once.
With the parameter "partialStateWaitTime", a wait time between switching actions in partial
state can be configured. When actuator is in partial consumption state, it will wait for the
time configured in 'partialStateWaitTime' before escalating / de-escalating.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 301
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Connect and disconnect times (Consumers / Producers)

Refer below example for Consumer actuator:
For the switching of actuators minimum connect time (minDeescalationTime), minimum
disconnect time (minEscalationTime) and maximum disconnect time (maxEscalationTime)
have to be considered.
• Minimum connect time → relevant for escalation
The minimum connect time is the minimum time, which the actuator has to be connected
100%. The actuator can only be disconnected after the minimum connect time has elapsed.

If the minimum connect time has not yet elapsed, for the energy / power calculations the
difference (minConnectTime – connectTime) has to be subtracted from the remaining time in
the period (statusLmgt.infeedEnergyBasic.syncData.syncTime) to get the correct available
energy / power values which can be escalated.
Remaining time (until disconnect allowed) = minConnectTime - connectTime
Remaining time (for energy / power calculations) =
statusLmgt.infeedEnergyBasic.syncData.syncTime - (minConnectTime –
statusActuator.connectTime)
Minimum disconnect time → relevant for de-escalation
The minimum disconnect time is the minimum time, which the actuator has to be
disconnected 100%. The actuator can only be connected after the minimum disconnect time
has elapsed.

If the minimum disconnect time has not yet elapsed, for the energy / power calculations the
difference (minDisconnectTime – disconnectTime) has to be subtracted from the remaining
time in the period (statusLmgt.infeedEnergyBasic.syncData.syncTime) to get the correct
available energy / power values which can be de-escalated.

SIMATIC Energy Suite V19.0

302 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Remaining time (until connect allowed) = minDisconnectTime - disconnectTime

Remaining time (for energy / power calculations) =
statusLmgt.infeedEnergyBasic.syncData.syncTime - (minDisconnectTime – disconnectTime)
Maximum disconnect time → relevant for escalation
The maximum disconnect time is the maximum time, which the actuator can be
disconnected or partially connected. The actuator has to be connected (100%) after the
maximum disconnect time has elapsed.

If the maximum disconnect time has not yet elapsed, for the energy / power calculations the
difference (maxDisconnectTime – disconnectTime) has to be subtracted from the remaining
time in the period (statusLmgt.infeedEnergyBasic.syncData.syncTime) to get the correct
available energy / power values which can be escalated.
Remaining time (until reconnect forced) = maxDisconnectTime - disconnectTime
Remaining time (for energy/ power calculations) =
statusLmgt.infeedEnergyBasic.syncData.syncTime - (maxDisconnectTime – disconnectTime)

Dead time for escalation

The dead time (escalationDelayTime) shall be considered for each actuator to determine the
amount of energy, which can be contributed by escalating the actuator. If the delay time is
greater than zero, the escalation gets effective and the energy will be calculated based on
linear ramp up and ramp down approach. This results in less energy, which the actuator can
contribute to the LMGT.

For the energy / power calculations the escalationDelayTime has to be subtracted from the
remaining time in the period.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 303
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Dead time for de-escalation

The dead time (deescalationDelayTime) shall be considered for each actuator to determine
the amount of energy, which is added after deescalating the actuator. If the delay time is
greater than zero, the de-escalation gets effective and the energy will be calculated based on
linear ramp up and ramp down approach. This results in less energy, which the actuator
consumes after activating it.

For the energy / power calculations the deescalationDelayTime has to be subtracted from the
remaining time in the period.

Storage Actuator
The storage actuator can operate in 3 states: Idle (0), Charge (1), Discharge (2). The storage
can operate in Basic mode or Advance mode. In basic mode, the inputs charge and discharge
influence the behavior of storage in the following manner:

Charge Discharge Behavior of Storage

TRUE TRUE Actuator takes part in escalation and
de-escalation jobs
TRUE FALSE • Actuator takes only part in de-
escalation jobs
• Actuator goes in idle (= not charg-
ing, not discharging) if LMGT tries
to escalate
FALSE TRUE • Actuator takes only part in escala-
tion jobs
• Actuator goes in idle if LMGT tries to
de-escalate
FALSE FALSE Acutator ignores every job and is in idle

In advance mode, inputs charge/discharge and SOC(State of Charge) influence the behavior
of storage.

SIMATIC Energy Suite V19.0

304 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Parameters for Advance mode operation:

• Max Charging limit (%): The SOC cannot exceed the max. charging limit. The actuator will
ignore de-escalation jobs from the LMGT if the SOC equals the max. charging limit
• Discharging limit (%): The SOC can exceed the discharging limit within one job. After the
job is finished, the actuator only accepts escalations or is idle for de-escalations from the
LMGT.The discharging limit must be between max. charging limit and min. discharging
limit.The discharging limit cannot be smaller than the charging limit
• Charging limit (%): The SOC can go below the charging limit within one job. After the job
is finished, the actuator only accepts de-escalations or is idle for escalations from the
LMGT. The charging limit must be between max. charging limit and min. discharging limit.
The charging limit cannot be greater than the discharging limit.
• Min Discharging limit (%): The SOC cannot go below the min. discharging limit. The
actuator will ignore escalation jobs from the LMGT if the SOC equals the min. discharging
limit.

Note
These parameters are in percentage (%) and value should be between 0 to 100.

Time parameters for storage:

The timing parameters are interpreted as below:
• minChargingTime = minDeescalationTime, minimum time it must be in charging state
• minDischargingTime = minEscalationTime, minimum time it must be in discharging state
• maxDischargingTime = maxEscalationTime, maximum time it can be in discharging state
after which it is moved to Idle state
• dischargingDelayTime = escalationDelayTime (applicable only in Idle state), delay time
taken to discharge
• chargingDelayTime = deescalationDelayTime (applicable only in Idle state), delay time
taken to charge

Job management
Escalation and de-escalation requests are received as jobs within the LMGT system. The block
must be able to evaluate the jobs and the parameters of the LMGT system and reacts
accordingly. For more details see section Job Concept - De-/ Escalation sequence (Page 310).

Startup
The block “EnS_LmgtActuator_x” has no start up characteristic.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 305
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 308)" parameter
contains additional error information.

Parameters of EnS_LmgtActuator_x
The following table shows the parameters of the function block
"EnS_LmgtActuator_Consumer/EnS_LmgtActuator_Producer":

Parameter Decla- Data type Default Description

ration
id I UInt 0 Identifier of actuator; number of data storage for the
actuator in the actuator list
enableActuator I Bool False Release for the actuator to participate the load man-
agement; FALSE: Inactive; TRUE: Active
fedBoolean I Bool False The boolean feedback for the actuator to identify the
result of a switching action
fedAnalog I Real 0.0 The analog feedback for the actuator to identify the
result of a switching action [kW]
hwFault I Bool False Error indicator from the connected switching hard-
ware; TRUE = error in device
hwStatus I Word 16#0 Status information from an intelligent device; could
indicate an error
actuatorEner- I "EnS_typeEnergyBasic" - Basic energy structure of an acquisition object
gyBasic
actuatorEner- I "EnS_typeEnergyMeta" - Energy Meta structure of an acquisition object
gyMeta
ctrlBoolean O Bool FALSE The signal to switch a binary actuator; TRUE = switch
off
ctrlAnalog O Real 0.0 The set point consumption for the actuator [kW]
error O Bool FALSE TRUE: Rising edge informs that an error occurred dur-
ing the execution of the FB
status O Word 16#0000 Current status of FB
actuatorList IO Array[*] of - Load management configuration data
"EnS_typeLmgtActuator-
Element"
lmgtData IO "EnS_typeLmgtGeneral- - All relevant data of the configured load management
Data"

SIMATIC Energy Suite V19.0

306 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

The following table shows the parameters of function block EnS_LmgtActuator_Storage.

Parameter Declara- Data Type Default Description

tion
id I UInt 0 Identifier of actuator; num-
ber of data storage for the
actuator in the actuator list
enableActuator I Bool False Release for the actuator to
participate the load man-
agement; FALSE: Inactive;
TRUE: Active
fedState I USInt 0 The status feedback, 0-Idle,
1-Charge, 2-Discharge
fedAnalog I Real 0.0 The analog feedback for the
actuator to identify the result
of a switching action [kW]
hwFault I Bool False Error indicator from the con-
nected switching hardware;
TRUE = error in device
hwStatus I Word 16#0 Status information from an
intelligent device; could
indicate an error
actuatorEner- I EnS_typeEnergyBasic - Basic energy structure of an
gyBasic acquisition object
actuatorEner- I EnS_typeEnergyMeta - Energy Meta structure of an
gyMeta acquisition object
mode I USInt 0 0= only basic, 1= only ad-
vance, 2= basic and advance
charge I Bool True 1= can charge
discharge I Bool True 1= can discharge
stateOfCharge I Real 0.0 State of charge in advance
mode (%)
ctrlState O USInt 0 0=Idle, 1=Charge,
2=Discharge
ctrlAnalog O Real 0.0 The set point consumption
for the actuator [kW]
error O Bool False TRUE: Rising edge informs
that an error occurred during
the execution of the FB
status O Word 16#000 Current status of FB
0
actuatorList IO Array[*] of - Load management configu-
"EnS_typeLmgtStorage- ration data
Element"
lmgtData IO "EnS_typeLmgtGeneral- - All relevant data of the con-
Data" figured load management

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 307
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description

(W#16#...)
8001 ERROR_OP_MODE_WRONG
8002 ERROR_PAR_MODE_WRONG
8003 ERROR_CHANGE_PRIO_ESC
8004 ERROR_ACTUATOR_DISABLED
8201 ERROR_PARAM_ID
8211 ERROR_PARAM_ACTUATOR_TYPE
8212 ERROR_PARAM_ACQ_TYPE
8213 ERROR_PARAM_CTRL_TYPE
8221 ERROR_PARAM_SET1_POWER_LEVEL
8222 ERROR_PARAM_SET1_PRIO
8223 ERROR_PARAM_SET1_ROLLING_ID
8224 ERROR_PARAM_SET1_PARTIAL
8225 ERROR_PARAM_SET1_TIME
8226 ERROR_PARAM_SET1_ACTUATOR_DISABLED
8227 ERROR_PARAM_SET1_CHARGE_LIMIT
8228 ERROR_PARAM_SET1_MODE
8231 ERROR_PARAM_SET2_POWER_LEVEL
8232 ERROR_PARAM_SET2_PRIO
8233 ERROR_PARAM_SET2_ROLLING_ID
8234 ERROR_PARAM_SET2_PARTIAL
8235 ERROR_PARAM_SET2_TIME
8236 ERROR_PARAM_SET2_ACTUATOR_DISABLED
8237 ERROR_PARAM_SET2_CHARGE_LIMIT
8238 ERROR_PARAM_SET2_MODE
8241 ERROR_PARAM_FEDSTATE
8401 ERROR_WRONG_FEEDBACK_SIGNAL
8601 ERROR_WRONG_OB
8602 ERROR_INTERRUPT_TOO_LONG

SIMATIC Energy Suite V19.0

308 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Messages
The messages are implemented with the instruction ‘Program_Alarm’. The different messages
a multi-instance of the Program_Alarm block can be found in the static variables.

Message ID Message text Message class

8001 Wrong operating mode 0
8002 Wrong parameter mode 0
8003 Cannot change priority when actuator is escalated 0
8004 Actuator disabled for load management
8201 Wrong parameter ID 0
8211 Wrong configuration: actuator type 0
8212 Wrong configuration: acquisition type 0
8213 Wrong configuration: control type 0
8214 Wrong loop index
8221 Wrong parameter configuration pararmeter set1: power level 0
8222 Wrong parameter configuration pararmeter set1: priority 0
8223 Wrong parameter configuration pararmeter set1 : rolling ID 0
8224 Wrong parameter configuration pararmeter set1 : partial consumption
8225 Invalid value for atleast one time parameter in pararmeter set1
8226 Actuator disabled for load management, parameter set1: priority 0
8227 Invalid value for at least one charge/discharge limit in parameter set 1
8228 Wrong parameter configuration parameter set 1: current mode
8231 Wrong parameter configuration pararmeter set2 is used : power level 0
8232 Wrong parameter configuration pararmeter set2: priority 0
8233 Wrong parameter configuration pararmeter set2: rolling ID 0
8234 Wrong parameter configuration pararmeter set2 : partial consumption
8235 Invalid value for atleast one time parameter in pararmeter set2
8236 Actuator disabled for load management, parameter set2: priority 0
8237 Invalid value for at least one charge/discharge limit in parameter set 2
8238 Wrong parameter configuration parameter set 2: current mode
8241 Invalid feedback state
8242 SOC attained maximum charging limit
8243 SOC attained minimum discharging limit
8401 Hardware feedback signal does not correspond actuator state
8601 Block call in wrong OB 0
8602 Interrupt time of OB too long 0

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 309
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Response status
The following table shows the response status of the block on receiving a job request:

Status Description
16#7100 STATUS_REQ_RESPONDED
16#7110 STATUS_REQ_DENIED
16#7200 STATUS_NEW_JOB_ESCALATION
16#7210 STATUS_NEW_JOB_DEESCALATION

Job Concept - De-/ Escalation sequence

This is a simplified description how a job will be handled thru the different steps, while the
program will process a de-/ escalation job.

Request sequence
1. The forecast energy and power values are calculated by the ‘EnS_LmgtForecast’ block and
are written into the ‘forecastValues’ structure in the ‘EnS_LmgtGeneralData’ DB.
2. The ‘EnS_LmgtControl’ block calculates the delta energy from the forecast values and the
current energy limits (due to the current parameter set). This can either be a negative value,
if the forecast is higher than the limit or a positive value if the forecast is lower than the
limit.
3. The control block creates a new ‘jobNumber’, sets the corresponding ‘jobType’ and
‘deltaEnergy’ value and writes it into the requestStack structure.

Note
This value is always positive! The information if this ‘deltaEnergy’ must be escalated or
deescalated is evaluated via the ‘jobType’!

4. Each actuator checks if a new job was created by the control block (‘jobNumber’ is different
to previous one). If so, the actuator evaluates his status and writes his feedback data into
the ‘actuatorFeedback’ structure with the following logic:
– If there is still an empty job field, or his priority is higher than the existing ones, insert
feedback data.
– If the same priority and rollingID already exists, add own energy value to the
‘availEnergy’ in the list.
– If priority already exists but rollingID is different, check if ‘countEscalated’ value is
higher than own one, then insert feedback data.

Task sequence
In the following cycle all actuators have performed their feedback sequence and the control
block can evaluate the data from last cycle.
1. The control block checks all ‘availEnergy’ from the feedback structure.
– If the available energy is zero, then the case of ‘LackOfActuators’ occurred, because no
actuator was able to provide energy for the requested job.

SIMATIC Energy Suite V19.0

310 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

– Otherwise the datasets from the requestStack are copied to the taskStack. This will be
done until the sum of available (order) energy is equal or higher (Escalation) or below
(Deescalation) then the delta energy.
2. Each actuator checks the ‘taskStack’ if a new task was created by the control block
(‘jobNumber’ different to previous one). If so, the actuator checks, if he is part of the priority
and rollingID of the job task and performes the switching due to the ‘jobType’ (de-
/escalation).
The request and task sequence are independent from each other and will be performed in
every cycle.

Example

Description
Following there is a simplified example of a job request for an escalation.
The table of the request stack shows not all entries (to focus on the important values).
Also, the case of partitial load is not considered in this example.
Presentation: Step by Step of an escalation request (jobType = 1) for 100 kW.
Given that:
• 10 Actuators with 3 priorities and 3 rolling IDs are configured
• Presentation of actuator list, request stack
Condition:
• There is no request/ task active (very first run)
• All actuators are enabled and switched on

Status and parameters of actuators

Aktor ID Priority Rolling ID P/E Condition Enabled

1 3 3 10 ON YES
2 2 1 20 ON YES
3 1 1 30 ON YES
4 1 3 40 ON YES
5 1 2 50 ON YES
6 3 1 50 ON YES
7 3 2 40 ON YES
8 1 2 30 ON YES
9 2 2 20 ON YES
10 2 1 10 ON YES

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 311
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Request stack (initial)

ACTR
_Feed-
back [0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E_availab
_Number _de _Escalated _Deescalat le
_escalate ed
1 1 100 - - - - -
- - - - -
- - - - -
- - - - -

Request stack (progress, after each actuator call)

1. The first actuator writes his data into the empty request stack.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 3 3 0 0 10

2. The second actuator has a higher priority, so he copies the existing data into the second
data set and writes his data in the first data set.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_de _Escalated _De- _available
_escalate escalated
1 1 100 2 1 0 0 20
3 3 0 0 10

SIMATIC Energy Suite V19.0

312 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

3. The third actuator has a higher priority than that one in the first data set, so he shifts all data
one data set further and writes his data in the first data set.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count_Esc Count P/E
_Number _de alated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 3 0 0 10

4. The forth actuator has the same priority than the first one, but a lower rolling ID, therefore
this actuator skips further actions.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 3 0 0 10

5. The fifth actuator also has the priority "1" with a lower rolling ID than the existing one, so
this actuator also skips any further actions.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 3 0 0 10

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 313
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

6. The sixth actuator has the priority "3" with rolling ID "1", so he will overwrite the existing
data from actuator ID 1.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 1 0 0 50

7. The seventh actuator also has the priority "3" but with the lower rolling ID "2", so the
actuator skips further actions.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 1 0 0 50

8. The eighth actuator has the priority "1" with the lower rolling ID "2". So the actuator skips
further actions.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 1 0 0 50

SIMATIC Energy Suite V19.0

314 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

9. The ninth actuator has the priority “2” with rolling ID “2”. There is already a priority group
with an higher priority in the list, so this actuator skips his entry.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 20
3 1 0 0 40

10.The tenth actuator has the priority “2” with rolling ID “1”. An entry of this priority group
already exists in the request stack, so the energy/ power will be added to that entry.

ACTR
_Feed-
back
[0..9]
Job Job_Type P/E_to Priority RollingID Count Count P/E
_Number _de _Escalated _De- _available
_escalate escalated
1 1 100 1 1 0 0 30
2 1 0 0 30
3 1 0 0 50

Status of actuators after job has been finished

In total 110W will be escalated (request 100W), due to the actuator priority grouping.

Aktor ID Priority Rolling ID P/E Condition Enabled

1 3 3 10 ON YES
2 2 1 20 OFF YES
3 1 1 30 OFF YES
4 1 3 40 ON YES
5 1 2 50 ON YES
6 3 1 50 OFF YES
7 3 2 40 ON YES
8 1 2 30 ON YES
9 2 2 20 ON YES
10 2 1 10 OFF YES

At the end of the PLC cycle, when all actuator instances have been processed, the request
stack contains the ten actuators sorted according their priority and rolling ID.
In the next cycle the control block then can copy step by step the data sets into the task stack
until the power demand is fulfilled.
In the next cycle the actuators will also consider the task stack and will switch accordingly the
entries.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 315
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.2.4 EnS_LmgtBackupRestore

Description of EnS_LmgtBackupRestore

Description
The function block EnS_LmgtBackupRestore provides the functionality to write logging/
configuration data to the SD-Card of the PLC. In case of a limit violation, switching action or a
lack of actuators, configuration data and runtime data is written to an appropriate file under
the folder “UserFiles” onto the memory card.
Also the block saves and restores configuration data of the actuators and load management
system, in this folder on the SD-Card by user command.

Logging

Limit violation
When the LmgtControl block recognizes a limit violation at the end of the period, it triggers
the logging of the current data from the "EnS_LmgtGeneralData" and "EnS_ActuatorList". The
corresponding data is read out and written to the SD-Card of the PLC.
The data will be stored under ‘UserFiles/’ in the file named "<LMGT name>_LimitViol_xx.bin".
The storage actuator data is logged in file "<LMGT name>_LimitViol_Storagexx.bin". The
events will be written continuously into the file. If the maximum size of the file containing
LMGT and consumer/producer data(16MB) is reached, new files will be created for
consumer/producer and storage with incremented file number xx. Each new dataset begins
with the timestamp of the event.
The maximum number of files can be selected by the input parameter ‘amountLogFiles’.

Switching action
When ever a switching action is performed by one of the LmgtActuator blocks, the relevant
data from the "EnS_LmgtGeneralData" and "EnS_ActuatorList" is read out and written to the
SD-Card of the PLC. This logging is triggered from the LmgtControl block with the command
"trigSwitching" within the structure "triggerBackupRestore" in the "EnS_LmgtGeneralData" DB.
The data will be stored under ‘UserFiles/’ in the file named "<LMGT
name>_SwitchEvnt_xx.bin". The storage actuator data is logged in file "<LMGT name>_
Switch- Evnt _Storagexx.bin". The events will be written continuously into the file. If the
maximum size of the file containing LMGT and consumer/producer data(16MB) is reached,
new files will be created for consumer/producer and storage with incremented file number
xx.. Each new dataset begins with the timestamp of the event.

SIMATIC Energy Suite V19.0

316 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Lack of Actuators
When the control block wants to escalate a job but there is no appropriate feedback from the
actuators, this event is handled as ‘Lack of actuators’. That means no actuator can handle this
request and a limit violation will occure if this status will stay.
This event can occur due to wrong settings of the actuators, priority list or general
parameters. This event will be logged under ‘UserFiles/’ in the file named ‘<LMGT
name>_LackActuators_xx.bin’. The storage actuator data is logged in file "<LMGT name>_
LackActuators _Storagexx.bin" The events will be written continuously into the file. If the
maximum size of the file containing LMGT and consumer/producer data(16MB) is reached,
new files will be created for consumer/producer and storage with incremented file number
xx. Each new dataset begins with the timestamp of the event.
The maximum number of files can be selected by the input parameter ‘amountLogFiles’.

Backup & restore

The user can create a backup of the current configuration data.
When saving the configuration in the SCADA system or on trigger (input parameter backup =
TRUE) the LMGT configuration with all RT parameters comprising general, infeed and actuator
settings will be archived. The backup will be stored on a permanent location on the PLC
(memory card of the PLC).
The configuration can be restored by setting the input parameter restore.

Backup
When the command ‘triggerBackup’ is triggered, the current configuration of the actuators
and the load management will be read out and saved into a backup file on the SD-Card of the
PLC.
The file will be stored under ‘UserFiles/’ name ‘<LMGT name>_ConfigBackup.bin’. The storage
actuators data is stored in ‘<LMGT name>_StorageBackup.bin’.

Restore
When the command ‘trigRestore’ is triggered a new configuration will be read out from the
backup file, which has to be stored on the SD-Card of the PLC, and overwrites the current
one.

Prerequisite
To restore a backup file from the SD-Card back to the LMGT Configuration the following
prerequisites have to be fulfilled.
• A backup file named "<LMGT name>_ConfigBackup.bin" has to be stored under ‘UserFiles/’
on the memory card of the PLC. To restore storage data, file named "<LMGT
name>_StorageBackup.bin" has to be stored on PLC.
• The file must be of a binary format which match the internal data structure (generation
with the provided converter tool)

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 317
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

CAUTION

The System can not analyse or check the restore file about correct data. If the restore
file is loaded into the system, the config data will be written into the parameter
sections and will take effect immediately!

Characteristics
Due to performance reasons of the PLC, the files are written in a binary form. The data can be
converted with a supplied converting tool to get a readable structure (CSV file).

File generation
Depending on the trigger, different files will be created by the EnS_LmgtBackupRestore block.
• Limit violation – File with name ""<LMGT name>_LimitViol_xx.bin"
• Switching action – Filename with name "<LMGT name>_SwitchEvnt_xx.bin"
• Lack of actuators – Filename "<LMGT_name>_LackActuators_xx.bin"
• Backup configuration – Filename "<LMGT name>_ConfigBackup.bin"
(Only one file is generated, file will be overwritten)
With xx as consecutive number until the maximum number of files, defined by the input
parameter ‘amountLogFiles’.

SIMATIC Energy Suite V19.0

318 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Access to files
The generated files can be accessed by using the web server of the PLC. Therefore the web
server has to be activated under the device configuration, General - Web server.

CAUTION

Created files from the system should not be deleted by the user! Because of the consecutive
data writing of the backup & restore function, otherwise, the system will not know where to
continue. This will lead to errors and abort the logging function for further execution.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 319
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

And at least the rights for read, write, delete files must be given in the user management.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status (Page 321)" parameter
contains additional error information.

Parameters of EnS_LmgtBackupRestore
The following table shows the function block "EnS_LmgtBackupRestore":

Parameter Decla- Data type Default Description

ration
amountLogFiles I UInt 10 Amount of log files for each log file type
busy O Bool false Block is busy
error O Bool false Error occured while processing
status O Word 16#0 Detail information of error
mode O USInt 0 Actual processing mode
lmgtData IO "EnS_typeLmgtGeneral- Loadmanagement general data struct
Data"
actuatorList IO Array[*] of Actuator configuration data struct
"EnS_typeLmgtActuator-
Element"
storageList IO Array[*] of Storage configuration data struct
"EnS_typeLmgtStorage-
Element"

SIMATIC Energy Suite V19.0

320 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description

(W#16#...)
80B3 There is not enough space on the memory card
80B4 The memory card or file is write-protected
80C3 The maximum number of simultaneously active FileWriteC instructions has already been reached
8091 Corresponding backup-file (Userfile\LMGT name) not found on SD-Card
8093 Error in corresponding log file. New log file was created
8094 The maximum length of the log file is reached

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 321
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.3 Data blocks

B.1.3.1 EnS_LmgtGeneralData

Description of EnS_LmgtGeneralData

Description
The data block "EnS_LmgtGeneralData" contains the major data for the load management.

Structure of EnS_LmgtGeneralData

Description
The data block "EnS_LmgtGeneralData" contains the major data for the load management

Element Data type Description

parameterSets "EnX_typeLmgtControlParameters" Configuration data of the complete load
management
forecastValues "EnX_typeLmgtForecastValues" Forecast values for average power and
energy at the end of the period
requestStack "EnX_typeLmgtJobRequestStack" Interface of Control and Actuators for
job requests
taskStack "EnX_typeLmgtJobTaskStack" Interface of Control and Actuators for
job tasks
escalatedPriorities Array[1..1999] of Bool Each index shows one priority. TRUE =
One or more actuators of the priority is
currently escalated
orgData "EnX_typeLmgtOrganisation" Time data of the period
triggerBackupRestore "EnX_typeLmgtTriggerBR" Trigger variables for logging functional-
ity
criticalAlarms Array[0..9] of Buffer for the last 10 critical alarms
"EnX_typeLmgtAlarmElement"
visualization "EnX_typeLmgtVisualization" Configuration data of the complete load
management

SIMATIC Energy Suite V19.0

322 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.3.2 EnS_LmgtActuatorList

Description of EnS_LmgtActuatorList

Description
The global data block "EnS_ActuatorList" contains the parameters, config data and priority list
of all actuators.

Structure of EnS_LmgtActuatorList

Description
The following table shows the structure of the data block "EnS_ActuatorList":

Element Data type Description

Actuators Array[0..XX] of Array of max. amount of actuators with
"EnS_typeLmgtActuatorElement" the corresponding data
StorageActuators Array[0..XX] of Array of max amount of storage actua-
"EnS_typeLmgtStorageElement" tors with corresponding data

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 323
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4 User-defined data types (UDTs)

B.1.4.1 EnS_typeLmgtActuatorElement

Description of EnS_typeLmgtActuatorElement

Description
The type contains the data structure of one actuator.

Structure of EnS_typeLmgtActuatorElement

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorElement" PLC data
type:

Parameter Data type Default Description

operationMode USInt 1 1 = Automatic mode, actuator works
according commands of control block; 0 =
actuator ignores commands of the con-
trol block
manualCommand Bool False 1 = escalate actuator in manual mode
partialPowerManual Real 0.0 Partial load of the actuator in manual
operation.
metaData "EnS_typeLmgtActuatorMeta" Actuator meta data
parameter "EnS_typeLmgtActuatorParameter" Parameters of actuator
status "EnS_typeLmgtActuatorStatus" Status information and actual values of
actuator

SIMATIC Energy Suite V19.0

324 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.2 EnS_typeLmgtActuatorMeta

Description of EnS_typeLmgtActuatorMeta

Description
The type contains the meta data of the actuator.

Structure of EnS_typeLmgtActuatorMeta

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorMeta" PLC data type:

Parameter Data type Default Description

name String[32] ‘Actuator Name of actuator
name’
plantIdentCode String[32] ‘’ Plant identification code
localIdentCode String[32] ‘’ Local identification code
uniqueID UDInt 0 Unique identification for position of actuator
unitPower UInt 1190 Unit of power value according to Energy Suite
actuatorType USInt 0 Actuator type: 0 =Not valid, 1 = Consumer, 2 = Producer, 3 = Stor-
age
acquisitionType USInt 0 Acquisition type: 0 = No actuator available, 1 = Analog power
value is connected, 2 = Switch state is connected, 3 = No feedback
controlType USInt 0 Control output type: 0 = No actuator available, 1 = Analog control
is connected, 2 = Boolean control is connected

B.1.4.3 EnS_typeLmgtActuatorParameter

Description of EnS_typeLmgtActuatorParameter

Description
The type contains the parameters of one actuator.

Structure of EnS_typeLmgtActuatorParameter

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorParameter" PLC data
type:

Parameter Data type Default Description

parameterSet USInt 1 1 = pararmeter set1 is used
2 = pararmeter set2 is used
parameterSet_1 "EnX_typeLmgtActuatorParameterSet" pararmeter set1 is used
parameterSet_2 "EnX_typeLmgtActuatorParameterSet" pararmeter set2 is used

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 325
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.4 EnS_typeLmgtActuatorParameterSet

Description of EnS_typeLmgtActuatorParameterSet

Description
The type contains one set of parameters for the actuator.

Structure of EnS_typeLmgtActuatorParameterSet

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorParameterSet" PLC
data type:

Parameter Data type Default Description

priority UInt 0 Priority of the actuator for de-/escalation, 1 = highest
priority. 0 = Disable the actuator
rollingIdentifier UInt 1 Rolling number of the actuator in the group
typicalPower Real 1.0E+10 Typical load of the actuator
standbyPower Real 0.0 Standby load of the actuator
partialConsumption Bool false Possibility of partial consumption by actuator
partialStateWaitTime UDInt 0 Wait time between switching in partial state in [s]
minDeescalationTime UDInt 0 Minimum time actuator is in deescalated state in [s]
minEscalationTime UDInt 0 Minimum time actuator is in escalated state in [s]
maxEscalationTime UDInt 0 Maximum time actuator can be in escalated state in
[s]
escalationDelayTime UDInt 0 Time the actuator needs to escalate in [s]
deescalationDelayTime UDInt 0 Time the actuator needs to deescalate in [s]

SIMATIC Energy Suite V19.0

326 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.5 EnS_typeLmgtActuatorStatus

Description of EnS_typeLmgtActuatorStatus

Description
The type contains the status information and actual values of the actuator.

Structure of EnS_typeLmgtActuatorStatus

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorStatus" PLC data
type:

Parameter Data type Default Description

connectionStatus Word 16#0 Connection status of the actuator
actPower Real 0.0 Actual power consumption of the actuator
escalationEnergy Real 0.0 Energy available for escalation
deescalationEnergy Real 0.0 Energy available for de-escalation
countEscalated ULInt 0 Counter for switching
countDeescalated ULInt 0 Counter for switching
connectTime UDInt 0 Current connect time in [s]
disconnectTime UDInt 0 Current disconnect time in [s]
inOutVariables "EnX_typeLmgtActuatorStatus- The current status of the in/out variables for
InOut" logging

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 327
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.6 EnS_typeLmgtActuatorStatusInOut

Description of EnS_typeLmgtActuatorStatusInOut

Description
The type contains the Feedback and control values of an actuator.

Structure of EnS_typeLmgtActuatorStatusInOut

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorInOut" PLC data
type:

Parameter Data type Default Description

enableActuator Bool false TRUE: Actuator is available for switching; FALSE: Actu-
ator is ignored by LMGT system
fedBoolean Bool false TRUE: Feedback signal from hardware shows that
actuator is ON; FALSE: Feedback signal from hardware
shows that actuator is OFF
fedAnalog Real 0.0 Feedback power value from hardware in [kW]
fedEnOActPower Real 0.0 Feedback signal of actuator as acquisition object
ctrlBoolean Bool false TRUE: LMGT system signals the actuator is ON; FALSE:
LMGT system signals the actuator is OFF;
ctrlAnalog Real 0.0 LMGT target value for power value of actuator
status Word 16#0 Status code of actuator
error Bool false TRUE: Error in actuator

SIMATIC Energy Suite V19.0

328 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.7 EnS_typeLmgtAlarmElement

Description of EnS_typeLmgtAlarmElement

Description
The type contains data for the alarming.

Structure of EnS_typeLmgtAlarmElement

Description
The following table shows the parameters of the "EnS_typeLmgtAlarmElement" PLC data
type:

Parameter Data type Default Description

timestamp Date_And_Time DT#1990-01-01-00:00:00 Timestamp of alarm
textListID UInt 0 ID of textlist entry which contains the alarm
message
additionalAlarmParame- Real 0.0 Additional parameter for alarm message, e. g.
ter value of limit violation

B.1.4.8 EnS_typeLmgtControlLimitConfig

Description of EnS_typeLmgtControlLimitConfig

Description
The type contains the limit configuration of the loadmanagement.

Structure of EnS_typeLmgtControlLimitConfig

Description
The following table shows the parameters of the "EnS_typeLmgtControlLimitConfig" PLC data
type:

Parameter Data type Default Description

avgPower LReal 0.0 Limit of average power for load management in
[kW]
limitPercentage Real 100.0 Percentage of average power limit which is
actually used for switching decisions in [%]
warningPercentage Real 80.0 Warning threshold of average power limit in [%]
alarmPercentage Real 90.0 Alarm threshold of average power limit in [%]

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 329
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.9 EnS_typeLmgtControlParameters

Description of EnS_typeLmgtControlParameters

Description
The type contains the parameters for the control block.

Structure of EnS_typeLmgtControlParameters

Description
The following table shows the parameters of the "EnS_typeLmgtControlParameters" PLC data
type:

Parameter Data type Default Description

setActiveParamSet USInt 0 Active parameter set 0 = paramSet1 to 4 =
paramset5
copyActiveParameters Bool false Copy active parameter set to standby
parameter set
activateSelectedParam- Bool false Copy current standby parameter set to
Set active parameter set.
currentStandbyParam- USInt 0 Standby parameter set selected by user 0
Set = paramset1 to 4 = paramset5
activeParameterSet EnS_typeLmgtControlParameterSet Active parameter set configuration data
standbyParameterSet Array[0..4] of Standby parameter set configuration data
"EnS_typeLmgtControlParameterSet"

SIMATIC Energy Suite V19.0

330 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.10 EnS_typeLmgtControlParameterSet

Description of EnS_typeLmgtControlParameterSet

Description
The type contains the configuration of the loadmanagement.

Structure of EnS_typeLmgtControlParameterSet

Description
The following table shows the parameters of the "EnS_typeLmgtControlParameters" PLC data
type:

Parameter Data type Default Description

limitConfig EnS_typeLmgtControlLimitConfig Limit variables for load management
timeConfig EnS_typeLmgtControlLimitConfig Time variables for load management

B.1.4.11 EnS_typeLmgtControlTimeConfig

Description of EnS_typeLmgtControlTimeConfig

Description
The type contains the time configuration for the loadmanagment.

Structure of EnS_typeLmgtControlTimeConfig

Description
The following table shows the parameters of the "EnS_typeLmgtControlTimeConfig" PLC data
type:

Parameter Data type Default Description

suppressionDelayDuration Real 5.0 Duration of the job suppression at the
beginning of the synchronization period
in [s]
limitToleranceSwitchingEnable Bool True True: Switching based on tolerance limit
during tolerance duration
limitToleranceStartValue Real 100.0 Starting value of the limit tolerance of the
average power in [%]
limitToleranceDuration Real 0.0 Duration of the limit tolerance beginning
after the suppression delay time in [s]
stabilizationDelayDuration Real 5.0 Duration of the stabilization delay time
after completing a job in [s]

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 331
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.12 EnS_typeLmgtEnergyDiagram

Description of EnS_typeLmgtEnergyDiagram

Description
The type contains the diagram configuration for the loadmanagment.

Structure of EnS_typeLmgtEnergyDiagram

Description
The following table shows the parameters of the "EnS_typeLmgtEnergyDiagram" PLC data
type:

Parameter Data type Default Description

maxPointsDiagram UInt 0 Maximum points in the diagram
currentPosition UInt 0 Current point in diagram
diagramPointsCurrentPeriod Array[0..899] of Real Diagram points in current period
diagramPointsLastPeriod Array[0..899] of Real Diagram points in last period

B.1.4.13 EnS_typeLmgtForecastValues

Description of EnS_typeLmgtForecastValues

Description
The type contains the forecast energy data for the load management.

Structure of EnS_typeLmgtForecastValues

Description
The following table shows the parameters of the "EnS_typeLmgtForecastValues" PLC data
type:

Parameter Data type Default Description

power LReal -1.0 The forecasted average power value at
the end of the period
energy LReal -1.0 The forecasted energy value at the end of
the period
valid Bool FALSE TRUE: forecast values are valid; FALSE:
forecast values are invalid

SIMATIC Energy Suite V19.0

332 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.14 EnS_typeLmgtGeneralData

Description of EnS_typeLmgtGeneralData

Description
The type contains the general data for the load management.

Structure of EnS_typeLmgtGeneralData

Description
The following table shows the parameters of the "EnS_typeLmgtGeneralData" PLC data type:

Parameter Data type Default Description

parameterSets "EnS_typeLmgtControlParameters" Configuration data of the complete load
management
forecastValues "EnS_typeLmgtForecastValues" Forecast values for average power and
energy at the end of the period
requestStack "EnS_typeLmgtJobRequestStack" Interface of Control and Actuators for job
requests
taskStack "EnS_typeLmgtJobTaskStack" Interface of Control and Actuators for job
tasks
escalatedPriorities Array[1..1999] of Bool Each index shows one priority. TRUE =
One or more actuators of the priority is
currently escalated
orgData "EnS_typeLmgtOrganisation" Time data of the period
triggerBackupRestore "EnS_typeLmgtTriggerBR" Trigger variables for logging functionality
criticalAlarms Array[0..9] of Buffer for the last 10 critical alarms
"EnS_typeLmgtAlarmElement"
visualization "EnS_typeLmgtVisualization" Contains relevant variables for the visuali-
zation

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 333
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.15 EnS_typeLmgtJobRequestElement

Description of EnS_typeLmgtJobRequestElement

Description
The type contains the job request data to the actuators.

Structure of EnS_typeLmgtJobRequestElement

Description
The following table shows the parameters of the "EnS_typeLmgtJobRequestElement" PLC data
type:

Parameter Data type Default Description

priority UInt 0 Priority of actuators
rollingID UInt 0 Rolling ID of actuators
countEscalated ULInt 0 Counter how often the actuators were
escalated
countDeescalated ULInt 0 Counter how often the actuators were de-
escalated
availEnergy LReal 0.0 Amount of energy which can be switched
by actuator
partialConsumption Bool false TRUE: If actuator can be switched partially
actuatorCounter UInt 0 Counter how many actuators are in the
same priority group and rolling ID
connectionStatus Word 16#0 Connection status of actuator

SIMATIC Energy Suite V19.0

334 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.16 EnS_typeLmgtJobRequestStack

Description of EnS_typeLmgtJobRequestStack

Description
The type contains the Data for the request stack.

Structure of EnS_typeLmgtJobRequestStack

Description
The following table shows the parameters of the "EnS_typeLmgtJobRequestStack" PLC data
type:

Parameter Data type Default Description

jobNumber ULInt 0 Continuous job number for identification
purposes
jobType UInt 0 0: No job active; 1: Escalation; 2: De-
escalation
deltaEnergy LReal 0.0 Amount of energy which is requested to
be switched
actuatorFeedback Array[0..9] of Feedback from actuators to the job
"EnS_typeLmgtJobRequestElement"

B.1.4.17 EnS_typeLmgtJobTaskElement

Description of EnS_typeLmgtJobTaskElement

Description
The type contains the task data to an actuator.

Structure of EnS_typeLmgtJobTaskElement

Description
The following table shows the parameters of the "EnS_typeLmgtJobTaskElement" PLC data
type:

Parameter Data type Default Description

priority UInt 0 Priority of actuators
rollingID UInt 0 Rolling ID of actuators
orderEnergy LReal 0.0 Amount of energy which should be
switched by actuators
percentOfUsedEnergy LReal 0.0 % of energy able to use by actuator.
partialConsumption Bool false TRUE: If actuator can be switched partially
actuatorCounter UInt 0 Counter how many actuators are in the
same priority group and rolling ID

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 335
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.18 EnS_typeLmgtJobTaskStack

Description of EnS_typeLmgtJobTaskStack

Description
The type contains the data for the task stack.

Structure of EnS_typeLmgtJobTaskStack

Description
The following table shows the parameters of the "EnS_typeLmgtJobTaskStack" PLC data type:

Parameter Data type Default Description

jobNumber ULInt 0 Continuous job number for identification
purposes
jobType UInt 0 0: No job active; 1: Escalation; 2: De-
escalation
actuatorTask Array[0..9] of Task for the actuators
"EnX_typeLmgtJobTaskElement"

B.1.4.19 EnS_typeLmgtOrganisation

Description of EnS_typeLmgtOrganisation

Description
The type contains periode concerning data for the load management.

Structure of EnS_typeLmgtOrganisation

Description
The following table shows the parameters of the "EnS_typeLmgtOrganisation" PLC data type:

Parameter Data type Default Description

periodTime LReal 0.0 Length of the load management period in
[s]
currentPeriodTime LReal 0.0 Current time of the load management
period in [s]
remainingPeriodTime LReal 0.0 Remaining time of the load management
period in [s]

SIMATIC Energy Suite V19.0

336 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.20 EnS_typeLmgtTriggerBR

Description of EnS_typeLmgtTriggerBR

Description
The type contains the triggers for the backup&restore block.

Structure of EnS_typeLmgtTriggerBR

Description
The following table shows the parameters of the "EnS_typeLmgtTriggerBR" PLC data type:

Parameter Data type Default Description

trigViolation Bool false TRUE: If actual energy of infeed increases
the energy limit
trigSwitching Bool false TRUE: If switching operation was per-
formed
trigLackOfActuators Bool false TRUE: If no actuators are availbale for
switching operation
trigBackup Bool false TRUE: Start the backup of the whole LMGT
configuration
trigRestore Bool false TRUE: Start the restore procedure to re-
cover the LMGT settings

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 337
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.21 EnS_typeLmgtVisualization

Description of EnS_typeLmgtVisualization

Description
The type contains the data for the visualization.

Structure of EnS_typeLmgtVisualization

Description
The following table shows the parameters of the "EnS_typeLmgtVisualization" PLC data type:

Parameter Data type Default Description

chosenVisuType UInt 0 0 = Energy, 1 = Power
actPowerInfeed LReal 0.0 Actual power value of infeed acquisition
object
actEnergyInfeed LReal 0.0 Actual energy value of infeed acquisition
object
limitEnergykWh LReal 0.0 Energy limit of LMGT system calculated
from average power limit
limitEscalationEnergykWh LReal 0.0 Actual energy limit including limit per-
centage
limitEscalationPowerkW LReal 0.0 Actual power limit including limit per-
centage
unitPower UInt 1190 Default value: kW
unitEnergy UInt 1179 Default value: kWh
amountActuators UInt 0 Amount of actuators configured for load
management
amountStorageActuators UInt 0 Amount of storage actuators configured
for load management
diagrams "EnS_typeLmgtEnergyDiagram" Diagram points for visualization
infeedName String " Name of infeed acquisition object
lmgtSystemName String " Name of load management system
error Bool false TRUE: Error in load management system

SIMATIC Energy Suite V19.0

338 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.22 EnS_typeLmgtStorageElement

Description of EnS_typeLmgtStorageElement

Description
The type contains data structure of a single storage actuator.

Structure of EnS_typeLmgtStorageElement

Description
The following table shows the parameters of the "EnS_typeLmgtStorageElement" PLC data
type.

Parameter Data type Default Description

operationMode USInt 1 1 = Automatic mode, actua-
tor works according to com-
mands of control block;
0 = actuator ignores com-
mands of the control block
manualCommand USInt 0 0= Idle,
1=Charge,
2=Discharge
metaData "EnS_typeLmgtStorageMeta" Meta data of actuator
parameter "EnS_typeLmgtStoragePara- Parameter set
meter"
status "EnS_typeLmgtStorageStatus" Status and InOut values of
actuator

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 339
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.23 EnS_typeLmgtStorageParameter

Description of EnS_typeLmgtStorageParameter

Description
The type contains the parameters of a single storage actuator.

Structure of EnS_typeLmgtStorageParameter

Description
The following table shows the parameters of the "EnS_typeLmgtStorageParameter" PLC data
type.

Parameter Data type Default Description

parameterSet USInt 1 1 = parameter set 1 is used,
2 = parameter set 2 is used
parameterSet_1 "EnS_typeLmgtStoragePara- Parameter Set 1
meterSet"
parameterSet_2 "EnS_typeLmgtStoragePara- Parameter Set 2
meterSet"

B.1.4.24 EnS_typeLmgtStorageParameterSet

Description of EnS_typeLmgtStorageParameterSet

Description
The type contains one set of parameters for the storage actuator.

Structure of EnS_typeLmgtStorageParameterSet

SIMATIC Energy Suite V19.0

340 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

Description
The following table shows the parameters of the "EnS_typeLmgtStorageParameterSet" PLC
data type.

Parameter Data type Default Description

priority UInt 0 Priority of the actuator for
de-/escalation,
1 = highest priority
0 = Disable the actuator
rollingIdentifier UInt 1 Rolling number of the actua-
tor in the group
currentMode USInt 0 0=Basic mode,
1=Advance mode
typicalPowerCharge Real 1.0E+10 Typical load of the actuator
while charging
typicalPowerDischarge Real 1.0E+10 Typical load of the actuator
while discharging
maxChargingLimit Real 0.0 Actuator cannot charge be-
yond this limit (%)
dischargingLimit Real 0.0 Actuator can discharge start-
ing from this limit (%)
chargingLimit Real 0.0 Actuator can charge starting
from this limit (%)
minDischargingLimit Real 0.0 Actuator cannot discharge
below this limit (%)
minChargingTime UDInt 0 Minimum time charging [s]
minDischargingTime UDInt 0 Minimum time discharging
[s]
maxDischargingTime UDInt 0 Maximum time discharging
[s]
dischargingDelayTime UDInt 0 Time the actuator needs to
escalate in [s]
chargingDelayTime UDInt 0 Time the actuator needs to
de-escalate in [s]

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 341
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.25 EnS_typeLmgtStorageMeta

Description of EnS_typeLmgtStorageMeta

Description
The type contains the meta data of the storage actuator.

Structure of EnS_typeLmgtStorageMeta

Description
The following table shows the parameters of the "EnS_typeLmgtStorageMeta" PLC data type.

Name Data type Default value Description

name String[32] 'Actuator name' Name of actuator
plantidentCode String[32] " Plant identification code
localidentCode String[32] " Local identification code
uniqueID UDInt 0 Unique identifier for actuator
position
unitPower UInt 1190 Unit of power value accord-
ing to Energy Suite,
1190=kW
mode USInt 0 0 = Can operate only in basic,
1 = Can operate in advance,
2 = Can operate in basic and
advance.
actuatorType USInt 0 Actuator Type:
0 = Not valid,
1 = Consumer,
2 = Producer,
3 = Storage
acquisitionType USInt 0 Acquisition type:
0 = No actuator available,
1 = Analog power value is
connected,
2 = Switch state is connect-
ed,
3 = Aquisition object is con-
nected,
4 = No feedback
controlType USInt 0 Control output type:
0 = No actuator available,
1 = Analog control is con-
nected,
2 = Boolean control is con-
nected.

SIMATIC Energy Suite V19.0

342 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.26 EnS_typeLmgtStorageStatus

Description of EnS_typeLmgtStorageStatus

Description
The type contains the status information and actual values of the storage actuator.

Structure of EnS_typeLmgtStorageStatus

Description
The following table shows the parameters of the "EnS_typeLmgtStorageStatus" PLC data type:

Parameter Data type Default Description

connectionStatus Word 16#0 Connection status of the actuator
stateOfCharge Real 0.0 State of charge in advance mode
actPower Real 0.0 Actual power consumption of the actua-
tor
escalationEnergy Real 0.0 Energy available for escalation
deescalationEner- Real 0.0 Energy available for de-escalation
gy
countEscalated ULInt 0 Counter for switching
countDeescalated ULInt 0 Counter for switching
connectTime UDInt 0 Current connect time in [s]
disconnectTime UDInt 0 Current disconnect time in [s]
inOutVariables "EnS_typeLmgtStorage- The current status of the in/out variables
StatusInOut" for logging

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 343
Energy Suite blocks - Load management
B.1 Energy Suite blocks for peak load management

B.1.4.27 EnS_typeLmgtStorageStatusInOut

Description of EnS_typeLmgtStorageStatusInOut

Description
The type contains the feedback and control values of a storage actuator.

Structure of EnS_typeLmgtStorageStatusInOut

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorInOut" PLC data
type:

Parameter Data type Default Description

id UInt 0 Identifier of actuator; number of data stor-
age for the actuator in the actuator list
enableActuator Bool false TRUE: Actuator is available for switching;
FALSE: Actuator is ignored by LMGT system
charge Bool false 1 = Can charge
discharge Bool false 1 = Can discharge
fedBoolean Bool false TRUE: Feedback signal from hardware shows
that actuator is ON;
FALSE: Feedback signal from hardware
shows that actuator is OFF
fedAnalog Real 0.0 Feedback power value from hardware in
[kW]
fedEnOActPower Real 0.0 Feedback signal of actuator as acquisition
object
ctrlBoolean Bool false TRUE: LMGT system signals the actuator is
ON;
FALSE: LMGT system signals the actuator is
OFF;
ctrlAnalog Real 0.0 LMGT target value for power value of actua-
tor
status Word 16#0 Status code of actuator
error Bool false TRUE: Error in actuator

SIMATIC Energy Suite V19.0

344 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2 Energy Suite blocks for base load management

B.2.1 Overview of Energy Suite blocks for base load management

How Energy Suite base load management works

There are two limits for the base load management system.
• A lower limit, which indicates an area, the average power value should never reach.
• An upper limit, which indicates an area, the average power value should as often reach as
possible.
• The area in between is the hysteresis. Within this area, the system neither escalates nor
de-escalates actuators.
Following diagram displays the different areas of the base load management

A set of functions that are vital for the basic functionality of the base load management.
• A basic function set consists of an Average block, a Control block, an Actuator block and the
Backup/Restore block.
• For the centralized storage concept, two data blocks are included, the GeneralData DB for
the general data and the ActuatorList DB for actuator related data.
The Average block gets input data from an acquisition object of an infeed, which is not part
of the base load management scope, but from the energy suite.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 345
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

The following picture shows how the Energy Suite base load management blocks work:

SIMATIC Energy Suite V19.0

346 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.2 Function blocks

B.2.2.1 EnS_BaseLmgt_AvgPower

Description of EnS_BaseLmgt_AvgPower

Description
The function block EnS_BaseLmgt_AvgPower calculates the average power and energy values
for every ‘x’ seconds (x being 10 by default), which is used as a basis for the base load
management.

Startup
The block has no start-up characteristics.
But the average can only be calculated after the synchronization period is up to date and valid
and the time interval for calculation has elapsed.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status" parameter contains
additional error information.

Parameters of EnS_BaseLmgt_AvgPower
The following table shows the function block of "EnS_BaseLmgt_AvgPower".

Parameters Declaration Data type Default Description

timeInterval I Int 10 The time considered
for average power
calculation(s)
infeedEnergyBasic I “EnS_typeEnergyBasic” Basic energy data
avgValues O “EnS_typeBase The average power
LmgtAvgValues” and energy values
Error O Bool false 1= Error occurred
Status O Word 16#0 Error Status infor-
mation
actPowerValues IO Array[*] of Real The actual power val-
ues in last time interval

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code (W#16#...) Description

0000 Done status value
8004 Error status for wrong input variables
8301 Incorrect input values during the archiving period in startup

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 347
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.2.2 EnS_BaseLmgt_Control

Description of EnS_BaseLmgt_Control

Description
The function block EnS_BaseLmgtControl contains the core functionality of the base load
management. It monitors the average power values to determine the escalation / de-
escalation of actuators, to ensure that the actual power demand remains within the upper
and lower limits. The average data is delivered by EnS_BaseLmgt_AvgPower block.
The control block identifies the power demand which must be escalated to avoid violation of
upper limit or power can be deescalated to avoid violation of lower limit. An escalation can
result in either shedding consumers or switching on generators to reduce power demand on
the grid. A de-escalation can result in switching on consumers and disconnecting generators.
The decision to deactivate or activate the actuators is taken by each instance of
EnS_BaseLmgtActuator_x individually, based on its actual condition, priority and parameter
setting.

Configuration mode
The load management control block has two sets of configuration data, the parameterSet_1
and the parameterSet_2. The input parameter ‘parameterSet’ defines which parameters shall
be used for the load management.
• User configuration: parameterSet = ‘1’
– parameterset1 are used as current configuration set
• Runtime configuration: parameterSet = ‘2’
– parameter set2 are used as current configuration set

Differential power:
If the average power goes above the upper limit,
Delta power = upper limit – average power
If the average power goes below the lower limit,
Delta power = average power – lower limit

Limit monitoring
The configured power limits (warning, alarm and limit violation) of the average value are
monitored.

SIMATIC Energy Suite V19.0

348 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Escalation
If the average power exceeds the configured upper limit, the LMGT determines the required
power which must be disconnected or connected to remain in between upper and lower
limits.
The LMGT control block sends a job request with the (delta) power, which shall be escalated.
• Consumer: switched OFF
• Producer: switched ON
• Storage: Discharged
De-escalation
If the average power is below the configured lower limit, the LMGT determines the delta
power which can be connected or disconnected to remain in the band between upper and
lower limits.
The LMGT control block sends a job request with the (delta) power, which shall be
deescalated.
• Consumer: switched ON
• Producer: switched OFF
• Storage: Charged

Stabilization time
After switching, i.e. sending a job for escalation or de-escalation, the next job is only started
after the stabilization time is elapsed.
The purpose of this time is to allow the system to react on the job. If the demand still is
pending, after the stabilization delay has elapsed, a new job with the updated demand is
sent.

Lack of Actuators and Switching

During a scenario when there are not enough actuators to meet the delta power
requirement, a signal is sent to EnS_BaseLmgtBackupRestore block to log the parameters of
Actuator list and General data. Every switching action also triggers the Backup restore block
to log the parameters of Actuator list and General data.

Startup
After restart of the PLC, the base load management is initialized and inactive until the next
synchronization period begins, and valid infeed data are available, i.e. no escalation or de-
escalation is performed.
All alarm messages are reset.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status" parameter contains
additional error information.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 349
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Parameters of EnS_BaseLmgt_Control
The following table shows the function block "EnS_BaseLmgt_Control":

Parameter Decla- Data type Default Description

ration
enableLmgt I Bool FALSE State of load management; FALSE: Inactive; TRUE:
Active
amountActuators I UInt 0 Amount of actuators configured for load manage-
ment
amountStorage- I UInt 0 Amount of storage actuators configured for load
Actuators management
infeedEnergy- I "EnS_typeEnergyBasic" Basic energy structure of the infeed acquisition
Basic object
infeedEnergy- I "EnS_typeEnergyMeta" Meta energy structure of the infeed acquisition
Meta object
error O Bool FALSE TRUE: Rising edge informs that an error occurred
during the execution of the FB
status O Word 16#0000 Current status of FB
lmgtData IO "EnS_typeLmgtGeneralData" All relevant data of the configured load manage-
ment

Parameter Status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code(W#16#...) Description

7000 Faultless
8001 Control is not called in a Cyclic Interrupt OB
8002 Wrong OB interval
8200 Parameter ‘Mode’ invalid
8201 Error in parameter parameterSet_2 limit
8202 Error in parameter parameterSet_2 time
8203 Error in parameter parameterSet_1 limit
8204 Error in parameter parameterSet_1 time
8301 Incorrect input values during the archiving period in startup
8400 Error in internal ENO status
8401 Error in Average block
9000 Base LMGT system is not enabled
9002 Lack of Actuators event occurred. Upper Limit was violated
9007 Lack of Actuators event occurred. Lower Limit was violated

SIMATIC Energy Suite V19.0

350 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Messages
The messages are implemented with the instruction ‘Program_Alarm’. The different messages
a multi-instance of the Program_Alarm block can be found in the static variables.

Message ID Message Text Message Class

8001 The FB is called in the wrong OB. It 0
needs to be a cyclic interrupt OB.
8002 The cyclic interrupt OB which calls the 0
FB has a cylic time larger than 1 second.
8200 Invalid value of the parameter 'parame- 0
terSet' in the parameter sets.
8201 Invalid value for at least one limit pa- 0
rameter in the parameterSet_2 set.
8202 Invalid value for at least one time pa- 0
rameter in the parameterSet_2 set.
8203 Invalid value for at least one limit pa- 0
rameter in the parameterSet_1 set.
8204 Invalid value for at least one time pa- 0
rameter in the parameterSet_1 set.
8400 Error in the infeed acquisition object. 0
9000 Peak load management deactivated. 0
9002 No actuators are available. Upper limit 0
violated
9003 Average power warning threshold 0
reached for upper limit.
9004 Average power alarming threshold 0
reached for upper limit.
9005 Average power warning threshold 0
reached for lower limit.
9006 Average power alarming threshold 0
reached for lower limit.
9007 No actuators are available. Lower limit 0
violated

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 351
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.2.3 EnS_BaseLmgtActuator_x

Description of EnS_BaseLmgtActuator_x

Description
The function block EnS_BaseLmgtActuator_x contains the functionality of an actuator for
evaluation of status, feedback and control logic considering the job information, which the
EnS_BaseLmgt_Control_x provides regarding the delta power, which is required to stay
between the upper and lower limits
Different types shall be implemented for the actuator, depending on which type the actuator
is.
For each type a distinct FB shall be implemented, with “x” serving as placeholder for the
actuator type.

Actuator types

Actuator Description
type
Consumer Consumes power/ energy while switched on, Releases power on escalation
Producer Produce power/ energy while switched on, Provides power on escalation
Storage Both produces and consumes power/energy while switched on. Releases power or
consumes power based on escalation/de-escalation

Configuration mode
The load management actuator block has two sets of configuration data, the parameter set1
and the parameter set2.
The input parameter ‘parameterSet’ defines which parameters shall be used for the load
management.
• User configuration: parameterSet 1 = ‘1’
→ parameterSet 1 are used as current configuration set
• Runtime configuration: parameterSet 2= ‘2’
→ parameterSet 2 are used as current configuration set
You can activate either Parameter set1 or Parameter set2 based on the requirements from the
Load management runtime faceplates.

Priority list
The priority list contains the information about the sequence, in which actuators shall be
escalated and de-escalated. The sequence of the actuators is determinend during runtime
and can be changed at any time, only when the actuator is de-escalated. The action then will
instantly take effect.

SIMATIC Energy Suite V19.0

352 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Priority
The actuators are switched in a sequence, which is given by the priority list.
• Priority “0” - All calculations are stopped and disables the actuator for the respective Load
management system.
• Priority “1” is the highest priority (Lowest priority from the process point of view).
Priority order for escalation is ascending (e. g. 1,2,3, …), so actuators with a low priority
number (e. g. 1) are escalated before those with higher numbers, and therefore escalated
more often.
Priority order for de-escalation is descending (e. g. 3, 2, 1), so actuators with a high priority
number (e.g. 10) are de-escalated before those with a low priority number (because they are
more relevant for the process).

Note
At any time, only one actuator/ group from the current priority will be escalated. If an
actuator (priority) was switched the program will continue with the next priority from the
priority list. (The actuators of only one rolling ID are escalated at the same time within a
rolling sequence. -> Several actuators can have the same prio & rollID)

Priority groups
Actuators with the same priority (priority) and rolling sequence identifier (rollingIdentifier)
belong to a priority group and are always switched at the same time (in the same cycle).

Rolling sequence
Actuators with the same priority (priority) and different rolling sequence identifiers
(rollingIdentifier) belong to a rolling sequence. Actuators are switched alternating, whereas
actuators with the same rolling sequence identifier are switched at the same time (in the
same cycle).

Procedure
Each actuator instance checks its status and the request stack for incoming jobs at its call. The
actuator then determines autonomously, due to the parameters and current state, if it can
serve the request. The result of the determination is written back into the request stack, as
feedback for the LMGT Control block and the next actuator will be called.
In the next cycle the LMGT Control block will evaluate the feedback from the actuators and
will write a corresponding job into the task stack.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 353
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

This task includes the priority and rolling ID, as well as the power which should be de-/
escalated. Each actuator instance checks if it is part of this priority and rolling ID, and
performs the switching action, if so.

Switching sequence example

• Start with priority number 1 (Highest priority)
• Consider priority:
Example:
Actuator 1: priority = 1, rollingIdentifier = 1 → switching order = 1
Actuator 2: priority = 2, rollingIdentifier = 1 → switching order = 2
Actuator 3: priority = 10, rollingIdentifier = 1 → switching order = 3
• Consider priority group:
Actuators in a priority group (rolling sequence identifier = 1)
Example:
Actuator 1: priority = 5, rollingIdentifier = 1 → switching order = 1
Actuator 2: priority = 5, rollingIdentifier = 1 → switching order = 1
Actuator 3: priority = 5, rollingIdentifier = 1 → switching order = 1

SIMATIC Energy Suite V19.0

354 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

• Consider priority group and rolling sequence:

Actuators in a priority group and different rolling sequence identifier
Example:
Actuator 1: priority = 5, rollingIdentifier = 2 → switching order = 2
Actuator 2: priority = 5, rollingIdentifier = 1 → switching order = 1
Actuator 3: priority = 5, rollingIdentifier = 3 → switching order = 3
• Actuators in a priority group and the same rolling sequence identifier
Example:
Actuator 1: priority = 5, rollingIdentifier = 2 → switching order = 2
Actuator 2: priority = 5, rollingIdentifier = 2 → switching order = 2
Actuator 3: priority = 5, rollingIdentifier = 1 → switching order = 1

Power values
The power values, which are required for the escalation and de-escalation logic, are written
to the structure ‘status’ in the EnS_ActuatorList DB.
• actPower:
Actual power value, which is derived from the feedback (feedbackBoolean (for consumers
and producers) / feedbackState (for storage) / feedbackAnalog ) and / or the typical power
• escalationPower:
Power value which is available for escalation (considering connect / disconnect times and
dead times)
• deescalationPower:
Power value which is available for de-escalation (considering connect / disconnect times
and dead times)
actPower = actual Power (input actPower) or typical/ standby Power (from configuration) de-
/escalationPower = |average power -limit|

Feedback
Four different types of feedback are supported for the actuator:
1. Power value: Actual power value (fedAnalog) shall be considered, when acknowledging
escalation / de-escalation.
2. Acquisition object: Feedback from an acquisition object of the Energy Suite.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 355
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

3. Status feedback:
– Consumers/Producers: The switch status (fedBoolean) delivers the on / off status of the
actuator. The configured typical/ standby power value shall be considered, when
acknowledging escalation / de-escalation
– Storage: The status feedback(fedState) delivers the Idle(0)/Charge(1)/Discharge(2)
status of the actuator. The configured typical powers for charging and discharging
shall be considered, when acknowledging escalation/de-escalation.
4. No feedback: The feedback is determined by the block assuming the status as the control
output (ctrlAnalog along with ctrlBoolean(consumers/producers)/ctrlState(storage)). The
configured typical power value (typical/ standby Power) will be considered, when
acknowledging escalation / de-escalation.

Escalation
Different commands are set depending on the actuator types (actuatorType), when an
escalation request (jobType = 1) has been received and the block gets the order that the
actuator shall escalate:
1. Consumer: Disconnect (controlBoolean = FALSE)
2. Producer: Connect (controlBoolean = TRUE)
3. Storage: Discharge (controlState= 2)

De-escalation
Different commands are set depending on the actuator types (actuatorType), when a de-
escalation request (jobType = 2) has been received and the block gets the order that the
actuator shall de-escalate:
1. Consumer: Connect (controlBoolean = TRUE)
2. Producer: Disconnect (controlBoolean = FALSE)
3. Storage: Charge (controlState = 1)

Partial load functionality (Consumers / Producers)

With the parameter “partialConsumption” the partial load functionality of an Actuator can be
enabled. That means that the power demand or the power supply of the actuator can be
varied
(0 - 100%). The actuator power amount which is as close as possible to the delta power and
will reduce/ expand power consumption accordingly.
This variable power value calculated is internally handled as percentage value, so in case of a
priority group of actuators with different nominal power each actuator determines the
absolute value accordingly.
The partial load function will only be used by the last actuator of the priority group in the task
job, if it is a partial load actuator. Otherwise the actuator will be switched at once.
With the parameter "partialStateWaitTime", a wait time between switching actions in partial
state can be configured. When actuator is in partial consumption state, it will wait for the
time configured in 'partialStateWaitTime' before escalating / de-escalating.

SIMATIC Energy Suite V19.0

356 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Connect and disconnect times (Consumers / Producers)

Refer below example for Consumer actuator:
For the switching of actuators minimum connect time (minDeescalationTime), minimum
disconnect time (minEscalationTime) and maximum disconnect time (maxEscalationTime)
have to be considered.
• Minimum connect time → relevant for escalation
The minimum connect time is the minimum time, which the actuator has to be connected
100%. The actuator can only be disconnected after the minimum connect time has elapsed.

If the minimum connect time has not yet elapsed, the actuator will not escalate.
The minimum disconnect time is the minimum time, which the actuator has to be
disconnected 100%. The actuator can only be connected after the minimum disconnect time
has elapsed.

If the minimum disconnect time has not yet elapsed, the actuator will not be deescalated
Maximum disconnect time → relevant for escalation

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 357
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

The maximum disconnect time is the maximum time, which the actuator can be
disconnected or partially connected. The actuator has to be connected (100%) after the
maximum disconnect time has elapsed.

Dead time for escalation

The dead time (escalationDelayTime) shall be considered for each actuator to determine the
amount of power, which can be contributed by escalating the actuator. If the delay time is
greater than zero, the escalation gets effective and the power will be calculated based on
linear ramp up and ramp down approach. This results in less power, which the actuator can
contribute to the LMGT.

SIMATIC Energy Suite V19.0

358 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Dead time for de-escalation

The dead time (deescalationDelayTime) shall be considered for each actuator to determine
the amount of power, which is added after deescalating the actuator. If the delay time is
greater than zero, the de-escalation gets effective and the power will be calculated based on
linear ramp up and ramp down approach. This results in less power, which the actuator
consumes after activating it.

Storage Actuator
The storage actuator can operate in 3 states: Idle (0), Charge (1), Discharge (2). The storage
can operate in Basic mode or Advance mode. In basic mode, the inputs charge and discharge
influence the behavior of storage in the following manner:

Charge Discharge Behavior of Storage

TRUE TRUE Actuator takes part in escalation and
de-escalation jobs
TRUE FALSE • Actuator takes only part in de-
escalation jobs
• Actuator goes in idle (= not charg-
ing, not discharging) if LMGT tries
to escalate
FALSE TRUE • Actuator takes only part in escala-
tion jobs
• Actuator goes in idle if LMGT tries to
de-escalate
FALSE FALSE Acutator ignores every job and is in idle

In advance mode, inputs charge/discharge and SOC(State of Charge) influence the behavior
of storage.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 359
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Parameters for Advance mode operation:

• Max Charging limit (%): The SOC cannot exceed the max. charging limit. The actuator will
ignore de-escalation jobs from the LMGT if the SOC equals the max. charging limit
• Discharging limit (%): The SOC can exceed the discharging limit within one job. After the
job is finished, the actuator only accepts escalations or is idle for de-escalations from the
LMGT.The discharging limit must be between max. charging limit and min. discharging
limit.The discharging limit cannot be smaller than the charging limit
• Charging limit (%): The SOC can go below the charging limit within one job. After the job
is finished, the actuator only accepts de-escalations or is idle for escalations from the
LMGT. The charging limit must be between max. charging limit and min. discharging limit.
The charging limit cannot be greater than the discharging limit.
• Min Discharging limit (%): The SOC cannot go below the min. discharging limit. The
actuator will ignore escalation jobs from the LMGT if the SOC equals the min. discharging
limit.

Note
These parameters are in percentage (%) and value should be between 0 to 100.

Time parameters for storage:

The timing parameters are interpreted as below:
• minChargingTime = minDeescalationTime, minimum time it must be in charging state
• minDischargingTime = minEscalationTime, minimum time it must be in discharging state
• maxDischargingTime = maxEscalationTime, maximum time it can be in discharging state
after which it is moved to Idle state
• dischargingDelayTime = escalationDelayTime (applicable only in Idle state), delay time
taken to discharge
• chargingDelayTime = deescalationDelayTime (applicable only in Idle state), delay time
taken to charge

Job management
Escalation and de-escalation requests are received as jobs within the LMGT system. The block
must be able to evaluate the jobs and the parameters of the LMGT system and reacts
accordingly. For more details see section Job Concept - De-/ Escalation sequence.

Startup
The block “EnS_BaseLmgtActuator_x” has no start up characteristic.

SIMATIC Energy Suite V19.0

360 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status" parameter contains
additional error information.

Parameters of EnS_BaseLmgtActuator_x
The following table shows the parameters of the function block
"EnS_LmgtActuator_Consumer/EnS_LmgtActuator_Producer":

Parameter Decla- Data type Default Description

ration
id I UInt 0 Identifier of actuator; number of data storage for the
actuator in the actuator list
enableActuator I Bool False Release for the actuator to participate the load man-
agement; FALSE: Inactive; TRUE: Active
fedBoolean I Bool False The boolean feedback for the actuator to identify the
result of a switching action
fedAnalog I Real 0.0 The analog feedback for the actuator to identify the
result of a switching action [kW]
hwFault I Bool False Error indicator from the connected switching hard-
ware; TRUE = error in device
hwStatus I Word 16#0 Status information from an intelligent device; could
indicate an error
actuatorEnergy- I "EnS_typeEnergyBasic" - Basic energy structure of an acquisition object
Basic
actuatorEnergy- I "EnS_typeEnergyMeta" - Energy Meta structure of an acquisition object
Meta
ctrlBoolean O Bool FALSE The signal to switch a binary actuator; TRUE = switch
off
ctrlAnalog O Real 0.0 The set point consumption for the actuator [kW]
error O Bool FALSE TRUE: Rising edge informs that an error occurred dur-
ing the execution of the FB
status O Word 16#0000 Current status of FB
actuatorList IO Array[*] of - Load management configuration data
"EnS_typeLmgtActuator-
Element"
lmgtData IO "EnS_typeLmgtGeneral- - All relevant data of the configured load management
Data"

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 361
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

The following table shows the parameters of function block EnS_LmgtActuator_Storage.

Parameter Declara- Data Type Default Description

tion
id I UInt 0 Identifier of actuator; num-
ber of data storage for the
actuator in the actuator list
enableActuator I Bool False Release for the actuator to
participate the load man-
agement; FALSE: Inactive;
TRUE: Active
fedState I USInt 0 The status feedback, 0-Idle,
1-Charge, 2-Discharge
fedAnalog I Real 0.0 The analog feedback for the
actuator to identify the result
of a switching action [kW]
hwFault I Bool False Error indicator from the con-
nected switching hardware;
TRUE = error in device
hwStatus I Word 16#0 Status information from an
intelligent device; could
indicate an error
actuatorEner- I EnS_typeEnergyBasic - Basic energy structure of an
gyBasic acquisition object
actuatorEner- I EnS_typeEnergyMeta - Energy Meta structure of an
gyMeta acquisition object
mode I USInt 0 0= only basic, 1= only ad-
vance, 2= basic and advance
charge I Bool True 1= can charge
discharge I Bool True 1= can discharge
stateOfCharge I Real 0.0 State of charge in advance
mode (%)
ctrlState O USInt 0 0=Idle, 1=Charge,
2=Discharge
ctrlAnalog O Real 0.0 The set point consumption
for the actuator [kW]
error O Bool False TRUE: Rising edge informs
that an error occurred during
the execution of the FB
status O Word 16#000 Current status of FB
0
actuatorList IO Array[*] of - Load management configu-
"EnS_typeLmgtStorage- ration data
Element"
lmgtData IO "EnS_typeLmgtGeneral- - All relevant data of the con-
Data" figured load management

SIMATIC Energy Suite V19.0

362 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description

(W#16#...)
8001 ERROR_OP_MODE_WRONG
8002 ERROR_PAR_MODE_WRONG
8003 ERROR_CHANGE_PRIO_ESC
8004 ERROR_ACTUATOR_DISABLED
8201 ERROR_PARAM_ID
8211 ERROR_PARAM_ACTUATOR_TYPE
8212 ERROR_PARAM_ACQ_TYPE
8213 ERROR_PARAM_CTRL_TYPE
8221 ERROR_PARAM_SET1_POWER_LEVEL
8222 ERROR_PARAM_SET1_PRIO
8223 ERROR_PARAM_SET1_ROLLING_ID
8224 ERROR_PARAM_SET1_PARTIAL
8225 ERROR_PARAM_SET1_TIME
8226 ERROR_PARAM_SET1_ACTUATOR_DISABLED
8227 ERROR_PARAM_SET1_CHARGE_LIMIT
8228 ERROR_PARAM_SET1_MODE
8231 ERROR_PARAM_SET2_POWER_LEVEL
8232 ERROR_PARAM_SET2_PRIO
8233 ERROR_PARAM_SET2_ROLLING_ID
8234 ERROR_PARAM_SET2_PARTIAL
8235 ERROR_PARAM_SET2_TIME
8236 ERROR_PARAM_SET2_ACTUATOR_DISABLED
8237 ERROR_PARAM_SET2_CHARGE_LIMIT
8238 ERROR_PARAM_SET2_MODE
8241 ERROR_PARAM_FEDSTATE
8401 ERROR_WRONG_FEEDBACK_SIGNAL
8601 ERROR_WRONG_OB
8602 ERROR_INTERRUPT_TOO_LONG

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 363
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Messages
The messages are implemented with the instruction ‘Program_Alarm’. The different messages
a multi-instance of the Program_Alarm block can be found in the static variables.

Message ID Message text Message class

8001 Wrong operating mode 0
8002 Wrong parameter mode 0
8003 Cannot change priority when actuator is escalated 0
8004 Actuator disabled for load management
8201 Wrong parameter ID 0
8211 Wrong configuration: actuator type 0
8212 Wrong configuration: acquisition type 0
8213 Wrong configuration: control type 0
8214 Wrong loop index
8221 Wrong parameter configuration pararmeter set1: power level 0
8222 Wrong parameter configuration pararmeter set1: priority 0
8223 Wrong parameter configuration pararmeter set1 : rolling ID 0
8224 Wrong parameter configuration pararmeter set1 : partial consumption
8225 Invalid value for atleast one time parameter in pararmeter set1
8226 Actuator disabled for load management, parameter set1: priority 0
8227 Invalid value for at least one charge/discharge limit in parameter set 1
8228 Wrong parameter configuration parameter set 1: current mode
8231 Wrong parameter configuration pararmeter set2 is used : power level 0
8232 Wrong parameter configuration pararmeter set2: priority 0
8233 Wrong parameter configuration pararmeter set2: rolling ID 0
8234 Wrong parameter configuration pararmeter set2 : partial consumption
8235 Invalid value for atleast one time parameter in pararmeter set2
8236 Actuator disabled for load management, parameter set2: priority 0
8237 Invalid value for at least one charge/discharge limit in parameter set 2
8238 Wrong parameter configuration parameter set 2: current mode
8241 Invalid feedback state
8242 SOC attained maximum charging limit
8243 SOC attained minimum discharging limit
8401 Hardware feedback signal does not correspond actuator state
8601 Block call in wrong OB 0
8602 Interrupt time of OB too long 0

Response status
The following table shows the response status of the block on receiving a job request:

Status Description
16#7100 STATUS_REQ_RESPONDED
16#7110 STATUS_REQ_DENIED
16#7200 STATUS_NEW_JOB_ESCALATION
16#7210 STATUS_NEW_JOB_DEESCALATION

SIMATIC Energy Suite V19.0

364 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.2.4 EnS_BaseLmgtBackupRestore

Description of EnS_BaseLmgtBackupRestore

Description
The function block EnS_BaseLmgtBackupRestore provides the functionality to write logging/
configuration data to the SD-Card of the PLC. In case of a limit violation, switching action or a
lack of actuators, configuration data and runtime data is written to an appropriate file under
the folder “UserFiles” onto the memory card.
Also the block saves and restores configuration data of the actuators and load management
system, in this folder on the SD-Card by user command.

Switching action
When ever a switching action is performed by one of the LmgtActuator blocks, the relevant
data from the "EnS_LmgtGeneralData" and "EnS_ActuatorList" is read out and written to the
SD-Card of the PLC. This logging is triggered from the LmgtControl block with the command
"trigSwitching" within the structure "triggerBackupRestore" in the "EnS_LmgtGeneralData" DB.
The data will be stored under ‘UserFiles/’ in the file named "<LMGT
name>_SwitchEvnt_xx.bin". The storage actuator data is logged in file "<LMGT name>_
Switch- Evnt _Storagexx.bin". The events will be written continuously into the file. If the
maximum size of the file (16 MB) is reached, a new file will be created with incremented file
number xx. Each new dataset begins with the timestamp of the event.

Lack of Actuators
When the control block wants to escalate a job but there is no appropriate feedback from the
actuators, this event is handled as ‘Lack of actuators’. That means no actuator can handle this
request and a limit violation will occur if this status will stay.
This event can occur due to wrong settings of the actuators, priority list or general
parameters. This event will be logged under ‘UserFiles/’ in the file named ‘<LMGT
name>_LackActuators_xx.bin’. The storage actuator data is logged in file "<LMGT name>_
LackActuators _Storagexx.bin" The events will be written continuously into the file. If the
maximum size of the file is reached, a new file will be created with incremented file number
xxx. Each new dataset begins with the timestamp of the event.
The maximum number of files can be selected by the input parameter ‘amountLogFiles’.

Backup & restore

The user can create a backup of the current configuration data.
When saving the configuration in the SCADA system or on trigger (input parameter backup =
TRUE) the LMGT configuration with all RT parameters comprising general, infeed and actuator
settings will be archived. The backup will be stored on a permanent location on the PLC
(memory card of the PLC).
The configuration can be restored by setting the input parameter restore.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 365
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Backup
When the command ‘triggerBackup’ is triggered, the current configuration of the actuators
and the load management will be read out and saved into a backup file on the SD-Card of the
PLC.
The file will be stored under ‘UserFiles/’ name ‘<LMGT name>_ConfigBackup.bin’. The storage
actuators data is stored in ‘<LMGT name>_StorageBackup.bin’.

Restore
When the command ‘trigRestore’ is triggered a new configuration will be read out from the
backup file, which has to be stored on the SD-Card of the PLC, and overwrites the current
one.

Prerequisite
To restore a backup file from the SD-Card back to the LMGT Configuration the following
prerequisites have to be fulfilled.
• A backup file named "<LMGT name>_ConfigBackup.bin" has to be stored under ‘UserFiles/’
on the memory card of the PLC. To restore storage data, file named "<LMGT
name>_StorageBackup.bin" has to be stored on PLC.
• The file must be of a binary format which match the internal data structure (generation
with the provided converter tool)

CAUTION

The System can not analyse or check the restore file about correct data. If the restore
file is loaded into the system, the config data will be written into the parameter
sections and will take effect immediately!

Characteristics
Due to performance reasons of the PLC, the files are written in a binary form. The data can be
converted with a supplied converting tool to get a readable structure (CSV file).

File generation
Depending on the trigger, different files will be created by the EnS_BaseLmgtBackupRestore
block.
• Switching action – Filename with name "<LMGT name>_SwitchEvnt_xx.bin"
• Lack of actuators – Filename "<LMGT_name>_LackActuators_xx.bin"
• Backup configuration – Filename "<LMGT name>_ConfigBackup.bin"
(Only one file is generated, file will be overwritten)
With xx as consecutive number until the maximum number of files, defined by the input
parameter ‘amountLogFiles’.

SIMATIC Energy Suite V19.0

366 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Access to files
The generated files can be accessed by using the web server of the PLC. Therefore the web
server has to be activated under the device configuration, General - Web server.

CAUTION

Created files from the system should not be deleted by the user! Because of the consecutive
data writing of the backup & restore function, otherwise, the system will not know where to
continue. This will lead to errors and abort the logging function for further execution.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 367
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

And at least the rights for read, write, delete files must be given in the user management.

Reaction to error
When an error occurs, the output parameter "error" is set. The "Status" parameter contains
additional error information.

Parameters of EnS_BaseLmgtBackupRestore
The following table shows the function block "EnS_BaseLmgtBackupRestore":

Parameter Decla- Data type Default Description

ration
amountLogFiles I UInt 10 Amount of log files for each log file type
busy O Bool false Block is busy
error O Bool false Error occured while processing
status O Word 16#0 Detail information of error
mode O USInt 0 Actual processing mode
lmgtData IO "EnS_typeLmgtGeneral- Loadmanagement general data struct
Data"
actuatorList IO Array[*] of Actuator configuration data struct
"EnS_typeLmgtActuator-
Element"
storageList IO Array[*] of Storage configuration data struct
"EnS_typeLmgtStorage-
Element"

SIMATIC Energy Suite V19.0

368 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

Parameter status
The following table shows the error codes that are generated at the "status" output
parameter when errors occur:

Error code Description

(W#16#...)
80B3 There is not enough space on the memory card
80B4 The memory card or file is write-protected
80C3 The maximum number of simultaneously active FileWriteC instructions has already been reached
8091 Corresponding backup-file (Userfile\LMGT name) not found on SD-Card
8093 Error in corresponding log file. New log file was created
8094 The maximum length of the log file is reached

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 369
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.3 Data blocks

B.2.3.1 EnS_BaseLmgtGeneralData

Description of EnS_BaseLmgtGeneralData

Description
The data block "EnS_BaseLmgtGeneralData" contains the major data for the base load
management.

Structure of EnS_BaseLmgtGeneralData

Description
The data block "EnS_BaseLmgtGeneralData" contains the major data for the load
management.

Element Data type Description

actPower Array[0..99] of Real The array of actual power values.
generalData "EnS_typeBaseLmgtGeneralData" The relevant data for base load man-
agement.

SIMATIC Energy Suite V19.0

370 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.3.2 EnS_BaseLmgtActuatorList

Description of EnS_BaseLmgtActuatorList

Description
The global data block "EnS_BaseLmgtActuatorList" contains the parameters, config data and
priority list of all actuators.

Structure of EnS_BaseLmgtActuatorList

Description

Element Data type Description

Actuators Array[0..3] of Array of max number of actuators with
“EnS_typeBaseLmgtActuatorElement” corresponding data
StorageActuators Array[0..0] of Array of max number of storage actua-
“EnS_typeBaseLmgtStorageElement” tors with corresponding data

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 371
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4 User-defined data types (UDTs)

B.2.4.1 EnS_typeBaseLmgtActuatorElement

Description of EnS_typeBaseLmgtActuatorElement

Description
The type contains the data structure of one actuator.

Structure of EnS_typeBaseLmgtActuatorElement

Description
The following table shows the parameters of the "EnS_typeLmgtActuatorElement" PLC data
type:

Parameter Data type Default Description

operationMode USInt 1 1 = Automatic mode, actuator works
according commands of control block; 0 =
actuator ignores commands of the con-
trol block
manualCommand Bool False Disconnect the actuator in manual opera-
tion mode: 1 = escalate actuator
partialPowerManual Real 0.0 Partial load of the actuator in manual
operation mode.
metaData "EnS_typeLmgtActuatorMeta" Actuator meta data
parameter "EnS_typeLmgtActuatorParameter" Parameter sets of actuator
status "EnS_typeBaseLmgtActuatorStatus" Status information and InOut values of
actuator

SIMATIC Energy Suite V19.0

372 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.2 EnS_typeBaseLmgtActuatorStatus

Description of EnS_typeBaseLmgtActuatorStatus

Description
The type contains the status information and actual values of the actuator.

Structure of EnS_typeBaseLmgtActuatorStatus

Description
The following table shows the parameters of the "EnS_typeBaseLmgtActuatorStatus" PLC data
type:

Parameter Data type Default Description

connectionStatus Word 16#0000 Connection status of the actuator
actPower Real 0.0 Actual power consumption of the actuator
escalationEnergy Real 0.0 Power available for escalation
deescalationEnergy Real 0.0 Power available for de-escalation
countEscalated ULInt 0 Counter for switching
countDeescalated ULInt 0 Counter for switching
connectTime UDInt 0 Current connect time in [s]
disconnectTime UDInt 0 Current disconnect time in [s]
inOutVariables "EnX_typeLmgtActuatorStatus- The current status of the in/out variables for
InOut" logging

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 373
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.3 EnS_typeBaseLmgtControlLimitConfig

Description of EnS_typeBaseLmgtControlLimitConfig

Description
The type contains the limit configuration of the load management.

Structure of EnS_typeBaseLmgtControlLimitConfig

Description
The following table shows the parameters of the "EnS_typeBaseLmgtControlLimitConfig" PLC
data type:

Parameter Data type Default Description

avgPowerHighLimit LReal 0.0 Upper limit of average power for load manage-
ment in [kW]
avgPowerLowLimit LReal 0.0 Lower limit of average power for load manage-
ment in [kW]
limitPercentage Real 100.0 Percentage of average power limit which is
actually used for switching decisions in [%]
warningPercentage Real 80.0 Warning threshold of average power limit in [%]
alarmPercentage Real 90.0 Alarm threshold of average power limit in [%]

SIMATIC Energy Suite V19.0

374 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.4 EnS_typeBaseLmgtControlParameters

Description of EnS_typeBaseLmgtControlParameters

Description
The type contains the parameters for the control block.

Structure of EnS_typeBaseLmgtControlParameters

Description
The following table shows the parameters of the "EnS_typeLmgtControlParameters" PLC data
type:

Parameter Data type Default Description

parameterSet USInt 1 1 = pararmeter set1 is used,
2 = parameter set 2 is used
parameterSet_1 EnS pararmeter set1 configuration data
_typeBaseLmgtControlParameterSet
parameterSet_2 EnS pararmeter set2 configuration data
_typeBaseLmgtControlParameterSet

B.2.4.5 EnS_typeBaseLmgtControlParameterSet

Description of EnS_typeBaseLmgtControlParameterSet

Description
The type contains the configuration of the load management.

Structure of EnS_typeBaseLmgtControlParameterSet

Description
The following table shows the parameters of the "EnS_typeBaseLmgtControlParameters" PLC
data type:

Parameter Data type Default Description

limitConfig EnS_typeBaseLmgtControlLimit- Limit variables for load management
Config
timeConfig EnS_typeBaseLmgtControlLimit- Time variables for load management
Config

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 375
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.6 EnS_typeBaseLmgtControlTimeConfig

Description of EnS_typeBaseLmgtControlTimeConfig

Description
The type contains the time configuration for the load managment.

Structure of EnS_typeBaseLmgtControlTimeConfig

Description
The following table shows the parameters of the "EnS_typeBaseLmgtControlTimeConfig" PLC
data type:

Parameter Data type Default Description

stabilizationDelayDuration Real 10.0 Duration of the stabilization delay time
after completing a job in [s]

B.2.4.7 EnS_typeBaseLmgtGeneralData

Description of EnS_typeBaseLmgtGeneralData

Description
The type contains the general data for the load management.

Structure of EnS_typeBaseLmgtGeneralData

Description
The following table shows the parameters of the "EnS_typeBaseLmgtGeneralData" PLC data
type:

Parameter Data type Default Description

timeInterval Int 0 The time considered for average power
calculation[s]
parameterSets "EnS_typeBaseLmgtControl- Configuration data of the complete load
Parameters" management
avergaeValues "EnS_typeBaseLmgtAvgValues" Forecast values for average power and
energy at the end of the period
requestStack "EnS_typeLmgtJobRequestStack" Interface of Control and Actuators for job
requests
taskStack "EnS_typeLmgtJobTaskStack" Interface of Control and Actuators for job
tasks
escalatedPriorities Array[1..1999] of Bool Each index shows one priority. TRUE =
One or more actuators of the priority is
currently escalated
orgData "EnS_typeLmgtOrganisation" Time data of the period
triggerBackupRestore "EnS_typeLmgtTriggerBR" Trigger variables for logging functionality
criticalAlarms Array[0..9] of Buffer for the last 10 critical alarms
"EnS_typeLmgtAlarmElement"

SIMATIC Energy Suite V19.0

376 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.8 EnS_typeBaseLmgtJobRequestElement

Description of EnS_typeBaseLmgtJobRequestElement

Description
The type contains the job request data to the actuators.

Structure of EnS_typeBaseLmgtJobRequestElement

Description
The following table shows the parameters of the "EnS_typeBaseLmgtJobRequestElement" PLC
data type:

Parameter Data type Default Description

priority UInt 0 Priority of actuators
rollingID UInt 0 Rolling ID of actuators
countEscalated ULInt 0 Counter how often the actuators were
escalated
countDeescalated ULInt 0 Counter how often the actuators were de-
escalated
availPower LReal 0.0 Amount of power which can be switched
by actuator
partialConsumption Bool false TRUE: If actuator can be switched partially
actuatorCounter UInt 0 Counter how many actuators are in the
same priority group and rolling ID
connectionStatus Word 16#0 Connection status of actuator

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 377
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.9 EnS_typeBaseLmgtJobRequestStack

Description of EnS_typeBaseLmgtJobRequestStack

Description
The type contains the Data for the request stack.

Structure of EnS_typeBaseLmgtJobRequestStack

Description
The following table shows the parameters of the "EnS_typeBaseLmgtJobRequestStack" PLC
data type:

Parameter Data type Default Description

jobNumber ULInt 0 Continuous job number for identification
purposes
jobType UInt 0 0: No job active; 1: Escalation; 2: De-
escalation
deltaPower LReal 0.0 Amount of power which is requested to
be switched
actuatorFeedback Array[0..9] of Feedback from actuators to the job
"EnS_typeBaseLmgtJobRequest-
Element"

SIMATIC Energy Suite V19.0

378 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.10 EnS_typeBaseLmgtJobTaskElement

Description of EnS_typeBaseLmgtJobTaskElement

Description
The type contains the task data to an actuator.

Structure of EnS_typeBaseLmgtJobTaskElement

Description
The following table shows the parameters of the "EnS_typeBaseLmgtJobTaskElement" PLC
data type:

Parameter Data type Default Description

priority UInt 0 Priority of actuators
rollingID UInt 0 Rolling ID of actuators
orderPower LReal 0.0 Amount of power which should be
switched by actuators
percentOfUsedPower LReal 0.0 % of power able to use by actuator.
partialConsumption Bool false TRUE: If actuator can be switched partially
actuatorCounter UInt 0 Counter how many actuators are in the
same priority group and rolling ID

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 379
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.11 EnS_typeBaseLmgtJobTaskStack

Description of EnS_typeBaseLmgtJobTaskStack

Description
The type contains the data for the task stack.

Structure of EnS_typeBaseLmgtJobTaskStack

Description
The following table shows the parameters of the "EnS_typeBaseLmgtJobTaskStack" PLC data
type:

Parameter Data type Default Description

jobNumber ULInt 0 Continuous job number for identification
purposes
jobType UInt 0 0: No job active; 1: Escalation; 2: De-
escalation
actuatorTask Array[0..9] of Task for the actuators
"EnX_typeBaseLmgtJobTask-
Element"

SIMATIC Energy Suite V19.0

380 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.12 EnS_typeBaseLmgtVisualization

Description of EnS_typeBaseLmgtVisualization

Description
This type contains base-load management visualization attributes.

Structure of EnS_typeBaseLmgtVisualization

Description
The following table shows the parameters of the "EnS_typeBaseLmgtVisualization" PLC data
type

Parameter Data type Default Description

powerLimitHigh LReal 0 Power limit considered for
switching decisions [kW]
powerLimitHighConfig LReal 0 Power High limit user config-
ured [kW]
powerLimitLow LReal 0 Power limit considered for
switching decisions [kW]
powerLimitLowConfig LReal 0 Power low limit user config-
ured [kW]
actPowerInfeed LReal 0 Actual power of infeed
baseLmgtSystemName String " Name of Base load manage-
ment system
unitPower UInt 1190 Default value: kW
amountActuators UInt 0 Amount of actuators config-
ured for load management
amountStorageActuators UInt 0 Amount of storage actuators
configured for load man-
agement
error Bool FALSE TRUE: Error in Base load
management system

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 381
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.13 EnS_typeBaseLmgtAvgValues

Description of EnS_typeBaseLmgtAvgValues

Description
The type contains the average power data for the base load management system

Structure of EnS_typeBaseLmgtAvgValues

Description
The following table shows the parameters of the "EnS_typeBaseLmgtAvgValues" PLC data
type.

Parameter Data type Default value Description

avgPower Real 0.0 Average power value [kW]
avgEnergy Real 0.0 Average energy value [kWh]
valid Bool false 1= Calculated values are valid

SIMATIC Energy Suite V19.0

382 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.14 EnS_typeBaseLmgtStorageElement

Description of EnS_typeBaseLmgtStorageElement

Description
The type contains the data structure of one storage actuator.

Structure of EnS_typeBaseLmgtStorageElement

Description
The following table shows the parameters of the "EnS_typeBaseLmgtStorageElement" PLC
data type

Parameter Data type Default value Description

operationMode USInt 1 1 = Automatic mode, actua-
tor works according to the
commands of the control
block
0 = Actuator ignores the
commands of the control
block
manualCommand USInt 0 0 = Idle
1 = Charge
2 = Discharge
metaData "EnS_typeLmgtStorageMeta" Metadata of the actuator
parameter "EnS_typeLmgtStorage- Parameter set
Parameter"
status "EnS_typeBaseLmgtStorage- Status and InOut values of
Status" the actuator

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 383
Energy Suite blocks - Load management
B.2 Energy Suite blocks for base load management

B.2.4.15 EnS_typeBaseLmgtStorageStatus

Description of EnS_typeBaseLmgtStorageStatus

Description
The type contains the status information and actual values of the storage actuator.

Structure of EnS_typeBaseLmgtStorageStatus

Quintessence
The following table shows the parameters of the "EnS_typeBaseLmgtStorageStatus" PLC data
type:

Parameter Data type Default Description

connectionStatus Word 16#0000 Connection status of the actuator
stateOfCharge Real 0.0 State of charge in advance mode
actPower Real 0.0 Actual power consumption of the actua-
tor
escalationPower Real 0.0 Power available for escalation
deescalationPower Real 0.0 Power available for de-escalation
countEscalated ULInt 0 Counter for switching
countDeescalated ULInt 0 Counter for switching
connectTime UDInt 0 Current connect time in [s]
disconnectTime UDInt 0 Current disconnect time in [s]
inOutVariables "EnS_typeLmgtStorage- The current status of the in/out variables
StatusInOut" for logging

SIMATIC Energy Suite V19.0

384 Function Manual, 12/2023, A5E36824823-AH
Energy Suite blocks - Energy Efficiency Monitor C
C.1 Function blocks(FBs)

C.1.1 EnS_EEm_FunctionCall

C.1.1.1 Description of EnS_EEm_FunctionCall

Description
This block calls the Energy Suite extension instructions with appropriate inputs.

C.1.1.2 Parameters of EnS_EEm_FunctionCall

The following table shows the function block "EnS_EEm_FunctionCall":

Parameter Declara- Data type Default Description

tion
number- Input UINT 0 The number of connected measurement points or measured val-
MeasPoints ues.
machineState Input USINT 0 The machine status of the machine to be monitored. Valid values
are 1-8
pieceCounter Input LREAL 0.0 The production counter of the machine to be monitored.
mea- Input LREAL 0.0 The actual value or the counter value of the measurement point.
sPointxValue The process tags that you wish to record must be filled downward
starting from 1. Thus, with four process tags, the inputs would be
"measPoint1Value" – "measPoint4Value".
eemData InOut "EnS - The instance of the UDT for communicating between the PLC and
_typeEEmData" the visualization.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 385
Energy Suite blocks - Energy Efficiency Monitor
C.2 Data blocks(DBs)

C.2 Data blocks(DBs)

C.2.1 EnS_EEmData

C.2.1.1 Description of EnS_EEmData

Description
The data required for Energy efficiency monitoring is stored here.

C.2.1.2 Parameters of EnS_EEmData

The following table shows the data block "EnS_EEmData":

Parameter Data type Description

configuration EnS_EEm_typeConfig Contains general information about the machine such
as name, type, etc.
operation EnS_EEm_typeOperation Contains online values of the machine needed for in-
ternal processing and/or evaluation.
measConfigu- Array[0..9] of Contains general information for each measurement
ration EnS_EEm_typeMeasConfig point, such as measurement data type, name, etc.
measOpera- Array[0..9] of Contains online values of each measurement point,
tion EnS_EEm_typeMeas- such as the cumulative energy meter per status, or the
Operation results of measurements.
internalData typeEEmDataInternal Contains tags for internal processing and online con-
figuration of the measurement points.
eemError Bool Error indicator of the Energy Efficiency Monitor block.
eemStatus Word Status of the Energy Efficiency Monitor block. The error
codes can be found in the Online Help of the block.
eemReport- Bool Trigger to create a new Energy Efficiency Monitor re-
Request port.
eemReportEr- Bool Error indicator of the Energy Efficiency Monitor report
ror block.
eemRe- Word Status of the Energy Efficiency Monitor report block.
portStatus The error codes can be found in the Online Help of the
block.
eemReport- String[35] The name of the last Energy Efficiency Monitor report.
Name

SIMATIC Energy Suite V19.0

386 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3 User-defined data types(UDTs)

C.3.1 EnS_typeEEmData

C.3.1.1 Description of EnS_typeEEmData

Description
The UDT contains the Energy efficiency montoring system data.

C.3.1.2 Parameters of EnS_typeEEmData

The following table shows the data block "EnS_typeEEmData":

Parameter Data type Description

configuration EnS_EEm_typeConfig System UDT of the Energy Efficiency Monitor. Contains general
information about the machine such as name, type, etc.
operation EnS_EEm_typeOperation System UDT of the Energy Efficiency Monitor. Contains online val-
ues of the machine needed for internal processing and/or evalua-
tion.
measConfigura- Array[0..9] of System UDT of the Energy Efficiency Monitor. Contains general
tion EnS_EEm_typeMeasConfig information for each measurement point, such as measurement
data type, name, etc.
measOperation Array[0..9] of System UDT of the Energy Efficiency Monitor. Contains online val-
EnS_EEm_typeMeasOperation ues of each measurement point, such as the cumulative energy
meter per status, or the results of measurements.
internalData typeEEmDataInternal Contains tags for internal processing and online configuration of
the measurement points.
eemError Bool Error indicator of the Energy Efficiency Monitor block.
eemStatus Word Status of the Energy Efficiency Monitor block. The error codes can
be found in the Online Help of the block.
eemReport- Bool Trigger to create a new Energy Efficiency Monitor report.
Request
eemReportError Bool Error indicator of the Energy Efficiency Monitor report block.
eemReportStatus Word Status of the Energy Efficiency Monitor report block. The error
codes can be found in the Online Help of the block.
eemReportName String[35] The name of the last Energy Efficiency Monitor report.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 387
Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3.2 EnS_typeEEmDataInternal

C.3.2.1 Description of EnS_typeEEmDataInternal

Description
The UDT contains internal data for block functions.

C.3.2.2 Parameters of EnS_typeEEmDataInternal

The following table shows the data block "EnS_typeEEmDataInternal":

Parame- Data type Description

ter
produc- Array[0..8] of Bool Contains indicators of which status (1-8) should be
tiveEner- counted as a productive status.
gyStates TRUE = Status should be evaluated as productive
FALSE = Status should not be evaluated as non-
productive
enpiGoals Array[0..9] of Real The reference values of the EnPI for all ten measure-
ment points. The reference value can be configured in
the visualization.
enpiRe- Bool TRUE = The EnPI values (the stored piece counter) for
setTrigger calculating the EnPI will be reset.
enpiRe- DTL Time point of most recent reset of the EnPI values.
setTime
Meas- typeEEmMeas PointConfigura- Tags needed for configuration during runtime.
PointCon- tion
figuration
enmPro- Bool TRUE = Communication to Energy Manager PRO is
Enabled enabled. The network configuration is contained in the
structure "enmProData".
enmPro- typeEEMHmiEnMPro Communi- The network configuration for communication with
Data cation Energy Manager PRO.

SIMATIC Energy Suite V19.0

388 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3.3 EnS_typeEEHmiEnMProCommunication

C.3.3.1 Description of EnS_typeEEHmiEnMProCommunication

Description
The UDT contains communication information for EnMPro communication

C.3.3.2 Parameters of EnS_typeEEHmiEnMProCommunication

The following table shows the data block "EnS_typeEEHmiEnMProCommunication":

Parameter Data type Description

State Word
Error Bool
Save Bool
Abort Bool
IPAdress Array[1..4] of USInt
LocalPort UInt
RemotePort UInt
InterfaceID UInt
Connection Word
ID

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 389
Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3.4 EnS_typeEEmMeasPointConfiguration

C.3.4.1 Description of EnS_typeEEmMeasPointConfiguration

Description
The UDT is used for measurement point configuration.

C.3.4.2 Parameters of EnS_typeEEmMeasPointConfiguration

The following table shows the data block "EnS_typeEEmMeasPointConfiguration":

Parameter Data type Description

measPointName String[30]
measPointMedia String[30]
measPointUnitCounter String[6]
measPointType Int
measPointType1Overflow LReal
measPointType1NormFactor LReal
measPointType2RawLow Real
measPointType2RawHigh Real
measPointType2OutLow Real
measPointType2OutHigh Real
measPointDataSave Bool
measPointDataRead Bool
measPointInitializationCancel Bool
measPointDataWritten UInt
measPointDataIndex UInt
numberMeasPoints UInt
measPointInitialized Bool

SIMATIC Energy Suite V19.0

390 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3.5 EnS_EEm_typeComDiagnostics

C.3.5.1 Description of EnS_EEm_typeComDiagnostics

Description
The UDT contains diagnostic data for EnMPro communication.

C.3.5.2 Parameters of EnS_EEm_typeComDiagnostics

The following table shows the data block "EnS_EEm_typeComDiagnostics":

Parameter Data type Description

configError Int
logonLength Int
energyDataLength Int
processStep Byte
countErrorTimesync USInt
lastErrorConnect Word
lastErrorDisconnect Word
lastErrorSend Word
countSendNOK UInt
LastErrorRecieve Word
countRecieveError UInt
countRecieveNOK UInt
lastErrorLogonNAK Int
lastErrorDataNAK Int
countConnectOK UInt
countTimesyncOK UInt
countSendEDataOK UDInt

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 391
Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3.6 EnS_EEm_typeCommunication

C.3.6.1 Description of EnS_EEm_typeCommunication

Description
The UDT contains communication data for EnMPro communication.

C.3.6.2 Parameters of EnS_EEm_typeCommunication

The following table shows the data block "EnS_EEm_typeCommunication":

Parameter Data type Description

serverIP Array[1..4] of Byte
localPort UInt
remotePort UInt
interfaceID UInt
connectionID Word
eDataSendCycle DInt
eDataSendTomeout DInt
reconnectPauseFast DInt
reconnectPauseSlow DInt

SIMATIC Energy Suite V19.0

392 Function Manual, 12/2023, A5E36824823-AH
 Energy Suite blocks - Energy Efficiency Monitor
C.3 User-defined data types(UDTs)

C.3.7 EnS_EEm_typeEnMProComm

C.3.7.1 Description of EnS_EEm_typeEnMProComm

Description
The UDT contains overall communication data for EnMPro communication.

C.3.7.2 Parameters of EnS_EEm_typeEnMProComm

The following table shows the data block "EnS_EEm_typeEnMProComm":

Parameter Data type Description

comStateEnable Word
comAdditional Byte
enableCommunication Bool
timeSyncCpuMinute Bool
timeSyncCpuHour Bool
timeSyncUseLocal Bool
plausiLimits Array[0..9] of Real
qualityBytes Array[0..9] of Byte
pieceCounterName String[18]
communication "EnS_EEm_typeCommunication"
comDiagnostics "EnS_EEm_typeDiagnostics"

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 393
Service & Support D
D.1 Service & Support

The unmatched complete service for the entire life cycle

For machine constructors, solution providers and plant operators: The service offering from
Siemens Industry Automation and Drive Technologies includes comprehensive services for a
wide range of different users in all sectors of the manufacturing and process industry.
To accompany our products and systems, we offer integrated and structured services that
provide valuable support in every phase of the life cycle of your machine or plant – from
planning and implementation through commissioning as far as maintenance and
modernization.
Our Service & Support accompanies you worldwide in all matters concerning automation and
drive technology from Siemens. We provide direct on-site support in more than 100 countries
through all phases of the life cycle of your machines and plants.
You have an experienced team of specialists at your side to provide active support and
bundled know-how. Regular training courses and intensive contact among our employees –
even across continents – ensure reliable service in the most diverse areas

SIMATIC Energy Suite V19.0

394 Function Manual, 12/2023, A5E36824823-AH
 Service & Support
D.1 Service & Support

Online Support
The comprehensive online information platform supports you in all aspects of our Service &
Support at any time and from any location in the world.
You can find Online Support on the Internet at the following address: Internet
(http://www.siemens.com/automation/service&support).

Technical Consulting
Support in planning and designing your project: From detailed actual-state analysis,
definition of the goal and consultation on product and system questions right through to the
creation of the automation solution.

Technical Support
Expert advice on technical questions with a wide range of demand-optimized services for all
our products and systems.
You can find Technical Support on the Internet at the following address: Internet
(http://www.siemens.com/SupportRequest).

Training
Extend your competitive edge – through practical know-how directly from the manufacturer.
You can find the training courses we offer on the Internet at the following address: Internet
(http://www.siemens.com/sitrain).

Engineering Support
Support during project engineering and development with services fine-tuned to your
requirements, from configuration through to implementation of an automation project.

Field Service
Our Field Service offers you services for commissioning and maintenance – to ensure that
your machines and plants are always available.

Spare parts
In every sector worldwide, plants and systems are required to operate with constantly
increasing reliability. We will provide you with the support you need to prevent a standstill
from occurring in the first place: with a worldwide network and optimum logistics chains.

Repairs
Downtimes cause problems in the plant as well as unnecessary costs. We can help you to
reduce both to a minimum – with our worldwide repair facilities.

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 395
Service & Support
D.1 Service & Support

Optimization
During the service life of machines and plants, there is often a great potential for increasing
productivity or reducing costs.
To help you achieve this potential, we are offering a complete range of optimization services.

Modernization
You can also rely on our support when it comes to modernization – with comprehensive
services from the planning phase all the way to commissioning.

Service programs
Our service programs are selected service packages for an automation and drives system or
product group. The individual services are coordinated with each other to ensure smooth
coverage of the entire life cycle and support optimum use of your products and systems.
The services of a Service Program can be flexibly adapted at any time and used separately.
Examples of service programs:
• Service contracts
• Plant IT Security Services
• Life Cycle Services for Drive Engineering
• SIMATIC PCS 7 Life Cycle Services
• SINUMERIK Manufacturing Excellence
• SIMATIC Remote Support Services

Advantages at a glance:
• Reduced downtimes for increased productivity
• Optimized maintenance costs due to a tailored scope of services
• Costs that can be calculated and therefore planned
• Service reliability due to guaranteed response times and spare part delivery times
• Customer service personnel will be supported and relieved of additional tasks
• Comprehensive service from a single source, fewer interfaces and greater expertise

Contact
At your service locally, around the globe: your partner for consultation, sales, training,
service, support, spare parts... for the entire range of products supplied by Industry
Automation and Drive Technologies.
You can find your personal contact in our contacts database at: Internet
(http://www.siemens.com/automation/partner).

SIMATIC Energy Suite V19.0

396 Function Manual, 12/2023, A5E36824823-AH
Index

A F
Actuator types, 297, 352 Feedback, 300, 355
available energy, 291 File generation, 318, 366
Forecast algorithms
EnS_LmgtForecast_x, 288
C Forecast extension
LinExt, 288
Characteristics, 318, 366
function block
Connect and disconnect times, 302, 357
EnS_BaseLmgtActuator_x, 352
connect times, 302, 357
EnS_BaseLmgtBackupRestore, 365
EnS_LmgtActuator_x, 297
EnS_LmgtBackupRestore, 316
D EnS_LmgtControl_Peak, 290
Dead time for de-escalation, 304, 359 EnS_LmgtForecast_x, 288
Dead time for escalation, 303, 358
De-escalation, 301, 356
differential power, 291 J
disconnect times, 302, 357
Job management, 305, 360
dynamicParameters
parameterMode, 290
parameterSet, 297, 352
L
Lack of Actuators, 317, 365
E Limit monitoring, 291
Limit tolerance, 292
EnS_BaseLmgtActuator_x
Limit violation, 294
function block, 352
Logging, 316
EnS_BaseLmgtBackupRestore
Linear extrapolation
function block, 365
EnS_LmgtForecast_x, 288
EnS_LmgtActuator_x
Logging, 316
function block, 297
Limit violation, 316
EnS_LmgtBackupRestore
function block, 316
EnS_LmgtControl_Peak
M
function block, 290
EnS_LmgtForecast_x Messages, 296, 309, 364
Forecast algorithms, 288
function block, 288
Linear extrapolation, 288 P
Startup, 288
parameterMode
Escalation, 293, 301, 356
dynamicParameters, 290
permanentParameters, 290
Parameters of
EnS_BaseLmgt_Control, 350
EnS_BaseLmgtBackupRestore, 368
EnS_LmgtActuator_Peak, 306, 361

SIMATIC Energy Suite V19.0

Function Manual, 12/2023, A5E36824823-AH 397
Index

EnS_LmgtBackupRestore, 320 S
EnS_LmgtControl_Peak, 295
Stabilization time, 294
EnS_LmgtForecast_x, 289
Startup, 294, 305, 360
EnS_typeActuatorElement, 324, 372
EnS_LmgtForecast_x, 288
EnS_typeBaseLmgtActuatorStatus, 373, 384
Structure of
EnS_typeBaseLmgtControlLimitConfig, 374
EnS_ActuatorList, 323
EnS_typeBaseLmgtControlParameters, 375
EnS_LmgtGeneralData, 322
EnS_typeBaseLmgtControlTimeConfig, 376
Suppression delay duration, 292
EnS_typeBaseLmgtGeneralData, 376
Switching action, 316, 365
EnS_typeBaseLmgtJobRequestElement, 377
Switching sequence example, 299, 354
EnS_typeBaseLmgtJobRequestStack, 378
EnS_typeBaseLmgtJobTaskElement, 379
EnS_typeBaseLmgtJobTaskStack, 380
EnS_typeLmgtActuatorInOut, 328, 344
EnS_typeLmgtActuatorMeta, 325
EnS_typeLmgtActuatorParameter, 325
EnS_typeLmgtActuatorParameterSet, 326
EnS_typeLmgtActuatorStatus, 327
EnS_typeLmgtAlarmElement, 329
EnS_typeLmgtControlLimitConfig, 329
EnS_typeLmgtControlParameters, 330, 331, 375
EnS_typeLmgtControlTimeConfig, 331
EnS_typeLmgtEnergyDiagram, 332
EnS_typeLmgtForecastValues, 332
EnS_typeLmgtGeneralData, 333
EnS_typeLmgtJobRequestElement, 334
EnS_typeLmgtJobRequestStack, 335
EnS_typeLmgtJobTaskElement, 335
EnS_typeLmgtJobTaskStack, 336
EnS_typeLmgtOrganisation, 336
EnS_typeLmgtTriggerBR, 337
EnS_typeLmgtVisualization, 338
parameterSet
dynamicParameters, 297, 352
permanentParameters, 297, 352
permanentParameters
parameterMode, 290
parameterSet, 297, 352
Power / energy values, 300, 355
power and energy values, 300, 355
Priority, 298, 353
Priority groups, 298, 353
Priority list, 297, 352
Procedure, 298, 353

R
Reaction to error, 288, 294, 306, 320, 361, 368
Rolling sequence, 298, 353

SIMATIC Energy Suite V19.0

398 Function Manual, 12/2023, A5E36824823-AH