Block for Connecting

Modbus TCP Devices

to Energy Suite V14
SP1

STEP 7 Professional V14 SP1, Energy Suite V14 SP1,

Siemens
SENTRON PAC Measuring Devices, Modbus TCP Industry
Online
https://support.industry.siemens.com/cs/ww/en/view/109749074 Support
 Warranty and Liability

Warranty and Liability

Note The Application Examples are not binding and do not claim to be complete regarding the
circuits shown, equipping and any eventuality. The Application Examples do not represent
customer-specific solutions. They are only intended to provide support for typical
applications. You are responsible for ensuring that the described products are correctly
used. This Application Example does not relieve you of the responsibility of safely and
professionally using, installing, operating and servicing equipment. When using this
Application Example, you recognize that we cannot be made liable for any damage/claims
beyond the liability clause described. We reserve the right to make changes to this
Application Example at any time without prior notice. If there are any deviations between
the recommendations provided in this Application Example and other Siemens
publications – e.g. Catalogs – the contents of the other documents have priority.
We do not accept any liability for the information contained in this document.
Any claims against us – based on whatever legal reason – resulting from the use of
the examples, information, programs, engineering and performance data etc.,
described in this Application Example shall be excluded. Such an exclusion shall
not apply in the case of mandatory liability, e.g. under the German Product Liability
Act ("Produkthaftungsgesetz"), in case of intent, gross negligence, or injury of life,
body or health, guarantee for the quality of a product, fraudulent concealment of a
deficiency or breach of a condition which goes to the root of the contract
("wesentliche Vertragspflichten"). However, claims arising from a breach of a
condition which goes to the root of the contract shall be limited to the foreseeable
damage which is intrinsic to the contract, unless caused by intent or gross
 Siemens AG 2017 All rights reserved

negligence or based on mandatory liability for injury of life, body or health. The
above provisions do not imply a change of the burden of proof to your detriment.
It is not permissible to transfer or copy these Application Examples or excerpts of
them without first having prior authorization from Siemens AG in writing.

Security Siemens provides products and solutions with industrial security functions that support the
informa- secure operation of plants, systems, machines and networks.
tion 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 security
concept. Products and solutions from Siemens are only one part of such a concept.
The customer is responsible for preventing unauthorized access to the customer’s plants,
systems, machines and networks. Systems, machines and components should be
connected to the company network or the Internet only if and to the extent necessary and
if appropriate protective action (e.g., use of firewalls and network segmentation) was
taken.
In addition, Siemens’ recommendations regarding appropriate protective action should be
followed. For more information about industrial security, visit
http://www.siemens.com/industrialsecurity.
Siemens’ products and solutions undergo continuous development to make them even
more secure. Siemens strongly recommends to perform updates as they become
available and use only the latest product versions. Using versions that are out of date or
no longer supported can increase the risk of cyber threats.
To stay informed about product updates as they occur, subscribe to the Siemens
Industrial Security RSS feed at http://www.siemens.com/industrialsecurity.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 2
 Table of Contents

Table of Contents
Warranty and Liability ................................................................................................. 2
1 Overview ............................................................................................................. 4
1.1 Introduction ........................................................................................... 4
1.2 Validity .................................................................................................. 4
1.3 Mode of operation ................................................................................ 5
1.4 Components of the application example .............................................. 5
1.5 Components used ................................................................................ 5
2 Engineering ........................................................................................................ 6
2.1 Interface description ............................................................................. 6
2.2 Integration into the user project ............................................................ 8
2.2.1 Checking the online values ................................................................ 12
2.3 Error handling ..................................................................................... 13
2.4 Custom register map .......................................................................... 14
2.5 Visualizing the energy data ................................................................ 15
2.5.1 Preparations ....................................................................................... 15
2.5.2 Short instructions ................................................................................ 16
3 Appendix .......................................................................................................... 18
3.1 Service and Support ........................................................................... 18
3.2 Links and literature ............................................................................. 19
3.3 Change documentation ...................................................................... 19
 Siemens AG 2017 All rights reserved

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 3
 1 Overview

1 Overview
1.1 Introduction
SIMATIC Energy Suite provides the option to read energy data relevant to
accounting, such as power and voltage values. However, the program blocks for
advanced energy data added by TIA Portal V14 SP1 can only be generated using
devices that are supported by the Energy Support Library (EnSL).
The block library described in this application example contains a block that allows
you to integrate Modbus TCP devices into Energy Suite that are not supported by
default by the EnSL. A preconfigured data block allows you to integrate SENTRON
7KM measuring devices into your energy data program without additional
configuration overhead.

Figure 1-1

100111101011100010101011000
EnS_Modbus100111101011100010101011000
100111101011100010101011000
_energyAdv100111101011100010101011000
 Siemens AG 2017 All rights reserved

1.2 Validity 1 0
This block library has been tested for the0following
0 products:
Table 1-1
0 1
1 0
Software Hardware
1 1
TIA Portal V14 or higher
1 0SIMATIC S7-1500
Energy Suite V14 SP1 Upd 2 or higher 1 1Modbus TCP device:
SENTRON PAC 5200
0 0
SENTRON PAC 3200
1 1
0 1
Note Modbus RTU devices are not supported by the block.
1 0
1 0
1 0
0

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 4
 1 Overview

1.3 Mode of operation

The "Modbus_TCP_energyAdv" block reads the energy data of a Modbus TCP
device (e.g., SENTRON PAC 3200) via the Modbus interface.
As the register map in the memory of the measured values of the different
Modbus TCP devices differs, you have to set fixed register addressing of the
measured values for each device type. This register map allows the block to read
the energy data via the Modbus TCP interface.
The energy data of the Modbus TCP device is then stored in the Energy Suite data
structure to make it available in Energy Suite.
The "Modbus_TCP_energyAdv" block is written in SCL.

1.4 Components of the application example

This application example consists of the following components:
Table 1-2
Component File name Note
Documentation 109749074_ModbusTCP_energyAdv_DOC_en.pdf This document
Library 109749074_LModbusTCP_energyAdv.zip For integration
into your project
 Siemens AG 2017 All rights reserved

1.5 Components used

This application example was created with the following hardware and software
components:
Table 1-3
Component No. Article no. Note
STEP 7 Professional 1 6ES7822-1AA04-0YC5 --
V14 SP1 (TIA Portal)
Energy Suite V14 SP1 1 6AV2108-0AA04-0AA5 Visualization with the
Upd 2 "EnS Visu" library
requires Update 2
WinCC Runtime 1 6AV2105-....4-0 --
Professional V14 SP1
SENTRON PAC 3200 1 7KM2111-1BA00-3AA0 You can also use
different Modbus TCP
devices.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 5
 2 Engineering

2 Engineering
2.1 Interface description
The following sections explain the Modbus_TCP_energyAdv function block that
performs the functionality described in this document.

Figure 2-1
Modbus_TCP_energyAdv

Bool REQ DONE Bool

"typeMBTCP_energyAdv_ComInt
COM_INT BUSY Bool
"
"typeMBTCP_EnergyAdv_Device DEVICE_TYP
ERROR Bool
Type" E
"typeMBTCP_EnergyAdv_Device DEVICE_AD
STATUS DWord
Adress" RESS
advData "EnS_typeEnergyAdv"

Table 2-1: Parameters of Modbus_TCP_energyAdv

Name P type Data type Comment
REQ IN Bool Request input: 0 = block
 Siemens AG 2017 All rights reserved

inactive; 1 = block active

COM_INT IN "typeMBTCP_energyAdv_ UDT that contains the data
ComInt" for the communication
interface
DEVICE_TYPE IN "typeMBTCP_EnergyAdv_ UDT that contains the
DeviceType" register addresses of the
measuring device
DEVICE_ADRES IN "typeMBTCP_EnergyAdv_ UDT that contains the
S DeviceAdress" connection data of the
measuring device
DONE OUT Bool This bit is set to 1 when a
data record has been
successfully read
BUSY OUT Bool 0: No request being
processed
1: Request being processed
ERROR OUT Bool 0: No error
1: Error occurred
The STATUS parameter
indicates the error cause
STATUS OUT DWord Detailed status information of
the statement. For details,
see Chapter 2.3
advData OUT "EnS_typeEnergyAdv" Data structure of the Energy
Suite's advanced energy
data
For more information, refer
to the manual.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 6
 2 Engineering

The structure of the "Modbus_TCP_energyAdv" function block follows the

TIA Portal standard. The REQ input indicates whether the block's functionality is
enabled or disabled.

Description of the data types

typeMBTCP_energyAdv_ComInt
The "*_ComInt" data type contains the data for the communication interface. The
following table lists all variables included in this data type.
Table 2-2
Name Data type Explanation
Hardware_ID HW_IO Hardware identifier of the
local interface (PLC)
Local_Port UInt Port number of the local
connection parameter

typeMBTCP_energyAdv_DeviceAdress
The "*_DeviceAdress" data type contains information about the connection settings
for Modbus TCP communication. The following table lists all variables included in
this data type.
Table 2-3
Name Data type Explanation
 Siemens AG 2017 All rights reserved

IP_Adress IP_V4 IP address of the measuring

device
Port UInt TCP port number of the
measuring device
Unit_ID Byte Modbus slave address.
Note:
Use only when the Modbus
device is a gateway to an
RTU measuring device.
Connection_ID CONN_OUC Unique connection number

typeMBTCP_energyAdv_DeviceType
The "*_DeviceType" data type contains the information for the measuring device's
register map. It consists of an array of another UDT
("typeMBTCP_EnergyAdv_DeviceType_Value"), where each array element
contains the configuration data for one measured value.
The following table lists all parameters included in the "*_DeviceType_Value" data
type.
Table 2-4: Parameters of an "advData[0]" array element
Name Data Values
type
Index Int 3 (unchanged)
Name String 'voltage3N' (unchanged)
Type String 'DInt', 'Real' or 'LReal'
Adress DInt 22

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 7
 2 Engineering

2.2 Integration into the user project

Requirement
Make sure that the device you want to integrate communicates via Modbus TCP
and is in the same network as the controller used.
If you want to integrate other Modbus TCP devices into Energy Suite that are not
part of the SENTRON PAC family, first create a data block with the Modbus
register map of the device. Chapter 2.4 describes how to do this.
The following instructions describe how to integrate a SENTRON PAC 3200 into
your Energy Suite program. Other devices can be connected in the same way, only
the Modbus register mapping of the measured values differs depending on the
device type.

Instructions
1. Open your TIA Portal project.
2. Unzip the "109749074_LModbusTCP_energyAdv.zip" file and open the library
in TIA Portal.
Figure 2-2 Open library view
 Siemens AG 2017 All rights reserved

3. Drag the "Modbus_TCP_energyAdv" function block to your PLC program. You

will find the function block in "Types" of the supplied library.
4. Open the library's "Master copies" and drag the
"DeviceType_PAC_22_32_32T_42" data block to your PLC program.
This data block contains the register map and is pre-configured for the
following devices:
 SENTRON PAC2200, PAC3200 (T) and PAC4200

You need this data block only once per device type. This means the
"DeviceType_PAC_22_32_32T_42" data block allows you to connect any
number of SENTRON devices (4200/3200(T)/2200).

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 8
 2 Engineering

Note For the SENTRON PAC 5100 and 5200 devices, use the
"DeviceType_PAC_51_52" master copy. For other Modbus TCP devices,
manually customize the register map. Chapter 2.4 shows you how to create a
custom register map.

5. Compile the user program.

6. Create a new communication data block for your Modbus TCP device. (In this
application example: "Dev1_PAC3200")
7. Create a new variable of the "typeMBTCP_energyAdv_ComInt" and
"typeMBTCP_energyAdv_DeviceAdress" data type.
Figure 2-3

8. Expand the data block and make changes in the following places highlighted in
red.

Figure 2-4 Configuring the data block

 Siemens AG 2017 All rights reserved

1 Enter the hardware ID of your controller.

Figure 2-5 Hardware identifier

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 9
 2 Engineering

2 In the "ADDR[]" array, enter the IP address of your Modbus TCP device.
Enter the IP address byte by byte in the individual array elements.

3 In "Connection_ID", specify a unique connection number. If you call the

block multiple times, make sure to choose different numbers.

9. Call the "Modbus_TCP_energyAdv" function block in your user program.

10. Assign a name to the instance DB, for example "EnO_Dev1_PAC3200_Adv",
and interconnect the block with the variables of the data block you have
previously created.

Figure 2-6 Inputs of the block

Figure 2-7 Calling and interconnecting the Modbus block

 Siemens AG 2017 All rights reserved

Note For each Modbus TCP device you want to integrate, you must call the block
once. To do this, repeat steps 4 through 7.

11. Download the user program to your controller.

Note If you make changes to the configuration data blocks, make sure to download
the user program in its entirety.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 10
 2 Engineering

Creating an energy object

1. Create a new energy object ("EnO_Dev1_PAC3200") in the controller. In
"Energy data source", specify the data block of the called function block. Select
the advData subfolder and the "totalActPower" tag for a power value or
"totalActEnergy" for an energy value.
Figure 2-8
 Siemens AG 2017 All rights reserved

2. Select the appropriate energy data type and an archiving period.

Figure 2-9 Energy objects

3. Generate the energy data program with the advanced energy data. Now you
can access the energy data of the Modbus TCP device using Energy Suite.
Figure 2-10 Generating energy data

4. Download the user program to your controller.

Note For information about using SIMATIC Energy Suite, refer to the following
application example or the Energy Suite manual.
Application example: "SIMATIC Energy Suite – Getting Started"
https://support.industry.siemens.com/cs/ww/en/view/109739102
Manual: "SIMATIC Energy Suite V14 SP1"
https://support.industry.siemens.com/cs/ww/en/view/109741977

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 11
 2 Engineering

2.2.1 Checking the online values

Now you can check whether you have successfully integrated the measuring
device:
1. In TIA Portal, open the data block you specified when calling the Modbus
block; in this application example: "EnO_Dev1_PAC3200_Adv".
Figure 2-11 Call of the Modbus block

2. Connect online to the controller.

Figure 2-12
 Siemens AG 2017 All rights reserved

3. Monitor the "EnO_Dev1_PAC3200_Adv" block.

4. "Output > advData" displays the energy data of the measuring device (2).
Figure 2-13 Online data

If no data is displayed, the "STATUS" (1) error code can help diagnose the error.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 12
 2 Engineering

2.3 Error handling

The block provides error and status information via the "STATUS" output
parameter.
The "STATUS" output parameter is written as a double word: 16#7000_xxxx.
The first word of the "Status" parameter describes the error of the
"Modbus_TCP_energyAdv" block. The second word (marked with "xxxx" above)
represents the status of the MB_CLIENT instance.
The following error codes are programmed for the block:
Table 2-5 Error codes of the Modbus block
Error code Explanation
16#7000_xxxx No job active
16#7001_xxxx Job active
16#8000_xxxx Error in the lower-level MB_CLIENT instance
16#8401_xxxx Invalid HW ID (range of values: 0 to 65535)
16#8402_xxxx Invalid local port (port numbers: 1 to 49151)
16#8403_xxxx Illegal IP (range of values: 0 to 255)
16#8404_xxxx Illegal port (range of values: 1 to 49151)
16#8405_xxxx Illegal unit ID (range of values: 1 to 49151)
16#8406_xxxx Illegal connection ID (range of values: 1 to 49151)
 Siemens AG 2017 All rights reserved

16#8410_xxxx Illegal index variable in DEVICE_TYPE (do not change default

assignment)
16#8411_xxxx Illegal name variable in DEVICE_TYPE (do not change default
assignment)
16#8412_xxxx Illegal type variable in DEVICE_TYPE
(allowed: 'DINT', 'REAL', 'LREAL')

Note For the error codes of the MB_CLIENT instance, refer to the "WinCC Advanced
V14 SP1" manual or the TIA Portal Online Help.
The following link takes you directly to the right place in the manual:
MB_CLIENT STATUS Parameter Description

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 13
 2 Engineering

2.4 Custom register map

If you want to integrate other Modbus TCP devices into Energy Suite that are not
part of the SENTRON PAC family, proceed as follows:

Preparations
In the device manufacturer's manual, look for the Modbus register map for the
energy data.

Customizing the addresses

1. Drag the "DeviceType_Modbus_general" data block to your PLC program.
Expand the "*_DeviceType" data structure.
Each of the 29 arrays represents one measured value (e.g., voltage1N).
2. For the total of 29 measured values, change the register address of the
measured value "Adress" and the data type "Type".
For the register map of your Modbus TCP device, refer to the device manual.

Figure 2-14
 Siemens AG 2017 All rights reserved

Figure 2-15

Note You have to enter the data type as a string with '…', e.g.: 'DInt' or 'Real'. Be sure
to use the correct notation. The other parameters need not be changed.

To integrate the Modbus TCP device into the Energy Suite program, continue with
Step 5 in Chapter 2.2.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 14
 2 Engineering

2.5 Visualizing the energy data

The "EnS Visu V14 SP1" TIA Portal library from Online Support allows you to
easily visualize the energy data of the Modbus TCP device on your operator panel.
Figure 2-16 EnS_Visu: faceplate

Figure 2-17 EnS_Visu: advanced energy data

 Siemens AG 2017 All rights reserved

2.5.1 Preparations

Check the name of the instance DB of the Modbus block and the energy object. If
you are using the "EnS Visu" library for visualization, change the names as follows:
Energy object: EnO_Name
Instance DB: EnO_Name + "_Adv"
In the application example:
Energy object: "EnO_Dev1_PAC3200"
Instance DB: "EnO_Dev1_PAC3200_Adv"

Figure 2-18 Name of energy object and instance DB

Note Make sure that SIMATIC Energy Suite V14 SP1 Update 2 or higher is installed
on your system.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 15
 2 Engineering

2.5.2 Short instructions

Note For detailed instructions for using the "EnS_Visu" library, refer to the following
application example:
"SIMATIC Energy Suite – Visualization Examples"
https://support.industry.siemens.com/cs/ww/en/view/109739775

1. Download the "EnS_Visu" library from the following entry page:

https://support.industry.siemens.com/cs/ww/en/view/109739775
2. Open the master copies of the library.
Figure 2-19 "EnS_Visu" library
 Siemens AG 2017 All rights reserved

3. Depending on the operator panel you are using, copy all objects from the
"VisuComfort/RTAdvanced" or "VisuRuntimeProf" folder to your project.

WinCC Runtime Advanced/Comfort

4. Open "Properties > Interface" of the faceplate object and interconnect the
faceplate with the following elements:
energyAdv -> with "advData" of the instance DB of the Modbus block
("EnO_Dev1_PAC3200_Adv")
energyBasic -> with "energyBasic" of the energy object
energyMeta -> with "energyMeta" of the energy object
Figure 2-20 Interconnecting the faceplate

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 16
 2 Engineering

5. Customize the object references of the two pop-up screens.

– Use the <CTRL + A> key combination to select all objects of the
"energyBasic_PopUp" pop-up screen.
– Right-click an object and select "Change object references" from the
context menu.
– In the "Find in reference" field, enter "EnO_Name".
– Replace all search results with the energy object name; e.g., in this
example: "EnO_Dev1_PAC3200".
– Click the "Replace All" button.
Perform the same steps for the second pop-up screen.
6. Rebuild the operator panel (["rebuild all"]).
7. Load the operator panel/Runtime.

Note If you want to visualize more than one energy object, you have to insert the
faceplate and the pop-up screens multiple times. Before you insert the pop-up
screens once again, change the names of the existing pop-up screens in the
project.
Chapter 3.2.1, Step 5 and the following steps of the following application
example describe the detailed procedure:
"SIMATIC Energy Suite – Visualization Examples"
(https://support.industry.siemens.com/cs/ww/en/view/109739775).
 Siemens AG 2017 All rights reserved

WinCC Runtime Professional

4. Open "Properties > Interface" of the faceplate object and interconnect the
faceplate with the following elements:
energyAdv -> with "advData" of the instance DB of the Modbus block
("EnO_Dev1_PAC3200_Adv")
energyBasic -> with "energyBasic" of the energy object
energyMeta -> with "energyMeta" of the energy object
EnO_name -> with the "name" tag from "energyMeta" of the energy object
Figure 2-21

5. Rebuild Runtime ("rebuild all").

6. Load Runtime.

Note If you want to visualize more than one energy object, drag another faceplate to
your screen and interconnect it. You do not need a second screen window and
you do not have to drag any other screens to your project.

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 17
 3 Appendix

3 Appendix
3.1 Service and Support
Industry Online Support
Do you have any questions or do you need support?
With Industry Online Support, our complete service and support know-how and
services are available to you 24/7.
Industry Online Support is the place to go to for information about our products,
solutions and services.
Product Information, Manuals, Downloads, FAQs and Application Examples – all
the information can be accessed with just a few clicks:
https://support.industry.siemens.com

Technical Support
Siemens Industry’s Technical Support offers you fast and competent support for
any technical queries you may have, including numerous tailor-made offerings
ranging from basic support to custom support contracts.
You can use the web form below to send queries to Technical Support:
www.siemens.com/industry/supportrequest.
 Siemens AG 2017 All rights reserved

Service offer
Our service offer includes the following services:
 Product Training
 Plant Data Services
 Spare Part Services
 Repair Services
 Field & Maintenance Services
 Retrofit & Modernization Services
 Service Programs & Agreements
For detailed information about our service offer, please refer to the Service
Catalog:
https://support.industry.siemens.com/cs/sc

Industry Online Support app

The "Siemens Industry Online Support" app provides you with optimum support
while on the go. The app is available for Apple iOS, Android and Windows Phone:
https://support.industry.siemens.com/cs/ww/en/sc/2067

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 18
 3 Appendix

3.2 Links and literature

Table 3-1
No. Topic
\1\ Siemens Industry Online Support
https://support.industry.siemens.com
\2\ Link to the entry page of the application example
https://support.industry.siemens.com/cs/ww/en/view/109749074
\3\ Application example: SIMATIC Energy Suite – Visualization Examples
https://support.industry.siemens.com/cs/ww/en/view/109739775
\4\ Application example: "SIMATIC Energy Suite – Getting Started"
https://support.industry.siemens.com/cs/ww/en/view/109739102

3.3 Change documentation

Table 3-2
Version Date Modifications
V1.0 09/2017 First version
 Siemens AG 2017 All rights reserved

Modbus TCP Block

Entry ID: 109749074, V1.0, 09/2017 19